com.ibm.tws.objects.plan.utils
Class EngineInformation

java.lang.Object
  extended bycom.ibm.tws.objects.plan.utils.EngineInformation
All Implemented Interfaces:
java.io.Serializable

public class EngineInformation
extends java.lang.Object
implements java.io.Serializable

This class is used by the getEngineInformation API in order to return information about the engine to which the client is connected. For this reason this class as a whole represent an output object, and all the attribute in it cannot be modified at all.

See Also:
com.ibm.tws.conn.plan.Plan, Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
 
Constructor Summary
EngineInformation()
          Empty Constructor
 
Method Summary
 boolean equals(java.lang.Object object)
          Returns true if all fields of this EngineInformation object are equal to those of the given one.
 java.util.Date getCurrentJobStreamDate()
          Returns the Current Job Stream Date.
 int getDatabaseAuditLevel()
          Returns the Database Audit Level.
 EngineStatusType getEngineStatus()
          Returns the Engine Status.
 LockData getLockData()
          Returns the lock data.
 java.util.TimeZone getMasterDatabaseTimeZone()
          Returns the Master Database Timetone.
 Identifier getMasterDomainId()
          Returns the Master Domain Identifier
 DomainInPlanKey getMasterDomainKey()
          Returns the Master Domain key
 java.util.TimeZone getMasterPlanTimeZone()
          Returns the Master Plan Timezone
 Identifier getMasterWorkstationId()
          Returns the Master Workstation Identifier.
 WorkstationInPlanKey getMasterWorkstationKey()
          Returns the Master Workstation Identifier.
 ModifyData getModifyData()
          Returns the modify data.
 int getPlanAuditLevel()
          Returns the Plan Audit Level.
 long getPlanRunNumber()
          Returns the plan run number.
 long getStartOfDay()
          Returns the start of day (in milliseconds).
 Identifier getThisWorkstationId()
          Returns this Workstation Identifier.
 WorkstationInPlanKey getThisWorkstationKey()
          Returns this Workstation key.
 java.lang.String getVersion()
          Returns the Engine version
 int hashCode()
          Returns a hash code for this EngineInformation object.
 boolean isDbExpanded()
          Returns true if the Database is expanded, false otherwise.
 boolean isPlanExpanded()
          Returns true if the plan is expanded, false otherwise
 boolean isTimeZoneEnabled()
          Returns true if the timezones are enabled, false otherwise.
 void setCurrentJobStreamDate(java.util.Date date)
          Sets the current Job Stream Date.
 void setDatabaseAuditLevel(int i)
          Sets the database audit level.
 void setDbExpanded(boolean b)
          Set the Database expanded flag.
 void setEngineStatus(EngineStatusType types)
          Sets the Engine status.
 void setMasterDatabaseTimeZone(java.util.TimeZone string)
          Sets the Master Database Timezone.
 void setMasterDomainId(Identifier identifier)
          Sets the Master Domain Identifier.
 void setMasterDomainKey(DomainInPlanKey key)
          Sets the Master Domain key.
 void setMasterPlanTimeZone(java.util.TimeZone string)
          Sets the Mster Plan Timezone.
 void setMasterWorkstationId(Identifier identifier)
          Sets the master Workstation Identifier.
 void setMasterWorkstationKey(WorkstationInPlanKey key)
          Sets the master Workstation Key.
 void setPlanAuditLevel(int i)
          Sets the Plan Audit Level.
 void setPlanExpanded(boolean b)
          Sets the plan expanded flag.
 void setPlanRunNumber(long l)
          For internal use only
 void setStartOfDay(long l)
          Sets the start of day (in Milliseconds).
 void setThisWorkstationId(Identifier identifier)
          Set 'This' Workstation Identifier.
 void setThisWorkstationKey(WorkstationInPlanKey key)
          Set 'This' Workstation key.
 void setTimeZoneEnabled(boolean b)
          Sets if the timezones are enabled For internal use only
 void setVersion(java.lang.String string)
          Sets the Engine Version.
 java.lang.String toString()
          Returns a String representation of this object.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
Copyright.

Constructor Detail

EngineInformation

public EngineInformation()
Empty Constructor

Method Detail

equals

public boolean equals(java.lang.Object object)
Returns true if all fields of this EngineInformation object are equal to those of the given one.

Parameters:
object - The object to be compared with this one.
Returns:
True if this object equals to the given one.

hashCode

public int hashCode()
Returns a hash code for this EngineInformation object.

Returns:
The object's hash code.

toString

public java.lang.String toString()
Returns a String representation of this object.

Returns:
a String representation of this object.
See Also:
Object.toString()

getCurrentJobStreamDate

public java.util.Date getCurrentJobStreamDate()
Returns the Current Job Stream Date.

Returns:
the Current Job Stream Date.

isDbExpanded

public boolean isDbExpanded()
Returns true if the Database is expanded, false otherwise. N/A.

Returns:
true if the Database is expanded, false otherwise. N/A.

getEngineStatus

public EngineStatusType getEngineStatus()
Returns the Engine Status. Possible values are: Down, Lives, Rules.

Returns:
the Engine Status.

getMasterDatabaseTimeZone

public java.util.TimeZone getMasterDatabaseTimeZone()
Returns the Master Database Timetone.

Returns:
the Master Database Timetone.

getMasterDomainId

public Identifier getMasterDomainId()
Returns the Master Domain Identifier

Returns:
the Master Domain Identifier

getMasterDomainKey

public DomainInPlanKey getMasterDomainKey()
Returns the Master Domain key

Returns:
the Master Domain key

getMasterPlanTimeZone

public java.util.TimeZone getMasterPlanTimeZone()
Returns the Master Plan Timezone

Returns:
the Master Plan Timezone

getMasterWorkstationId

public Identifier getMasterWorkstationId()
Returns the Master Workstation Identifier.

Returns:
the Master Workstation Identifier.

getMasterWorkstationKey

public WorkstationInPlanKey getMasterWorkstationKey()
Returns the Master Workstation Identifier.

Returns:
the Master Workstation Identifier.

isPlanExpanded

public boolean isPlanExpanded()
Returns true if the plan is expanded, false otherwise

Returns:
true if the plan is expanded, false otherwise

getPlanRunNumber

public long getPlanRunNumber()
Returns the plan run number.

Returns:
the plan run number.

getStartOfDay

public long getStartOfDay()
Returns the start of day (in milliseconds).

Returns:
the start of day.

getThisWorkstationId

public Identifier getThisWorkstationId()
Returns this Workstation Identifier.

Returns:
this Workstation Identifier.

getThisWorkstationKey

public WorkstationInPlanKey getThisWorkstationKey()
Returns this Workstation key.

Returns:
this Workstation key

isTimeZoneEnabled

public boolean isTimeZoneEnabled()
Returns true if the timezones are enabled, false otherwise.

Returns:
true if the timezones are enabled, false otherwise.

setCurrentJobStreamDate

public void setCurrentJobStreamDate(java.util.Date date)
Sets the current Job Stream Date. For internal use only

Parameters:
date - the current Job Stream Date to set.

setDbExpanded

public void setDbExpanded(boolean b)
Set the Database expanded flag. For internal use only

Parameters:
b - the Database expanded flag to set.

setEngineStatus

public void setEngineStatus(EngineStatusType types)
Sets the Engine status. For internal use only

Parameters:
types - the Engine status to set.

setMasterDatabaseTimeZone

public void setMasterDatabaseTimeZone(java.util.TimeZone string)
Sets the Master Database Timezone. For internal use only

Parameters:
string - the Master Database Timezone to set.

setMasterDomainId

public void setMasterDomainId(Identifier identifier)
Sets the Master Domain Identifier. For internal use only

Parameters:
identifier - the Master Domain Identifier to set.

setMasterDomainKey

public void setMasterDomainKey(DomainInPlanKey key)
Sets the Master Domain key. For internal use only

Parameters:
key - the Master Domain key.

setMasterPlanTimeZone

public void setMasterPlanTimeZone(java.util.TimeZone string)
Sets the Mster Plan Timezone. For internal use only

Parameters:
string - the Mster Plan Timezone to set.

setMasterWorkstationId

public void setMasterWorkstationId(Identifier identifier)
Sets the master Workstation Identifier. For internal use only

Parameters:
identifier - the master Workstation Identifier to set.

setMasterWorkstationKey

public void setMasterWorkstationKey(WorkstationInPlanKey key)
Sets the master Workstation Key. For internal use only

Parameters:
key - the master Workstation Key to set.

setPlanExpanded

public void setPlanExpanded(boolean b)
Sets the plan expanded flag. For internal use only

Parameters:
b - the plan expanded flag to set.

setPlanRunNumber

public void setPlanRunNumber(long l)
For internal use only

Parameters:
l -

setStartOfDay

public void setStartOfDay(long l)
Sets the start of day (in Milliseconds). For internal use only

Parameters:
l - the start of day to set.

setThisWorkstationId

public void setThisWorkstationId(Identifier identifier)
Set 'This' Workstation Identifier. For internal use only

Parameters:
identifier - 'This' Workstation Identifier to set.

setThisWorkstationKey

public void setThisWorkstationKey(WorkstationInPlanKey key)
Set 'This' Workstation key. For internal use only

Parameters:
key - 'This' Workstation key to set.

setTimeZoneEnabled

public void setTimeZoneEnabled(boolean b)
Sets if the timezones are enabled For internal use only

Parameters:
b - true if the timezones are enabled, false otherwise.

getModifyData

public ModifyData getModifyData()
Returns the modify data. For plan objects it returns always null

See Also:
TWSHeader.getModifyData()

getLockData

public LockData getLockData()
Returns the lock data. For plan objects it returns always null

See Also:
TWSHeader.getLockData()

getVersion

public java.lang.String getVersion()
Returns the Engine version

Returns:
the Engine version.

setVersion

public void setVersion(java.lang.String string)
Sets the Engine Version. For internal use only

Parameters:
string - the Engine Version to set.

getDatabaseAuditLevel

public int getDatabaseAuditLevel()
Returns the Database Audit Level. N/A

Returns:
the database Audit Level

getPlanAuditLevel

public int getPlanAuditLevel()
Returns the Plan Audit Level.

Returns:
the Plan Audit level.

setDatabaseAuditLevel

public void setDatabaseAuditLevel(int i)
Sets the database audit level. For internal use only

Parameters:
i - the database audit level to set.

setPlanAuditLevel

public void setPlanAuditLevel(int i)
Sets the Plan Audit Level. For internal use only

Parameters:
i - the Plan Audit Level to set.


Copyright © 2005 IBM All Rights Reserved.