|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.tws.objects.model.Domain
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 |
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 |
public static final java.lang.String COPYRIGHT
Constructor Detail |
public Domain()
public Domain(Identifier domainId)
domainId
- The domain identifier.public Domain(DomainKey domainKey)
domainKey
- The domain key.public Domain(Identifier domainId, DomainKey domainKey)
domainId
- The domain identifier.domainKey
- The domain key.Method Detail |
public Identifier getId()
getId
in interface TWSObject
public TWSKey getObjectKey()
getObjectKey
in interface TWSObject
public TWSHeader getObjectHeader()
getObjectHeader
in interface TWSObject
public DomainKey getKey()
public java.lang.String getName()
getName
in interface TWSObject
public java.lang.String getDescription()
public Identifier getParentId()
public DomainKey getParentDomainKey()
public boolean isMaster()
public FlowTargetKey getManagerWorkstationKey()
public ModifyData getModifyData()
getModifyData
in interface TWSObject
public LockData getLockData()
getLockData
in interface TWSObject
public void setId(Identifier identifier)
identifier
- The domain identifier.public void setKey(DomainKey domainKey)
domainKey
- The DomainKey to be wrapped by this Domain object.public void setName(java.lang.String value)
value
- The domain name.public void setDescription(java.lang.String value)
value
- The domain description.public void setParentId(Identifier identifier)
identifier
- The identifier of the parent domain.public void setParentDomainKey(DomainKey domainKey)
domainKey
- The DomainKey of the parent domain.public void setMaster(boolean value)
value
- True if this domain is the master.public void setManagerWorkstationKey(FlowTargetKey flowTargetKey)
flowTargetKey
- The FlowTargetKey of the domain manager workstation.public void setModifyData(ModifyData data)
data
- A ModifyData object.public void setLockData(LockData data)
data
- A LockData object.public boolean equals(java.lang.Object object)
object
- The object to be compared with this one.
public int hashCode()
public java.lang.String toString()
|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |