com.ibm.tws.objects.model
Class Domain

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

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

This object represents a TWS domain, has no header object and wraps a DomainKey object. A Domain references both the key of the parent domain and the key of the manager workstation. However, the reference to the manager workstation is to be used only for reporting purposes, since the corresponding relationship is maintained on the workstation.

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

name Always required
Alphanumeric characters
Starting with alphabetic character
'-' and '_' characters allowed
Blank spaces not allowed
Not longer than 16 characters
description Not longer than 120 characters
parentDomainKey If specified, must reference an existing domain
Must be null for the master domain
managerWorkstationKey This is a read-only field

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
 
Constructor Summary
Domain()
          Creates an empty Domain.
Domain(DomainKey domainKey)
          Creates a Domain with the specified key.
Domain(Identifier domainId)
          Creates a Domain with the specified identifier.
Domain(Identifier domainId, DomainKey domainKey)
          Creates a Domain with the specified identifier and key.
 
Method Summary
 boolean equals(java.lang.Object object)
          Returns true if all fields of this Domain object are equal to those of the given one.
 java.lang.String getDescription()
          Returns the domain description.
 Identifier getId()
          Returns the domain identifier.
 DomainKey getKey()
          Returns the DomainKey wrapped by this Domain object.
 LockData getLockData()
          Returns the domain lock data.
 FlowTargetKey getManagerWorkstationKey()
          Returns the key of the domain manager workstation.
 ModifyData getModifyData()
          Returns the domain modification data.
 java.lang.String getName()
          Returns the domain name.
 TWSHeader getObjectHeader()
          Returns this object, which also acts as a TWS header.
 TWSKey getObjectKey()
          Returns the domain key as a TWS key.
 DomainKey getParentDomainKey()
          Returns the key of the parent domain.
 Identifier getParentId()
          Returns the identifier of the parent domain.
 int hashCode()
          Returns a hash code for this Domain object.
 boolean isMaster()
          Returns true if this domain is the master.
 void setDescription(java.lang.String value)
          Sets the domain description.
 void setId(Identifier identifier)
          Sets the domain identifier.
 void setKey(DomainKey domainKey)
          Sets the DomainKey to be wrapped by this Domain object.
 void setLockData(LockData data)
          Sets the domain lock data.
 void setManagerWorkstationKey(FlowTargetKey flowTargetKey)
          Sets the key of the domain manager workstation.
 void setMaster(boolean value)
          Sets the property used to decide if this domain is the master.
 void setModifyData(ModifyData data)
          Sets the domain modification data.
 void setName(java.lang.String value)
          Sets the domain name.
 void setParentDomainKey(DomainKey domainKey)
          Sets the key of the parent domain.
 void setParentId(Identifier identifier)
          Sets the identifier of the parent domain.
 java.lang.String toString()
          Returns a string representation of this Domain 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

Domain

public Domain()
Creates an empty Domain.


Domain

public Domain(Identifier domainId)
Creates a Domain with the specified identifier.

Parameters:
domainId - The domain identifier.

Domain

public Domain(DomainKey domainKey)
Creates a Domain with the specified key.

Parameters:
domainKey - The domain key.

Domain

public Domain(Identifier domainId,
              DomainKey domainKey)
Creates a Domain with the specified identifier and key.

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

getId

public Identifier getId()
Returns the domain identifier.

Specified by:
getId in interface TWSObject
Returns:
The domain identifier.

getObjectKey

public TWSKey getObjectKey()
Returns the domain key as a TWS key.

Specified by:
getObjectKey in interface TWSObject
Returns:
The domain key as a TWS key.

getObjectHeader

public TWSHeader getObjectHeader()
Returns this object, which also acts as a TWS header.

Specified by:
getObjectHeader in interface TWSObject
Returns:
This object, which also acts as a TWS header.

getKey

public DomainKey getKey()
Returns the DomainKey wrapped by this Domain object.

Returns:
The DomainKey wrapped by this Domain object.

getName

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

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

getDescription

public java.lang.String getDescription()
Returns the domain description.

Returns:
The domain description.

getParentId

public Identifier getParentId()
Returns the identifier of the parent domain.

Returns:
The identifier of the parent domain.

getParentDomainKey

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

Returns:
The key of the parent domain.

isMaster

public boolean isMaster()
Returns true if this domain is the master.

Returns:
True if this domain is the master.

getManagerWorkstationKey

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

Returns:
The key of the domain manager workstation.

getModifyData

public ModifyData getModifyData()
Returns the domain modification data.

Specified by:
getModifyData in interface TWSObject
Returns:
The domain modification data.

getLockData

public LockData getLockData()
Returns the domain lock data.

Specified by:
getLockData in interface TWSObject
Returns:
The domain lock data.

setId

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

Parameters:
identifier - The domain identifier.

setKey

public void setKey(DomainKey domainKey)
Sets the DomainKey to be wrapped by this Domain object.

Parameters:
domainKey - The DomainKey to be wrapped by this Domain object.

setName

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

Parameters:
value - The domain name.

setDescription

public void setDescription(java.lang.String value)
Sets the domain description.

Parameters:
value - The domain description.

setParentId

public void setParentId(Identifier identifier)
Sets the identifier of the parent domain.

Parameters:
identifier - The identifier of the parent domain.

setParentDomainKey

public void setParentDomainKey(DomainKey domainKey)
Sets the key of the parent domain.

Parameters:
domainKey - The DomainKey of the parent domain.

setMaster

public void setMaster(boolean value)
Sets the property used to decide if this domain is the master. For internal use only.

Parameters:
value - True if this domain is the master.

setManagerWorkstationKey

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

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

setModifyData

public void setModifyData(ModifyData data)
Sets the domain modification data. For internal use only.

Parameters:
data - A ModifyData object.

setLockData

public void setLockData(LockData data)
Sets the domain lock data. For internal use only.

Parameters:
data - A LockData object.

equals

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

Returns:
The object's hash code.

toString

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

Returns:
A text string including all Domain fields.


Copyright © 2005 IBM All Rights Reserved.