com.ibm.tws.objects.model
Class PromptDependency

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

public class PromptDependency
extends java.lang.Object
implements TWSLink

Prompt dependencies for jobs and job streams are represented through multiple instances of the PromptDependency class, each one referencing a Prompt object. Dependencies from predefined prompts and ad-hoc prompts are both represented by instances of PromptDependency, but reference prompts of different types.

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

prompt Must be either an ad-hoc prompt or an existing predefined prompt

See Also:
Prompt, Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
 
Constructor Summary
PromptDependency()
          Creates an empty PromptDependency.
PromptDependency(Identifier id)
          Creates a PromptDependency, specifying the identifier of the referenced prompt.
PromptDependency(Prompt target)
          Creates a PromptDependency, specifying the referenced prompt.
 
Method Summary
 boolean equals(java.lang.Object object)
          Returns true if all fields of this PromptDependency object are equal to those of the given one.
 Identifier getId()
          Returns the identifier of the prompt referenced by this dependency.
 Prompt getPrompt()
          Returns the referenced prompt.
 Identifier getPromptId()
          Returns the identifier of the referenced prompt.
 int hashCode()
          Returns a hash code for this PromptDependency object.
 boolean isAdHoc()
          Returns true if the referenced prompt is an ad-hoc one.
 void setAdHoc(boolean value)
          Sets the property used to decide if the referenced prompt is an ad-hoc one.
 void setPrompt(Prompt target)
          Sets the referenced prompt.
 void setPromptId(Identifier id)
          Sets the identifier of the referenced prompt.
 java.lang.String toString()
          Returns a string representation of this PromptDependency object.
 
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

PromptDependency

public PromptDependency()
Creates an empty PromptDependency.


PromptDependency

public PromptDependency(Identifier id)
Creates a PromptDependency, specifying the identifier of the referenced prompt.

Parameters:
id - The identifier of the referenced prompt.

PromptDependency

public PromptDependency(Prompt target)
Creates a PromptDependency, specifying the referenced prompt.

Parameters:
target - The referenced prompt.
Method Detail

getId

public Identifier getId()
Returns the identifier of the prompt referenced by this dependency.

Specified by:
getId in interface TWSLink
Returns:
The identifier of the prompt referenced by this dependency.

getPromptId

public Identifier getPromptId()
Returns the identifier of the referenced prompt.

Returns:
The identifier of the referenced prompt.

getPrompt

public Prompt getPrompt()
Returns the referenced prompt.

Returns:
The referenced prompt.

isAdHoc

public boolean isAdHoc()
Returns true if the referenced prompt is an ad-hoc one.

Returns:
True if the referenced prompt is an ad-hoc one.

setPromptId

public void setPromptId(Identifier id)
Sets the identifier of the referenced prompt.

Parameters:
id - The identifier of the referenced prompt.

setPrompt

public void setPrompt(Prompt target)
Sets the referenced prompt.

Parameters:
target - The referenced prompt.

setAdHoc

public void setAdHoc(boolean value)
Sets the property used to decide if the referenced prompt is an ad-hoc one.

Parameters:
value - True if the referenced prompt is an ad-hoc one.

equals

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

Returns:
The object's hash code.

toString

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

Returns:
A text string including all PromptDependency fields.


Copyright © 2005 IBM All Rights Reserved.