com.ibm.tws.objects.plan
Class ResourceHolderInPlan

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

public class ResourceHolderInPlan
extends java.lang.Object
implements TWSLink

The ResourceHolderInPlan object, represents a link between a ResourceInPlan object and the FlowNodeInPlan object that depends on it. The link is obtained either through the JobInPlanKey reference (if the holder is a Job) or through the JobStreamInPlanKey reference (if the holder is a Job Stream). Obviously one and only one of the two references is present for each instance of this class. This is an output only class.

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

jobStreamKey If present, reference to an existing job stream
If not present jobKey is specified.
Read Only.
jobKey If present, reference to an existing job
If not present jobStreamKey is specified.
Read Only.
quantity Read Only.
jobStreamInternalName Read Only.

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
 
Constructor Summary
ResourceHolderInPlan()
          Creates an empty ResourceHolderInPlan.
ResourceHolderInPlan(Identifier id, JobInPlanKey key)
          Constructor
ResourceHolderInPlan(Identifier id, JobStreamInPlanKey key)
          Constructor
 
Method Summary
 boolean equals(java.lang.Object object)
          Returns true if all fields of this ResourceHolderInPlan object are equal to those of the given one.
 Identifier getId()
          Returns the Identifier either of the Job Stream (if the holder is a Job Stream) or of the Job (if the holder is a Job).
 Identifier getJobId()
          Returns the Job Identifier
 JobInPlanKey getJobKey()
          Returns the Job Key
 Identifier getJobStreamId()
          Returns the Job Stream Identifier
 java.lang.String getJobStreamInternalName()
          Returns the job stream internal name For Internal Use Only.
 JobStreamInPlanKey getJobStreamKey()
          Returns the Job Stream Key
 int getQuantity()
          Returns the quantity held by the holder
 int hashCode()
          Returns a hash code for this ResourceHolderInPlan object.
 void setJobId(Identifier identifier)
          Sets the Job Identifier For Internal Use Only.
 void setJobKey(JobInPlanKey key)
          Sets the Job key For Internal use only.
 void setJobStreamId(Identifier identifier)
          Sets the Job Stream Identifier.
 void setJobStreamInternalName(java.lang.String string)
          Sets the job stream internal name For Internal use only.
 void setJobStreamKey(JobStreamInPlanKey key)
          Sets the Job Stream Key For Internal use only.
 void setQuantity(int i)
          Sets the quantity used bu holder.
 java.lang.String toString()
          Returns a string representation of this ResourceHolderInPlan.
 
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

ResourceHolderInPlan

public ResourceHolderInPlan()
Creates an empty ResourceHolderInPlan.


ResourceHolderInPlan

public ResourceHolderInPlan(Identifier id,
                            JobStreamInPlanKey key)
Constructor

Parameters:
id - The Job Stream Identifier
key - The Job Stream key

ResourceHolderInPlan

public ResourceHolderInPlan(Identifier id,
                            JobInPlanKey key)
Constructor

Parameters:
id - The Job Identifier
key - The Job key
Method Detail

getId

public Identifier getId()
Returns the Identifier either of the Job Stream (if the holder is a Job Stream) or of the Job (if the holder is a Job).

Specified by:
getId in interface TWSLink
Returns:
The holder Identifier
See Also:
TWSLink.getId()

equals

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

Returns:
The object's hash code.

toString

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

Returns:
A text string including all ResourceHolderInPlan fields.

getJobId

public Identifier getJobId()
Returns the Job Identifier

Returns:
the Job Identifier

getJobKey

public JobInPlanKey getJobKey()
Returns the Job Key

Returns:
the Job key.

getJobStreamId

public Identifier getJobStreamId()
Returns the Job Stream Identifier

Returns:
the Job Stream Identifier

getJobStreamKey

public JobStreamInPlanKey getJobStreamKey()
Returns the Job Stream Key

Returns:
the Job Stream key

getQuantity

public int getQuantity()
Returns the quantity held by the holder

Returns:
the quantity

setJobId

public void setJobId(Identifier identifier)
Sets the Job Identifier For Internal Use Only.

Parameters:
identifier - the Job Identifier

setJobKey

public void setJobKey(JobInPlanKey key)
Sets the Job key For Internal use only.

Parameters:
key - the Job key

setJobStreamId

public void setJobStreamId(Identifier identifier)
Sets the Job Stream Identifier. For Internal Use Only.

Parameters:
identifier - the Job Stream Identifier

setJobStreamKey

public void setJobStreamKey(JobStreamInPlanKey key)
Sets the Job Stream Key For Internal use only.

Parameters:
key - the Job Stream Key

setQuantity

public void setQuantity(int i)
Sets the quantity used bu holder. For internal use only.

Parameters:
i - the quantity used bu holder

getJobStreamInternalName

public java.lang.String getJobStreamInternalName()
Returns the job stream internal name For Internal Use Only.

Returns:
the job stream internal name

setJobStreamInternalName

public void setJobStreamInternalName(java.lang.String string)
Sets the job stream internal name For Internal use only.

Parameters:
string - the job stream internal name


Copyright © 2005 IBM All Rights Reserved.