com.ibm.tws.objects.plan
Class FileDependencyInPlan

java.lang.Object
  extended bycom.ibm.tws.objects.plan.FileDependencyInPlan
All Implemented Interfaces:
java.io.Serializable, TWSLink

public class FileDependencyInPlan
extends java.lang.Object
implements TWSLink

File dependencies plan associations of jobs and job streams with Files. This class represent the link between a Job (or Job Stream) instance and File instance.

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

file Reference to a FileInPlan.
If you are adding dependencies the FileInPlan object should have a name not yet present in the symphony file but respecting the following rules:
Not longer than 148 characters
Base name not longer than 28 characters
satisfied Output Only.
status The status of the dependency, the default is Unsatisfied
Output Only.
timeLastChecked Output Only.

See Also:
FileInPlan, Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright
 
Constructor Summary
FileDependencyInPlan()
          Empty Constructor
FileDependencyInPlan(FileInPlanKey key)
          Constructor
FileDependencyInPlan(Identifier id)
          Constructor
FileDependencyInPlan(Identifier id, FileInPlanKey key)
          Constructor
 
Method Summary
 boolean equals(java.lang.Object object)
          equality operation.
 FileInPlan getFile()
          Deprecated.  
 FileStatusType getFileStatus()
          Return the Status of the internal FileInPlan object.
 Identifier getId()
          Get the Identifier of the FileInPlan pointed by this dependency
 FileInPlanKey getKey()
          Returns the key of the pointed FileInPlan object
 java.lang.String getQualifier()
          Returns the qualifier sets for the FileInPlan
 DependencyStatusType getStatus()
          Return the status of this Dependency.
 java.util.Date getTimeLastChecked()
          Return the Date this dependency has been checked last time.
 Identifier getWorkstationId()
          Return the Identifier of the workstation on which the FileInPlan is defined.
 int hashCode()
          Returns a hash code for this FileInPlanDependency object.
 boolean isSatisfied()
          Returns if the dependency is satisfied or not.
 void setFile(FileInPlan plan)
          Sets the FileInPlan object pointed by this dependency For internal use only.
 void setFileStatus(FileStatusType status)
          Set the Status of the internal FileInPlan object.
 void setId(Identifier identifier)
          Set the Identifier of the internal FileInPlan object
 void setKey(FileInPlanKey key)
          Set the key of the internal FileInPlan object.
 void setQualifier(java.lang.String string)
          Sets the FileInPlan qualifier.
 void setSatisfied(boolean b)
          Sets the status (satisfied or not) of this dependency For internal use only.
 void setStatus(DependencyStatusType status)
          Set the dependency status of this object.
 void setTimeLastChecked(java.util.Date date)
          Set the Date this dependency has been checked last time.
 void setWorkstationId(Identifier identifier)
          Set the workstation id of the FileInPlan object.
 java.lang.String toString()
          Returns a string representation of this FileDependencyInPlan.
 
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

FileDependencyInPlan

public FileDependencyInPlan()
Empty Constructor


FileDependencyInPlan

public FileDependencyInPlan(Identifier id)
Constructor

Parameters:
id - The identifier of the pointed FileInPlan

FileDependencyInPlan

public FileDependencyInPlan(FileInPlanKey key)
Constructor

Parameters:
key - The key of the pointed FileInPlan

FileDependencyInPlan

public FileDependencyInPlan(Identifier id,
                            FileInPlanKey key)
Constructor

Parameters:
id - The identifier of the pointed FileInPlan
key - The key of the pointed FileInPlan
Method Detail

equals

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

Parameters:
object - the object to be checked
Returns:
true if the two FileDependencyInPlan objects are equals.

hashCode

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

Returns:
The object's hash code.

toString

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

Returns:
A text string including all FileInPlan fields.

isSatisfied

public boolean isSatisfied()
Returns if the dependency is satisfied or not.

Returns:
true if this dependency is satisfied, false otherwise

setSatisfied

public void setSatisfied(boolean b)
Sets the status (satisfied or not) of this dependency For internal use only.

Parameters:
b - The new value of the satisfied field

getFile

public FileInPlan getFile()
Deprecated.  

Returns the FileInPlan object pointed by this dependency

Returns:
the FileInPlan object pointed by this dependency

setFile

public void setFile(FileInPlan plan)
Sets the FileInPlan object pointed by this dependency For internal use only.

Parameters:
plan - the FileInPlan object pointed by this dependency

getId

public Identifier getId()
Get the Identifier of the FileInPlan pointed by this dependency

Specified by:
getId in interface TWSLink
Returns:
the Identifier of the File pointed by this dependency.
See Also:
TWSLink.getId()

getQualifier

public java.lang.String getQualifier()
Returns the qualifier sets for the FileInPlan

Returns:
the file qualifier

getStatus

public DependencyStatusType getStatus()
Return the status of this Dependency. The statuses can be Satisfied, Unsatisfied, Undecided.

Returns:
the dependency status

getWorkstationId

public Identifier getWorkstationId()
Return the Identifier of the workstation on which the FileInPlan is defined.

Returns:
the file workstation ID

setQualifier

public void setQualifier(java.lang.String string)
Sets the FileInPlan qualifier. For internal use only.

Parameters:
string - the file qualifier

setStatus

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

Parameters:
status - the file status

setWorkstationId

public void setWorkstationId(Identifier identifier)
Set the workstation id of the FileInPlan object.

Parameters:
identifier - the workstation ID

getKey

public FileInPlanKey getKey()
Returns the key of the pointed FileInPlan object

Returns:
the FileInPlanKey

setId

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

Parameters:
identifier - The File identifier

setKey

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

Parameters:
key - the FileInPlanKey

getTimeLastChecked

public java.util.Date getTimeLastChecked()
Return the Date this dependency has been checked last time.

Returns:
timeLastChecked Date

setTimeLastChecked

public void setTimeLastChecked(java.util.Date date)
Set the Date this dependency has been checked last time. For internal use only.

Parameters:
date - The Date this dependency has been checked last time.

getFileStatus

public FileStatusType getFileStatus()
Return the Status of the internal FileInPlan object. The statuses can be Checked, Not Checked, Exist, Not Exist.

Returns:
The status of the FileInPlan object.

setFileStatus

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

Parameters:
status - the Status of the internal FileInPlan object.


Copyright © 2005 IBM All Rights Reserved.