com.ibm.tws.objects.model
Class FileDependency

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

public class FileDependency
extends java.lang.Object
implements TWSLink

Like other dependencies, file dependencies are logical associations between jobs or job streams and the objects on which they depend (in this case, the files). However, since TWS does not maintain information about files as separate business objects, a FileDependency does not reference any File object, which does not exist. Instead, it includes all attributes of the referenced file (for instance the file name) within the dependency object itself. For the same reason, since files are logically linked to the targets where they are located, FileDependency includes also a FlowTargetKey object, to represent the workstation (or workstation class) on which the file is defined.

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

fileName Always required
Not longer than 148 characters
Base name not longer than 28 characters
flowTargetKey Must reference an existing workstation or class
qualifiers '(' and ')' characters not allowed

Also notice that the concatenation of the file path and the qualifiers string cannot exceed 120 characters.

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
 
Constructor Summary
FileDependency()
          Creates an empty FileDependency.
FileDependency(java.lang.String name, FlowTargetKey trgKey)
          Creates a FileDependency, specifying the name and target of the file.
 
Method Summary
 boolean equals(java.lang.Object object)
          Returns true if all fields of this FileDependency object are equal to those of the given one.
 Identifier getFileId()
          Returns the file identifier.
 java.lang.String getFileName()
          Returns the file name.
 Identifier getFlowTargetId()
          Returns the identifier of the workstation or workstation class referenced by this file.
 FlowTargetKey getFlowTargetKey()
          Returns the key of the workstation or workstation class referenced by this file.
 Identifier getId()
          Returns the identifier of the file referenced by this dependency.
 java.lang.String getQualifiers()
          Returns the requested file qualifiers.
 int hashCode()
          Returns a hash code for this FileDependency object.
 void setFileId(Identifier identifier)
          Sets the file identifier.
 void setFileName(java.lang.String value)
          Sets the file name.
 void setFlowTargetId(Identifier identifier)
          Sets the identifier of the workstation or workstation class referenced by this file.
 void setFlowTargetKey(FlowTargetKey key)
          Sets the key of the workstation or workstation class referenced by this file.
 void setQualifiers(java.lang.String value)
          Sets the requested file qualifiers.
 java.lang.String toString()
          Returns a string representation of this FileDependency 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

FileDependency

public FileDependency()
Creates an empty FileDependency.


FileDependency

public FileDependency(java.lang.String name,
                      FlowTargetKey trgKey)
Creates a FileDependency, specifying the name and target of the file.

Parameters:
name - The file name.
trgKey - The key of the workstation or workstation class referenced by this file.
Method Detail

getId

public Identifier getId()
Returns the identifier of the file referenced by this dependency.

Specified by:
getId in interface TWSLink
Returns:
The identifier of the file referenced by this dependency.

getFileId

public Identifier getFileId()
Returns the file identifier.

Returns:
The file identifier.

getFileName

public java.lang.String getFileName()
Returns the file name.

Returns:
The file name.

getFlowTargetId

public Identifier getFlowTargetId()
Returns the identifier of the workstation or workstation class referenced by this file.

Returns:
The identifier of the workstation or workstation class referenced by this file.

getFlowTargetKey

public FlowTargetKey getFlowTargetKey()
Returns the key of the workstation or workstation class referenced by this file.

Returns:
The key of the workstation or workstation class referenced by this file.

getQualifiers

public java.lang.String getQualifiers()
Returns the requested file qualifiers.

Returns:
The requested file qualifiers.

setFileId

public void setFileId(Identifier identifier)
Sets the file identifier.

Parameters:
identifier - The file identifier.

setFileName

public void setFileName(java.lang.String value)
Sets the file name.

Parameters:
value - The file name.

setFlowTargetId

public void setFlowTargetId(Identifier identifier)
Sets the identifier of the workstation or workstation class referenced by this file.

Parameters:
identifier - The identifier of the workstation or workstation class referenced by this file.

setFlowTargetKey

public void setFlowTargetKey(FlowTargetKey key)
Sets the key of the workstation or workstation class referenced by this file.

Parameters:
key - The key of the workstation or workstation class referenced by this file.

setQualifiers

public void setQualifiers(java.lang.String value)
Sets the requested file qualifiers.

Parameters:
value - The requested file qualifiers.

equals

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

Returns:
The object's hash code.

toString

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

Returns:
A text string including all FileDependency fields.


Copyright © 2005 IBM All Rights Reserved.