|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.tws.objects.plan.ResourceInPlan
The ResourceInPlan object, representing a TWS logical resource wraps a ResourceKey, which references the target workstation through a WorkstationInPlanKey.
The following syntax validation constraints must be met on ResourceInPlan objects in distributed environment:
name | Name of an existing plan resource. |
workstationKey | Reference to an existing workstation |
description | N/A |
availableResources | Value between 0 and 1024. Default is 0. |
usedResources | Read Only. Value between 0 and 1024. |
holders | List of ResourceHolderInPlan class. |
Read Only. | |
status | One of the memebers of ResourceStatusType class |
Read Only. |
The following syntax validation constraints must be met on ResourceInPlan objects in zOS environment:
name | Always required |
Not longer than 44 characters | |
description | Not longer than 46 characters |
resourceAvailabilityIntervals | List of ResourceInPlanAvailabilityInterval |
See ResourceInPlanAvailabilityInterval for constraints on this field | |
defaultConstraints | List of ResourceInPlanConstraints |
See ResourceInPlanConstraints for constraints on this field | |
status | Output only. Return one of the values defined in ResourceStatusType class |
workstationKey | N/A |
availableResources | N/A |
usedResources | N/A |
holders | N/A |
com.ibm.tws.objects.plan.types.ResourceInPlanAvailabilityInterval;
,
com.ibm.tws.objects.plan.types.ResourceInPlanConstraints;
,
com.ibm.tws.objects.plan.types.ResourceStatusType;
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
COPYRIGHT
Copyright. |
Constructor Summary | |
---|---|
ResourceInPlan()
Empty Constructor |
|
ResourceInPlan(Identifier id)
Constructor. |
|
ResourceInPlan(Identifier id,
ResourceInPlanKey key)
Constructor. |
|
ResourceInPlan(ResourceInPlanKey key)
Constructor. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object object)
equality method. |
int |
getAvailableResources()
Returns the number of available resources. |
ResourceInPlanConstraints |
getDefaultConstraints()
z/OS only method. |
java.lang.String |
getDescription()
Returns the Resource description. |
java.util.List |
getHolders()
Returns the list of ResourceHolderInPlan (i.e. |
Identifier |
getId()
Returns the Resource Identifier |
ResourceInPlanKey |
getKey()
Returns the Resource key |
LockData |
getLockData()
Return the object's LockData. |
ModifyData |
getModifyData()
Return the object's ModifyData. |
java.lang.String |
getName()
Returns the Resource Name |
int |
getNumberOfAvailaibilityIntervals()
z/OS only method. |
TWSHeader |
getObjectHeader()
Returns the object's header. |
TWSKey |
getObjectKey()
Returns the object's key. |
java.util.List |
getResourceInPlanAvailaibilityIntervals()
z/OS only method. |
ResourceStatusType |
getStatus()
Returns the resource status Valid values are: Available, Not Avaliable, Undecided. |
int |
getUsedResources()
Returns the number of used resources |
Identifier |
getWorkstationId()
Returns the referenced Workstation Identifier. |
WorkstationInPlanKey |
getWorkstationKey()
Returns the Resource Workstation key. |
int |
hashCode()
Returns a hash code for this ResourceInPlan object. |
void |
setAvailableResources(int i)
Sets the number of available resources. |
void |
setDefaultConstraints(ResourceInPlanConstraints constraints)
Sets the default resource constraints. |
void |
setDescription(java.lang.String description)
Sets the Resource description |
void |
setHolders(java.util.List list)
Deprecated. |
void |
setId(Identifier identifier)
Sets the Resource Ientifier. |
void |
setKey(ResourceInPlanKey key)
Sets the Resource Key. |
void |
setModifyData(ModifyData modData)
z/OS specific method For internal use only. |
void |
setName(java.lang.String name)
Sets the Resource key name. |
void |
setStatus(ResourceStatusType type)
Sets the Resource status For internal use only. |
void |
setUsedResources(int i)
Sets the number of used Resources For internal use only. |
void |
setWorkstationId(Identifier identifier)
The Identifier of the referenced Workstation. |
void |
setWorkstationKey(WorkstationInPlanKey key)
Sets the Workstation key. |
java.lang.String |
toString()
Returns a string representation of this ResourceInPlan. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final java.lang.String COPYRIGHT
Constructor Detail |
public ResourceInPlan()
public ResourceInPlan(Identifier id)
id
- The Resource Identifierpublic ResourceInPlan(ResourceInPlanKey key)
key
- The Resource keypublic ResourceInPlan(Identifier id, ResourceInPlanKey key)
id
- The Resource Identifierkey
- The Resource keyMethod Detail |
public Identifier getId()
getId
in interface TWSObject
TWSHeader.getId()
public java.lang.String getName()
getName
in interface TWSObject
TWSHeader.getName()
public void setName(java.lang.String name)
name
- the Resource Key name.public TWSKey getObjectKey()
getObjectKey
in interface TWSObject
TWSHeader.getObjectKey()
public WorkstationInPlanKey getWorkstationKey()
public TWSHeader getObjectHeader()
getObjectHeader
in interface TWSObject
TWSObject.getObjectHeader()
public ModifyData getModifyData()
getModifyData
in interface TWSObject
TWSHeader.getModifyData()
public LockData getLockData()
getLockData
in interface TWSObject
TWSHeader.getLockData()
public int getAvailableResources()
public java.util.List getHolders()
public ResourceInPlanKey getKey()
public int getUsedResources()
public Identifier getWorkstationId()
public void setAvailableResources(int i)
i
- the number of available resources.public ResourceStatusType getStatus()
public java.lang.String getDescription()
public ResourceInPlanConstraints getDefaultConstraints()
public java.util.List getResourceInPlanAvailaibilityIntervals()
public int getNumberOfAvailaibilityIntervals()
public void setId(Identifier identifier)
identifier
- public void setHolders(java.util.List list)
list
- the new Resource Holders list.public void setKey(ResourceInPlanKey key)
key
- the Resource key.public void setWorkstationKey(WorkstationInPlanKey key)
key
- The workstation key.public void setUsedResources(int i)
i
- The number of used Resources.public void setWorkstationId(Identifier identifier)
identifier
- The Workstation Identifier.public void setStatus(ResourceStatusType type)
type
- the Resource status.public void setDescription(java.lang.String description)
description
- The description to set.public void setDefaultConstraints(ResourceInPlanConstraints constraints)
constraints
- The default resource constraints.public void setModifyData(ModifyData modData)
modData
- the new modify Data.public boolean equals(java.lang.Object object)
object
- the object to be compared.
public int hashCode()
public java.lang.String toString()
|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |