Class Hierarchy   Class Index   Method Index  

IGClogQuery Class Reference

#include <IGClogQuery.h>

Detailed Description

This class is used to represent an Iguana log query.


Public Member Functions

 IGClogQuery ()
 Constructor.
virtual ~IGClogQuery ()
 Destructor.
IGClogQuery & operator= (const IGClogQuery &Orig)
 Assignment operator.
IGClogQueryHandle GetHandle () const
 This method is part of the internal implementation of this class and should not be called.
const char * Host () const
 Specifies the hostname or IP address of the Iguana server.
void SetHost (const char *Value)
 Set method for Host.
IGCint32 Port () const
 Specifies the port number which is used to access the Iguana server's HTTP/HTTPS interface.
void SetPort (IGCint32 Value)
 Set method for Port.
const char * Username () const
 Specifies the username which should be used to authenticate with the Iguana server.
void SetUsername (const char *Value)
 Set method for Username.
const char * Password () const
 Specifies the password which should be used to authenticate with the Iguana server.
void SetPassword (const char *Value)
 Set method for Password.
IGCboolean Encrypt () const
 Specifies that Iguana server is configured to use HTTPS mode.
void SetEncrypt (IGCboolean Value)
 Set method for Encrypt.
const char * Filter () const
 Restricts search results to log entries that contain specified text pattern in the message contents.
void SetFilter (const char *Value)
 Set method for Filter.
const char * ChannelName () const
 Restricts search results to specified channel.
void SetChannelName (const char *Value)
 Set method for ChannelName.
const char * MessageLogId () const
 If this field is set, the message with specified Message Id as well as messages related to it are returned.
void SetMessageLogId (const char *Value)
 Set method for MessageLogId.
IGCboolean IncludeMessageMessages () const
 Include log entries of Type "Message" (HL7 data message) in the query results.
void SetIncludeMessageMessages (IGCboolean Value)
 Set method for IncludeMessageMessages.
IGCboolean IncludeAckMessages () const
 Include log entries of Type "Ack" (HL7 acknowledgement) in the query results.
void SetIncludeAckMessages (IGCboolean Value)
 Set method for IncludeAckMessages.
IGCboolean IncludeSuccessMessages () const
 Include log entries of Type "Success" (success events) in the query results.
void SetIncludeSuccessMessages (IGCboolean Value)
 Set method for IncludeSuccessMessages.
IGCboolean IncludeWarningMessages () const
 Include log entries of Type "Warning" (warning events) in the query results.
void SetIncludeWarningMessages (IGCboolean Value)
 Set method for IncludeWarningMessages.
IGCboolean IncludeErrorMessages () const
 Include log entries of Type "Error" (both marked and unmarked) in the query results.
void SetIncludeErrorMessages (IGCboolean Value)
 Set method for IncludeErrorMessages.
IGCboolean IncludeMarkedErrorMessages () const
 Include log entries of Type "Error" that are marked in the query results.
void SetIncludeMarkedErrorMessages (IGCboolean Value)
 Set method for IncludeMarkedErrorMessages.
IGCboolean IncludeUnmarkedErrorMessages () const
 Include log entries of Type "Error" that are not marked in the query results.
void SetIncludeUnmarkedErrorMessages (IGCboolean Value)
 Set method for IncludeUnmarkedErrorMessages.
IGCboolean IncludeInfoMessages () const
 Include log entries of Type "Info" (info events) in the query results.
void SetIncludeInfoMessages (IGCboolean Value)
 Set method for IncludeInfoMessages.
IGCboolean IncludeDebugMessages () const
 Include log entries of Type "Debug" (debug events) in the query results.
void SetIncludeDebugMessages (IGCboolean Value)
 Set method for IncludeDebugMessages.
IGCboolean IncludeDeleted () const
 Include log entries that are deleted in the query results.
void SetIncludeDeleted (IGCboolean Value)
 Set method for IncludeDeleted.
IGCboolean IncludeNonDeleted () const
 Include log entries that are not deleted in the query results.
void SetIncludeNonDeleted (IGCboolean Value)
 Set method for IncludeNonDeleted.
IGCboolean IncludeSourceLogs () const
 Indicates that messages associated with the source channel should be included.
void SetIncludeSourceLogs (IGCboolean Value)
 Set method for IncludeSourceLogs.
time_t After () const
 Specifies the starting timestamp for the search.
void SetAfter (time_t Value)
 Set method for After.
time_t Before () const
 Specifies the ending timestamp for the search.
void SetBefore (time_t Value)
 Set method for Before.
IGClogQueryResult Execute ()
 Perform a query on the configured Iguana server.

Constructor & Destructor Documentation

IGClogQuery::IGClogQuery (   ) 
 

Constructor.

virtual IGClogQuery::~IGClogQuery (   )  [virtual]
 

Destructor.

Member Function Documentation

time_t IGClogQuery::After (   )  const
 

Specifies the starting timestamp for the search.

(Optional)

See also the IGClogQuery::SetAfter method.

time_t IGClogQuery::Before (   )  const
 

Specifies the ending timestamp for the search.

(Optional)

See also the IGClogQuery::SetBefore method.

const char* IGClogQuery::ChannelName (   )  const
 

Restricts search results to specified channel.

(Optional)

See also the IGClogQuery::SetChannelName method.

IGCboolean IGClogQuery::Encrypt (   )  const
 

Specifies that Iguana server is configured to use HTTPS mode.

See also the IGClogQuery::SetEncrypt method.

IGClogQueryResult IGClogQuery::Execute (   ) 
 

Perform a query on the configured Iguana server.

Note that this method will block while the query is performed.

const char* IGClogQuery::Filter (   )  const
 

Restricts search results to log entries that contain specified text pattern in the message contents.

(Optional)

See also the IGClogQuery::SetFilter method.

IGClogQueryHandle IGClogQuery::GetHandle (   )  const [inline]
 

This method is part of the internal implementation of this class and should not be called.

const char* IGClogQuery::Host (   )  const
 

Specifies the hostname or IP address of the Iguana server.

See also the IGClogQuery::SetHost method.

IGCboolean IGClogQuery::IncludeAckMessages (   )  const
 

Include log entries of Type "Ack" (HL7 acknowledgement) in the query results.

See also the IGClogQuery::SetIncludeAckMessages method.

IGCboolean IGClogQuery::IncludeDebugMessages (   )  const
 

Include log entries of Type "Debug" (debug events) in the query results.

See also the IGClogQuery::SetIncludeDebugMessages method.

IGCboolean IGClogQuery::IncludeDeleted (   )  const
 

Include log entries that are deleted in the query results.

A log message can be deleted through Iguana dashboard by an administrator.

See also the IGClogQuery::SetIncludeDeleted method.

IGCboolean IGClogQuery::IncludeErrorMessages (   )  const
 

Include log entries of Type "Error" (both marked and unmarked) in the query results.

See also the IGClogQuery::SetIncludeErrorMessages method.

IGCboolean IGClogQuery::IncludeInfoMessages (   )  const
 

Include log entries of Type "Info" (info events) in the query results.

See also the IGClogQuery::SetIncludeInfoMessages method.

IGCboolean IGClogQuery::IncludeMarkedErrorMessages (   )  const
 

Include log entries of Type "Error" that are marked in the query results.

An error can be marked (acknowledged) through Iguana dashboard by an administrator.

See also the IGClogQuery::SetIncludeMarkedErrorMessages method.

IGCboolean IGClogQuery::IncludeMessageMessages (   )  const
 

Include log entries of Type "Message" (HL7 data message) in the query results.

See also the IGClogQuery::SetIncludeMessageMessages method.

IGCboolean IGClogQuery::IncludeNonDeleted (   )  const
 

Include log entries that are not deleted in the query results.

See also the IGClogQuery::SetIncludeNonDeleted method.

IGCboolean IGClogQuery::IncludeSourceLogs (   )  const
 

Indicates that messages associated with the source channel should be included.

See also the IGClogQuery::SetIncludeSourceLogs method.

IGCboolean IGClogQuery::IncludeSuccessMessages (   )  const
 

Include log entries of Type "Success" (success events) in the query results.

See also the IGClogQuery::SetIncludeSuccessMessages method.

IGCboolean IGClogQuery::IncludeUnmarkedErrorMessages (   )  const
 

Include log entries of Type "Error" that are not marked in the query results.

See also the IGClogQuery::SetIncludeUnmarkedErrorMessages method.

IGCboolean IGClogQuery::IncludeWarningMessages (   )  const
 

Include log entries of Type "Warning" (warning events) in the query results.

See also the IGClogQuery::SetIncludeWarningMessages method.

const char* IGClogQuery::MessageLogId (   )  const
 

If this field is set, the message with specified Message Id as well as messages related to it are returned.

When this field is set, the other search constraints (Filter, ChannelName, IncludeMessageMessages, IncludeAckMessages, etc) are ignored.

See also the IGClogQuery::SetMessageLogId method.

IGClogQuery& IGClogQuery::operator= (  const IGClogQuery &  Orig  ) 
 

Assignment operator.

const char* IGClogQuery::Password (   )  const
 

Specifies the password which should be used to authenticate with the Iguana server.

See also the IGClogQuery::SetPassword method.

IGCint32 IGClogQuery::Port (   )  const
 

Specifies the port number which is used to access the Iguana server's HTTP/HTTPS interface.

See also the IGClogQuery::SetPort method.

void IGClogQuery::SetAfter (  time_t  Value  ) 
 

Set method for After.

See IGClogQuery::After.

Parameters:
Value Value to set After to.

void IGClogQuery::SetBefore (  time_t  Value  ) 
 

Set method for Before.

See IGClogQuery::Before.

Parameters:
Value Value to set Before to.

void IGClogQuery::SetChannelName (  const char *  Value  ) 
 

Set method for ChannelName.

See IGClogQuery::ChannelName.

Parameters:
Value Value to set ChannelName to.

void IGClogQuery::SetEncrypt (  IGCboolean  Value  ) 
 

Set method for Encrypt.

See IGClogQuery::Encrypt.

Parameters:
Value Value to set Encrypt to.

void IGClogQuery::SetFilter (  const char *  Value  ) 
 

Set method for Filter.

See IGClogQuery::Filter.

Parameters:
Value Value to set Filter to.

void IGClogQuery::SetHost (  const char *  Value  ) 
 

Set method for Host.

See IGClogQuery::Host.

Parameters:
Value Value to set Host to.

void IGClogQuery::SetIncludeAckMessages (  IGCboolean  Value  ) 
 

Set method for IncludeAckMessages.

See IGClogQuery::IncludeAckMessages.

Parameters:
Value Value to set IncludeAckMessages to.

void IGClogQuery::SetIncludeDebugMessages (  IGCboolean  Value  ) 
 

Set method for IncludeDebugMessages.

See IGClogQuery::IncludeDebugMessages.

Parameters:
Value Value to set IncludeDebugMessages to.

void IGClogQuery::SetIncludeDeleted (  IGCboolean  Value  ) 
 

Set method for IncludeDeleted.

See IGClogQuery::IncludeDeleted.

Parameters:
Value Value to set IncludeDeleted to.

void IGClogQuery::SetIncludeErrorMessages (  IGCboolean  Value  ) 
 

Set method for IncludeErrorMessages.

See IGClogQuery::IncludeErrorMessages.

Parameters:
Value Value to set IncludeErrorMessages to.

void IGClogQuery::SetIncludeInfoMessages (  IGCboolean  Value  ) 
 

Set method for IncludeInfoMessages.

See IGClogQuery::IncludeInfoMessages.

Parameters:
Value Value to set IncludeInfoMessages to.

void IGClogQuery::SetIncludeMarkedErrorMessages (  IGCboolean  Value  ) 
 

Set method for IncludeMarkedErrorMessages.

See IGClogQuery::IncludeMarkedErrorMessages.

Parameters:
Value Value to set IncludeMarkedErrorMessages to.

void IGClogQuery::SetIncludeMessageMessages (  IGCboolean  Value  ) 
 

Set method for IncludeMessageMessages.

See IGClogQuery::IncludeMessageMessages.

Parameters:
Value Value to set IncludeMessageMessages to.

void IGClogQuery::SetIncludeNonDeleted (  IGCboolean  Value  ) 
 

Set method for IncludeNonDeleted.

See IGClogQuery::IncludeNonDeleted.

Parameters:
Value Value to set IncludeNonDeleted to.

void IGClogQuery::SetIncludeSourceLogs (  IGCboolean  Value  ) 
 

Set method for IncludeSourceLogs.

See IGClogQuery::IncludeSourceLogs.

Parameters:
Value Value to set IncludeSourceLogs to.

void IGClogQuery::SetIncludeSuccessMessages (  IGCboolean  Value  ) 
 

Set method for IncludeSuccessMessages.

See IGClogQuery::IncludeSuccessMessages.

Parameters:
Value Value to set IncludeSuccessMessages to.

void IGClogQuery::SetIncludeUnmarkedErrorMessages (  IGCboolean  Value  ) 
 

Set method for IncludeUnmarkedErrorMessages.

See IGClogQuery::IncludeUnmarkedErrorMessages.

Parameters:
Value Value to set IncludeUnmarkedErrorMessages to.

void IGClogQuery::SetIncludeWarningMessages (  IGCboolean  Value  ) 
 

Set method for IncludeWarningMessages.

See IGClogQuery::IncludeWarningMessages.

Parameters:
Value Value to set IncludeWarningMessages to.

void IGClogQuery::SetMessageLogId (  const char *  Value  ) 
 

Set method for MessageLogId.

See IGClogQuery::MessageLogId.

Parameters:
Value Value to set MessageLogId to.

void IGClogQuery::SetPassword (  const char *  Value  ) 
 

Set method for Password.

See IGClogQuery::Password.

Parameters:
Value Value to set Password to.

void IGClogQuery::SetPort (  IGCint32  Value  ) 
 

Set method for Port.

See IGClogQuery::Port.

Parameters:
Value Value to set Port to.

void IGClogQuery::SetUsername (  const char *  Value  ) 
 

Set method for Username.

See IGClogQuery::Username.

Parameters:
Value Value to set Username to.

const char* IGClogQuery::Username (   )  const
 

Specifies the username which should be used to authenticate with the Iguana server.

See also the IGClogQuery::SetUsername method.

The documentation for this class was generated from the following file: