|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.tws.objects.plan.PromptDependencyInPlan
Prompt dependencies for jobs and job streams are represented through multiple instances of the PromptDependencyInPlan class, each one referencing a PromptInPlanKey object. Dependencies from predefined prompts and ad-hoc prompts are both represented by instances of PromptDependencyInPlan. You can understand which of them belongs on each type analyzing the attribute 'type'.
The following syntax validation constraints must be met on PromptDependencyInPlan objects:
name | For predefined prompts: |
The name of an existing predefined prompt. | |
For ad-hoc prompt: | |
The number assigned to the ad-hoc prompt. | |
Adding dependencies, if the dependency is | |
from a predefined prompt, the correct value should be used. | |
else if it is from a new ad-hoc prompt this field should. | |
be left null. | |
text | Not longer than 200 characters. |
Required for prompt ad-hoc. | |
satisfied | Read Only. |
status | Read Only. |
workstationKey | If present must reference to an existing Workstation |
number | Read Only. |
type | Required. No default provided. |
promptStatus | Read Only.. |
FileInPlan
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
COPYRIGHT
Copyright |
Constructor Summary | |
---|---|
PromptDependencyInPlan()
Creates an empty Prompt. |
|
PromptDependencyInPlan(Identifier id)
Creates a Prompt Containing an Identifier |
|
PromptDependencyInPlan(Identifier id,
PromptInPlanKey key)
Creates a Prompt containing an Identifier and a Key |
|
PromptDependencyInPlan(PromptInPlanKey key)
Creates a Prompt containing a key |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object object)
equality method. |
Identifier |
getId()
Returns the PromptInPlan identifier. |
PromptInPlanKey |
getKey()
Return the PromptInPlan key |
java.lang.String |
getName()
Returns the name of the PromptInPlan object. |
int |
getNumber()
Return the PromptInPlan number |
PromptStatusType |
getPromptStatus()
Returns the Status of the prompt. |
DependencyStatusType |
getStatus()
Return the dependency status. |
java.lang.String |
getText()
Return the text of the prompt |
PromptType |
getType()
Returns the Type of this prompt. |
Identifier |
getWorkstationId()
Return the Identifier of the (optional) Workstation pointed by this dependency |
WorkstationInPlanKey |
getWorkstationKey()
Returns the Key of the (optional) Workstation pointed by this dependency |
int |
hashCode()
Returns a hash code for this prompt object. |
boolean |
isLoadedFromDb()
Return if this prompt has been loaded from the DB or not. |
boolean |
isSatisfied()
Returns true if this dependency is satisfied, false otherwise |
void |
setId(Identifier identifier)
Sets the Identifier of the PromptInPlan object |
void |
setKey(PromptInPlanKey key)
Sets the PromptInPlan key For internal use only. |
void |
setLoadedFromDb(boolean b)
Sets if this prompt has been loaded from the DB or not. |
void |
setNumber(int i)
Sets the PromptInPlan number For internal use only. |
void |
setPromptStatus(PromptStatusType type)
Sets the status of the prompt. |
void |
setSatisfied(boolean b)
Sets if this dependency is satisfied or not. |
void |
setStatus(DependencyStatusType type)
Sets the dependency status. |
void |
setText(java.lang.String string)
Sets the text of the PromptInPlan object. |
void |
setType(PromptType type)
Sets the type of the prompt Possible values are: Local, Global, Restart. |
void |
setWorkstationId(Identifier identifier)
Sets The Identifier of the (optional) Workstation |
void |
setWorkstationKey(WorkstationInPlanKey key)
Sets The key of the (optional) Workstation For internal use only. |
java.lang.String |
toString()
Returns a string representation of this PromptDependencyInPlan. |
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 PromptDependencyInPlan()
public PromptDependencyInPlan(Identifier id, PromptInPlanKey key)
id
- The PromptInPlan Identifier.key
- The PromptInPlan keypublic PromptDependencyInPlan(Identifier id)
id
- The PromptInPlan Identifierpublic PromptDependencyInPlan(PromptInPlanKey key)
key
- The PromptInPlan keyMethod Detail |
public Identifier getId()
getId
in interface TWSLink
TWSLink.getId()
public java.lang.String getName()
TWSObject.getName()
public PromptInPlanKey getKey()
public int getNumber()
public DependencyStatusType getStatus()
public java.lang.String getText()
public Identifier getWorkstationId()
public WorkstationInPlanKey getWorkstationKey()
public void setId(Identifier identifier)
identifier
- The PromptInPlan Identifierpublic void setKey(PromptInPlanKey key)
key
- The PromptInPlan keypublic void setNumber(int i)
i
- the PromptInPlan number.public void setStatus(DependencyStatusType type)
type
- The dependency status.public void setText(java.lang.String string)
string
- the text of the PromptInPlan object.public void setWorkstationId(Identifier identifier)
identifier
- The workstation Identifier.public void setWorkstationKey(WorkstationInPlanKey key)
key
- The Workstation keypublic boolean equals(java.lang.Object object)
object
- The object to be compared
public int hashCode()
public java.lang.String toString()
public boolean isSatisfied()
public PromptType getType()
public void setSatisfied(boolean b)
b
- true if satisfied, false otherwise.public void setType(PromptType type)
type
- The type of the prompt.public PromptStatusType getPromptStatus()
public void setPromptStatus(PromptStatusType type)
type
- The status of the prompt.public boolean isLoadedFromDb()
public void setLoadedFromDb(boolean b)
b
- true if this prompt has been loaded from the DB,
false otherwise.
|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |