com.ibm.tws.objects.plan
Class DomainInPlan

java.lang.Object
  extended bycom.ibm.tws.objects.plan.DomainInPlan
All Implemented Interfaces:
java.io.Serializable, TWSHeader, TWSObject

public class DomainInPlan
extends java.lang.Object
implements TWSObject, TWSHeader

This class represents a domain instance object, and includes a reference to WorkstationInPlanKey that represents, the manager of this domain instance object, and a DomainInPlanKey that represents the parent Domain instance of this Domain. If this Domain instance is a Master Domain it is null. This class implements both TWSObject and TWSHeader.

The following syntax validation constraints must be met on DomainInPlan objects:

name The Name of an Existing Domain
parentDomainKey Reference to an existing domain
It is null for the master domain
Read Only field
managerWorkstationKey Reference to the workstation manager
Read Only field

See Also:
DomainInPlanKey, WorkstationInPlanKey, Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
 
Constructor Summary
DomainInPlan()
          Constructor.
DomainInPlan(DomainInPlanKey domainKey)
          Constructor.
DomainInPlan(Identifier domainId)
          Constructor.
DomainInPlan(Identifier domainId, DomainInPlanKey domainKey)
          Constructor.
 
Method Summary
 boolean equals(java.lang.Object object)
          Returns true if all fields of this DomainInPlan object are equal to those of the given one.
 Identifier getId()
          Gets the Domain In Plan Identifier
 DomainInPlanKey getKey()
          Returns the DomainInPlanKey wrapped by this DomainInPlan object.
 LockData getLockData()
          Returns always null because locking is not available for objects in plan.
 WorkstationInPlanKey getManagerWorkstationKey()
          Returns the key of the domain manager workstation.
 ModifyData getModifyData()
          Returns always null because modification info are not available for objects in plan.
 java.lang.String getName()
          Returns the domain name.
 TWSHeader getObjectHeader()
          Returns the object header.
 TWSKey getObjectKey()
          Returns the object key.
 Identifier getParentDomainId()
          Gets the parent Domain identifier
 DomainInPlanKey getParentDomainKey()
          Returns the key of the parent domain.
 int hashCode()
          Returns a hash code for this DomainInPlan object.
 void setId(Identifier identifier)
          Sets the domain Identifier.
 void setKey(DomainInPlanKey domainKey)
          Sets the DomainInPlanKey to be wrapped by this DomainInPlan object.
 void setManagerWorkstationKey(WorkstationInPlanKey flowTargetKey)
          Sets the key of the domain manager workstation.
 void setName(java.lang.String value)
          Sets the domain name.
 void setParentDomainId(Identifier identifier)
          Sets the parent domain identifier.
 void setParentDomainKey(DomainInPlanKey domainKey)
          Sets the key of the parent domain.
 java.lang.String toString()
          Returns a string representation of this DomainInPlan.
 
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

DomainInPlan

public DomainInPlan()
Constructor. Creates an empty DomainInPlan.


DomainInPlan

public DomainInPlan(Identifier domainId)
Constructor. Creates a Domain in plan with the specified identifier.

Parameters:
domainId - The domain identifier.

DomainInPlan

public DomainInPlan(DomainInPlanKey domainKey)
Constructor. Creates a DomainInPlan with the specified key.

Parameters:
domainKey - The domain key.

DomainInPlan

public DomainInPlan(Identifier domainId,
                    DomainInPlanKey domainKey)
Constructor. Creates a DomainInPlan with the specified id and key.

Parameters:
domainId - The domain id.
domainKey - The domain key.
Method Detail

getKey

public DomainInPlanKey getKey()
Returns the DomainInPlanKey wrapped by this DomainInPlan object.

Returns:
The DomainInPlanKey wrapped by this DomainInPlan object.

getName

public java.lang.String getName()
Returns the domain name.

Specified by:
getName in interface TWSObject
Returns:
The domain name.

getParentDomainKey

public DomainInPlanKey getParentDomainKey()
Returns the key of the parent domain.

Returns:
The key of the parent domain.

getManagerWorkstationKey

public WorkstationInPlanKey getManagerWorkstationKey()
Returns the key of the domain manager workstation.

Returns:
The key of the domain manager workstation.

setKey

public void setKey(DomainInPlanKey domainKey)
Sets the DomainInPlanKey to be wrapped by this DomainInPlan object.

Parameters:
domainKey - The DomainInPlanKey to be wrapped by this DomainInPlan object.

setName

public void setName(java.lang.String value)
Sets the domain name.

Parameters:
value - The domain name.

setParentDomainKey

public void setParentDomainKey(DomainInPlanKey domainKey)
Sets the key of the parent domain. For internal use only.

Parameters:
domainKey - The DomainInPlanKey of the parent domain.

setManagerWorkstationKey

public void setManagerWorkstationKey(WorkstationInPlanKey flowTargetKey)
Sets the key of the domain manager workstation. For internal use only.

Parameters:
flowTargetKey - The FlowTargetInPlanKey of the domain manager workstation.

equals

public boolean equals(java.lang.Object object)
Returns true if all fields of this DomainInPlan 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 DomainInPlan object.

Returns:
The object's hash code.

toString

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

Returns:
A text string including all DomainInPlan fields.

getModifyData

public ModifyData getModifyData()
Returns always null because modification info are not available for objects in plan.

Specified by:
getModifyData in interface TWSObject
Returns:
ModifyData the object's modify data.

getLockData

public LockData getLockData()
Returns always null because locking is not available for objects in plan.

Specified by:
getLockData in interface TWSObject
Returns:
LockData the object's lock data.

getObjectKey

public TWSKey getObjectKey()
Returns the object key.

Specified by:
getObjectKey in interface TWSObject
Returns:
The object key.

getObjectHeader

public TWSHeader getObjectHeader()
Returns the object header.

Specified by:
getObjectHeader in interface TWSObject
Returns:
The object header.

setId

public void setId(Identifier identifier)
Sets the domain Identifier.

Parameters:
identifier - the object's Identifier

getId

public Identifier getId()
Gets the Domain In Plan Identifier

Specified by:
getId in interface TWSObject
Returns:
the object's Identifier

getParentDomainId

public Identifier getParentDomainId()
Gets the parent Domain identifier

Returns:
the parent Domain Identifier.

setParentDomainId

public void setParentDomainId(Identifier identifier)
Sets the parent domain identifier. For internal use only.

Parameters:
identifier - The parent Domain Identifier.


Copyright © 2005 IBM All Rights Reserved.