com.ibm.tws.objects.plan
Class FileInPlan

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

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

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.

See Also:
FileInPlanKey, Serialized Form

Field 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

COPYRIGHT

public static final java.lang.String COPYRIGHT
Copyright

Constructor Detail

FileInPlan

public FileInPlan()
Empty Constructor


FileInPlan

public FileInPlan(Identifier id)
Constructor

Parameters:
id - The FileInPlan identifier

FileInPlan

public FileInPlan(FileInPlanKey key)
Constructor

Parameters:
key - FileInPlan key

FileInPlan

public FileInPlan(Identifier id,
                  FileInPlanKey key)
Constructor

Parameters:
id - The FileInPlan id
key - The FileInPlan key
Method Detail

getId

public Identifier getId()
Returns the Identifier of this FileInPlan object.

Specified by:
getId in interface TWSObject
Returns:
the Identifier of this FileInPlan.
See Also:
TWSHeader.getId()

getName

public java.lang.String getName()
Returns the name of this FileInPlan object.

Specified by:
getName in interface TWSObject
Returns:
the name of this FileInPlan object.
See Also:
TWSHeader.getName()

setName

public void setName(java.lang.String name)
Sets the key name. For internal use only.

Parameters:
name - the new FileInPlan name.

getObjectKey

public TWSKey getObjectKey()
Returns the key of this FileInPlan object as a TWSKey.

Specified by:
getObjectKey in interface TWSObject
Returns:
the key of this FileInPlan object.
See Also:
TWSHeader.getObjectKey()

getObjectHeader

public TWSHeader getObjectHeader()
Return the header of this FileInPlan object. Note that this class implements both TWSObject and TWSHeader, and then this method in this case simply return 'this'.

Specified by:
getObjectHeader in interface TWSObject
Returns:
the TWSHeader of this object.
See Also:
TWSObject.getObjectHeader()

getModifyData

public ModifyData getModifyData()
Return the ModifyData of this object. For plan object, this method always returns null.

Specified by:
getModifyData in interface TWSObject
Returns:
null.
See Also:
TWSHeader.getModifyData()

getLockData

public LockData getLockData()
Return the LockData of this object. For plan object, this method always returns null.

Specified by:
getLockData in interface TWSObject
Returns:
null.
See Also:
TWSHeader.getLockData()

getKey

public FileInPlanKey getKey()
Return the key of this FileInPlan object as a FileInPlanKey

Returns:
the key of this FileInPlan key

getQualifier

public java.lang.String getQualifier()
Return the qualifier of this FileInPlan object

Returns:
the qualifier of this FileInPlan object

getStatus

public FileStatusType getStatus()
Return the status of this FileInPlan object. Valid values are: Checked, Not Checked, Exist, Not Exist.

Returns:
The status of this FileInPlan.

getWorkstationId

public Identifier getWorkstationId()
Returns the Identifier of the Workstation on which this FileInPlan is defined.

Returns:
the Identifier of the workstation on which this FileInPlan is defined.

setId

public void setId(Identifier identifier)
Set the Identifier of this FileInPlan object.

Parameters:
identifier - The new Identifier of this FileInPlan object.

setKey

public void setKey(FileInPlanKey key)
Set the Key of this FileInPlan object For internal use only.

Parameters:
key - The new key of this FileInPlan object.

setQualifier

public void setQualifier(java.lang.String string)
Set the qualifier of this FileInPlan object For Internal Use only

Parameters:
string - The new qualifier of this FileInPlan object.

setStatus

public void setStatus(FileStatusType status)
Set the status of this FileInPlan object For internal use only.

Parameters:
status - the new status of the FileInPlan object

setWorkstationId

public void setWorkstationId(Identifier identifier)
Set the Identifier of the Workstation on which this object is defined.

Parameters:
identifier - The new workstation Identifier.

equals

public boolean equals(java.lang.Object object)
equality method.

Parameters:
object - The object to be compared.
Returns:
true if the two object are instance of FileInPlan and are equal, false otherwise.

hashCode

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

Returns:
The object's hash code.

toString

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

Returns:
A text string including all FileInPlan fields.

getWorkstationKey

public WorkstationInPlanKey getWorkstationKey()
Returns the key of the workstation on which this object is defined.

Returns:
this key of the workstation on which this object is defined.

setWorkstationKey

public void setWorkstationKey(WorkstationInPlanKey key)
Sets the key of the workstation on which this object is defined. For internal use only.

Parameters:
key - the key of the workstation on which this object is defined.


Copyright © 2005 IBM All Rights Reserved.