|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.tws.objects.plan.FileInPlan
This class represents a file instance in plan object, and includes a reference to WorkstationInPlanKey that represents the workstation on which the file is present. This class implements both TWSObject and TWSHeader.
The following syntax validation constraints must be met on FileInPlan objects:
name | Name of an existing file in Symphony. |
qualifier | Read Only |
status | Read Only. |
FileInPlanKey
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
COPYRIGHT
Copyright |
Constructor Summary | |
---|---|
FileInPlan()
Empty Constructor |
|
FileInPlan(FileInPlanKey key)
Constructor |
|
FileInPlan(Identifier id)
Constructor |
|
FileInPlan(Identifier id,
FileInPlanKey key)
Constructor |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object object)
equality method. |
Identifier |
getId()
Returns the Identifier of this FileInPlan object. |
FileInPlanKey |
getKey()
Return the key of this FileInPlan object as a FileInPlanKey |
LockData |
getLockData()
Return the LockData of this object. |
ModifyData |
getModifyData()
Return the ModifyData of this object. |
java.lang.String |
getName()
Returns the name of this FileInPlan object. |
TWSHeader |
getObjectHeader()
Return the header of this FileInPlan object. |
TWSKey |
getObjectKey()
Returns the key of this FileInPlan object as a TWSKey. |
java.lang.String |
getQualifier()
Return the qualifier of this FileInPlan object |
FileStatusType |
getStatus()
Return the status of this FileInPlan object. |
Identifier |
getWorkstationId()
Returns the Identifier of the Workstation on which this FileInPlan is defined. |
WorkstationInPlanKey |
getWorkstationKey()
Returns the key of the workstation on which this object is defined. |
int |
hashCode()
Returns a hash code for this FileInPlan object. |
void |
setId(Identifier identifier)
Set the Identifier of this FileInPlan object. |
void |
setKey(FileInPlanKey key)
Set the Key of this FileInPlan object For internal use only. |
void |
setName(java.lang.String name)
Sets the key name. |
void |
setQualifier(java.lang.String string)
Set the qualifier of this FileInPlan object For Internal Use only |
void |
setStatus(FileStatusType status)
Set the status of this FileInPlan object For internal use only. |
void |
setWorkstationId(Identifier identifier)
Set the Identifier of the Workstation on which this object is defined. |
void |
setWorkstationKey(WorkstationInPlanKey key)
Sets the key of the workstation on which this object is defined. |
java.lang.String |
toString()
Returns a string representation of this FileInPlan. |
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 FileInPlan()
public FileInPlan(Identifier id)
id
- The FileInPlan identifierpublic FileInPlan(FileInPlanKey key)
key
- FileInPlan keypublic FileInPlan(Identifier id, FileInPlanKey key)
id
- The FileInPlan idkey
- The FileInPlan keyMethod Detail |
public Identifier getId()
getId
in interface TWSObject
TWSHeader.getId()
public java.lang.String getName()
getName
in interface TWSObject
TWSHeader.getName()
public void setName(java.lang.String name)
name
- the new FileInPlan name.public TWSKey getObjectKey()
getObjectKey
in interface TWSObject
TWSHeader.getObjectKey()
public TWSHeader getObjectHeader()
getObjectHeader
in interface TWSObject
TWSObject.getObjectHeader()
public ModifyData getModifyData()
getModifyData
in interface TWSObject
TWSHeader.getModifyData()
public LockData getLockData()
getLockData
in interface TWSObject
TWSHeader.getLockData()
public FileInPlanKey getKey()
public java.lang.String getQualifier()
public FileStatusType getStatus()
public Identifier getWorkstationId()
public void setId(Identifier identifier)
identifier
- The new Identifier of this FileInPlan object.public void setKey(FileInPlanKey key)
key
- The new key of this FileInPlan object.public void setQualifier(java.lang.String string)
string
- The new qualifier of this FileInPlan object.public void setStatus(FileStatusType status)
status
- the new status of the FileInPlan objectpublic void setWorkstationId(Identifier identifier)
identifier
- The new workstation Identifier.public boolean equals(java.lang.Object object)
object
- The object to be compared.
public int hashCode()
public java.lang.String toString()
public WorkstationInPlanKey getWorkstationKey()
public void setWorkstationKey(WorkstationInPlanKey key)
key
- the key of the workstation on which this object is defined.
|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |