AR System Java API

com.bmc.arsys.api
Class LoggingInfo

java.lang.Object
  extended by com.bmc.arsys.api.LoggingInfo
All Implemented Interfaces:
Serializable

public class LoggingInfo
extends Object
implements Serializable

The LoggingInfo class updates the indicated logging information for the specified server.

See Also:
Serialized Form

Constructor Summary
LoggingInfo()
           
LoggingInfo(boolean isEnabled, long type, long writeToFileOrStatus, String path)
          Default constructor
 
Method Summary
 void enable(boolean isEnabled)
          Sets the logging to on/off.
 boolean equals(Object obj)
           
 String getPath()
          Returns path to log file.
 long getType()
          Returns type of logging.
 long getWriteToFileOrStatus()
          Returns location of log information.
 int hashCode()
           
 boolean isEnabled()
          Returns TRUE if logging is enabled.
 boolean isWorkflowMaskOn()
           
 boolean log(String text)
          Writes the log information from the status list to the file provided by the client.
 void setPath(String fileNameWithPath)
          Sets path to log file.
 void setType(long type)
          Sets type of logging.
 void setWriteToFileOrStatus(long writeToFileOrStatus)
          Sets where to return log information.
 String toString()
           
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

LoggingInfo

public LoggingInfo()

LoggingInfo

public LoggingInfo(boolean isEnabled,
                   long type,
                   long writeToFileOrStatus,
                   String path)
Default constructor

Method Detail

enable

public void enable(boolean isEnabled)
Sets the logging to on/off.


setType

public void setType(long type)
Sets type of logging. Types include the following constants:


setWriteToFileOrStatus

public void setWriteToFileOrStatus(long writeToFileOrStatus)
Sets where to return log information. Location includes the following constants:


setPath

public void setPath(String fileNameWithPath)
Sets path to log file.


isEnabled

public boolean isEnabled()
Returns TRUE if logging is enabled.


getType

public long getType()
Returns type of logging.


getWriteToFileOrStatus

public long getWriteToFileOrStatus()
Returns location of log information.


getPath

public String getPath()
Returns path to log file.


isWorkflowMaskOn

public boolean isWorkflowMaskOn()

log

public boolean log(String text)
Writes the log information from the status list to the file provided by the client. Returns boolean whether this message needs to be removed from the status list or not.

Parameters:
text -
Returns:
boolean

toString

public String toString()
Overrides:
toString in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

AR System Java API

© Copyright 2006, 2007 BMC Software, Inc.