|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.tws.objects.plan.ResourceDependencyInPlan
Resource dependencies are represented for a job or job stream through multiple instances of this class, which references the resource on which the job or job stream depends, and allows defining a quantity attribute. This quantity does not have to be the same as the quantity stored on the referenced resource, because it acts as an attribute of the association between a job or job stream and the resource on which it depends. The quantity actually available is stored in the 'available attribute.
The following syntax validation constraints must be met on ResourceDependency objects:
resourceKey | Reference to an existing resource |
quantity | Allowed range is from 1 to 1024 during submit, |
from 1 to 32 during dependency addiction. | |
availableQuantity | Read Only. |
Read Only. | |
satisfied | Read Only. |
status | Read Only. |
allocationType | N/A |
onError | N/A |
actionOnComplete | One of the values exposed by the ResourceActionOnComplete class |
totalQuantity | For Internal Use Only |
loadedFromDB | For Internal Use Only |
OnErrorOption
,
ResourceAllocationType
,
ResourceInPlan
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
COPYRIGHT
Copyright. |
Constructor Summary | |
---|---|
ResourceDependencyInPlan()
Creates an empty resource. |
|
ResourceDependencyInPlan(Identifier id)
Creates a resource Containing an Identifier |
|
ResourceDependencyInPlan(Identifier id,
ResourceInPlanKey key)
Creates a resource containing an Identifier and a Key |
|
ResourceDependencyInPlan(ResourceInPlanKey key)
Creates a Resource containing a key |
Method Summary | |
---|---|
java.lang.Object |
clone()
Clone method, used to create from a single Dependency with quantity > 32 multiple instance of the same Dependency with quantity <= 32. |
boolean |
equals(java.lang.Object object)
equality method. |
ResourceActionOnComplete |
getActionOnComplete()
Returns the actionOnComplete. |
ResourceAllocationType |
getAllocationType()
Returns the resource allocation type. |
int |
getAvailable()
Returns the number of available Resources for this dependency. |
Identifier |
getId()
Returns the object Identifier. |
ResourceInPlanKey |
getKey()
Returns the Resource key |
java.lang.String |
getName()
Returns the Resource name |
OnErrorOption |
getOnError()
Returns the on error option. |
int |
getQuantity()
Returns the number of units currently in use. |
DependencyStatusType |
getStatus()
Returns the dependency status. |
int |
getTotalQuantity()
Returns the total quantity of the Resource, not of the Resource Dependency. |
Identifier |
getWorkstationId()
Return the referenced Workstation Identifier |
int |
hashCode()
Returns a hash code for this resource dependency object. |
boolean |
isLoadedFromDb()
Gets if this Dependency is loaded from the DB or not For internal use only. |
boolean |
isSatisfied()
Returns true if this dependency is satisfied, false otherwise. |
void |
setActionOnComplete(ResourceActionOnComplete value)
|
void |
setAllocationType(ResourceAllocationType value)
Sets the resource allocation type. |
void |
setAvailable(int i)
Sets the number of availbale resources |
void |
setId(Identifier identifier)
Sets the Resource Identifier |
void |
setKey(ResourceInPlanKey key)
Sets the Resource key |
void |
setLoadedFromDb(boolean b)
Sets if this Dependency is loaded from DB or not. |
void |
setOnError(OnErrorOption value)
Sets the on error option. |
void |
setQuantity(int i)
Set the Resource quantity For internal use only. |
void |
setSatisfied(boolean b)
Sets if this dependency is satisfied For internal use only. |
void |
setStatus(DependencyStatusType value)
Sets the dependency status For internal use only. |
void |
setTotalQuantity(int i)
Sets the total quantity of the Resource, not of the Resource Dependency. |
void |
setWorkstationId(Identifier identifier)
Sets the Resource Workstation Identifier |
java.lang.String |
toString()
Returns a string representation of this ResourceDependencyInPlan. |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final java.lang.String COPYRIGHT
Constructor Detail |
public ResourceDependencyInPlan()
public ResourceDependencyInPlan(Identifier id, ResourceInPlanKey key)
id
- The Resource Identifierkey
- The ResourceKeypublic ResourceDependencyInPlan(Identifier id)
id
- The Resource Identifierpublic ResourceDependencyInPlan(ResourceInPlanKey key)
key
- The Resource keyMethod Detail |
public Identifier getId()
getId
in interface TWSLink
public java.lang.String getName()
TWSObject.getName()
public ResourceInPlanKey getKey()
public Identifier getWorkstationId()
public int getAvailable()
public int getQuantity()
public boolean isSatisfied()
public DependencyStatusType getStatus()
public ResourceAllocationType getAllocationType()
public OnErrorOption getOnError()
public ResourceActionOnComplete getActionOnComplete()
public void setId(Identifier identifier)
identifier
- the Resource Identifierpublic void setKey(ResourceInPlanKey key)
key
- the Resource Identifierpublic void setWorkstationId(Identifier identifier)
identifier
- the Resource Workstation Identifierpublic void setAvailable(int i)
i
- the number of availbale resourcespublic void setQuantity(int i)
i
- the Resource quantitypublic void setActionOnComplete(ResourceActionOnComplete value)
public void setSatisfied(boolean b)
b
- true if this dependency is satisfiedpublic void setStatus(DependencyStatusType value)
value
- the dependency statuspublic void setAllocationType(ResourceAllocationType value)
value
- The resource allocation type.public void setOnError(OnErrorOption value)
value
- The on error option.public boolean equals(java.lang.Object object)
object
- The object to be compared
public int hashCode()
public java.lang.String toString()
public int getTotalQuantity()
public void setTotalQuantity(int i)
i
- the total quantity of the Resource, not of the Resource Dependency.public boolean isLoadedFromDb()
public void setLoadedFromDb(boolean b)
b
- true if this Dependency is loaded from DB, false otherwise.public java.lang.Object clone() throws java.lang.CloneNotSupportedException
java.lang.CloneNotSupportedException
- if the operation is not supported.Object.clone()
|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |