|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.tws.objects.plan.PromptInPlan
This simple object, which has no header, models all available types of prompts (predefined, ad-hoc or recovery), and wraps a PromptKey, including only the prompt name. If the prompt is not a global prompt, reference either to the job (JobInPlanKey) or to the job stream (JobStreamInPlanKey) that uses it are provided. Furthermore (optionally) a link to the Workstation where the Prompt is defined is given.
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. | |
workstationKey | If present, reference to an existing Workstation |
jobKey | If present, reference to an existing Job |
jobStreamKey | If present, reference to an existing Job Stream |
number | Read Only. |
text | Read Only. |
type | Read Only. |
status | Read Only. |
timeAsked | Read Only. |
timeRespond | Read Only. |
JobInPlanKey
,
JobStreamInPlanKey
,
PromptInPlanKey
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
COPYRIGHT
Copyright |
Constructor Summary | |
---|---|
PromptInPlan()
Creates an empty Prompt. |
|
PromptInPlan(Identifier id)
Creates a Prompt Containing an Identifier |
|
PromptInPlan(Identifier id,
PromptInPlanKey key)
Creates a Prompt containing an Identifier and a Key |
|
PromptInPlan(PromptInPlanKey key)
Creates a Prompt containing a key |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object object)
equality method. |
Identifier |
getId()
Returns the PromptInPlan identifier. |
Identifier |
getJobId()
Return the Identifier of the referenced job. |
JobInPlanKey |
getJobKey()
Return the Key of the referenced job. |
Identifier |
getJobStreamId()
Returns the Identifier of the referenced Job Stream |
JobStreamInPlanKey |
getJobStreamKey()
Returns the key of the referenced Job Stream |
PromptInPlanKey |
getKey()
Return the key of this PromptInPlan object. |
LockData |
getLockData()
Returns the PromptInPlan LockData. |
ModifyData |
getModifyData()
Returns the PromptInPlan ModifyData. |
java.lang.String |
getName()
Return the name of this PromptInPlan object. |
int |
getNumber()
Returns the prompt number. |
TWSHeader |
getObjectHeader()
Returns the PromptInPlan header, as a TWSHeader. |
TWSKey |
getObjectKey()
Returns the PromptInPlan key, as a TWSKey |
PromptStatusType |
getStatus()
Returns the Status of this Prompt. |
java.lang.String |
getText()
Return the Text of this Prompt |
java.util.Date |
getTimeAsked()
Return the Date this prompt has been asked |
java.util.Date |
getTimeRespond()
Return the Date this Prompt has been answered. |
PromptType |
getType()
Returns the type of this prompt. |
Identifier |
getWorkstationId()
Return the Identifier of the referenced Workstation. |
WorkstationInPlanKey |
getWorkstationKey()
Return the key of the referenced Workstation. |
int |
hashCode()
Returns a hash code for this PromptInPlan object. |
void |
setId(Identifier identifier)
Sets the Prompt Identifier For Internal Use only |
void |
setJobId(Identifier identifier)
Sets the referenced Job Identifier. |
void |
setJobKey(JobInPlanKey key)
Sets the referenced Job Key. |
void |
setJobStreamId(Identifier identifier)
Sets the referenced Job Stream Identifier. |
void |
setJobStreamKey(JobStreamInPlanKey key)
Sets the referenced Job Stream key For internal use only. |
void |
setKey(PromptInPlanKey key)
Sets the Prompt key. |
void |
setName(java.lang.String name)
Sets the name of this PromptInPlan object. |
void |
setNumber(int i)
Sets the prompt number. |
void |
setStatus(PromptStatusType type)
Sets the status of the Prompt. |
void |
setText(java.lang.String string)
Sets the Text of this Prompt. |
void |
setTimeAsked(java.util.Date date)
Sets the Date this prompt has been asked. |
void |
setTimeRespond(java.util.Date date)
Sets the Date this prompt has been answered. |
void |
setType(PromptType type)
Sets the type of this Prompt. |
void |
setWorkstationId(Identifier identifier)
Sets the referenced Workstation Identifier. |
void |
setWorkstationKey(WorkstationInPlanKey key)
Sets the referenced Workstation Key. |
java.lang.String |
toString()
Returns a string representation of this PromptInPlan. |
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 PromptInPlan()
public PromptInPlan(Identifier id, PromptInPlanKey key)
id
- PromptInPlan Identifier.key
- PromptInPlan key.public PromptInPlan(Identifier id)
id
- PromptInPlan Identifier.public PromptInPlan(PromptInPlanKey key)
key
- PromptInPlan key.Method Detail |
public Identifier getId()
getId
in interface TWSObject
public TWSKey getObjectKey()
getObjectKey
in interface TWSObject
public TWSHeader getObjectHeader()
getObjectHeader
in interface TWSObject
public ModifyData getModifyData()
getModifyData
in interface TWSObject
public LockData getLockData()
getLockData
in interface TWSObject
public java.lang.String getName()
getName
in interface TWSObject
TWSObject.getName()
public void setName(java.lang.String name)
name
- the name of this PromptInPlan object.public Identifier getJobId()
public JobInPlanKey getJobKey()
public PromptInPlanKey getKey()
public int getNumber()
public PromptStatusType getStatus()
public java.lang.String getText()
public java.util.Date getTimeAsked()
public java.util.Date getTimeRespond()
public Identifier getWorkstationId()
public WorkstationInPlanKey getWorkstationKey()
public void setId(Identifier identifier)
identifier
- The prompt Identifier.public void setJobId(Identifier identifier)
identifier
- The Job Identifier.public void setJobKey(JobInPlanKey key)
key
- The Job key.public void setKey(PromptInPlanKey key)
key
- The prompt key.public void setNumber(int i)
i
- the prompt number.public void setStatus(PromptStatusType type)
type
- The status of the prompt.public void setText(java.lang.String string)
string
- the Text of this Prompt.public void setTimeAsked(java.util.Date date)
date
- the Date this prompt has been asked.public void setTimeRespond(java.util.Date date)
date
- the Date this prompt has been answered.public void setWorkstationId(Identifier identifier)
identifier
- the Workstation Identifier.public void setWorkstationKey(WorkstationInPlanKey key)
key
- The Workstation key.public boolean equals(java.lang.Object object)
object
- The object to be compared
public int hashCode()
public java.lang.String toString()
public Identifier getJobStreamId()
public JobStreamInPlanKey getJobStreamKey()
public PromptType getType()
public void setJobStreamId(Identifier identifier)
identifier
- The Job Stream Identifeirpublic void setJobStreamKey(JobStreamInPlanKey key)
key
- the Job Stream Key.public void setType(PromptType type)
type
- the Prompt type.
|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |