com.ibm.tws.objects.plan
Class InternetworkDependencyInPlan

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

public class InternetworkDependencyInPlan
extends java.lang.Object
implements TWSLink

Internetwork dependencies plan associations of jobs or job streams from targets in a remote TWS network. Since they can model dependencies in a very general way, a string (dependency) is used to represent the dependency targets in place of the names of the remote job stream, job and worskation that may be involved in the dependency. In addition to this general-purpose value, the agent workstation that is responsible for the connection to the remote network is also specified.

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

networkAgentKey Must reference an existing workstation
dependency Always required
Not longer than 255 characters
status Output Only.
internalStatus Output Only.
satisfied Output Only.

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright
 
Constructor Summary
InternetworkDependencyInPlan()
          Creates an empty InternetworkDependencyInPlan.
InternetworkDependencyInPlan(Identifier id)
          Creates an InternetworkDependencyInPlan, specifying the identifier of the referenced network agent.
InternetworkDependencyInPlan(Identifier id, WorkstationInPlanKey key)
          Creates an InternetworkDependencyInPlan, specifying the identifier and key of the referenced network agent.
InternetworkDependencyInPlan(WorkstationInPlanKey key)
          Creates an InternetworkDependencyInPlan, specifying the key of the referenced network agent.
 
Method Summary
 boolean equals(java.lang.Object object)
          Returns true if all fields of this InternetworkDependencyInPlan object are equal to those of the given one.
 java.lang.String getDependency()
          Returns the String representing the real 'dependency'
 Identifier getId()
          Returns the Identifier of the Network Agent.
 FlowNodeInternalStatusType getInternalStatus()
          Returns the Internal Status of the Job/ Job Stream
 Identifier getNetworkAgentId()
          Returns the Identifier of the Network Agent.
 WorkstationInPlanKey getNetworkAgentKey()
          Returns the key of the Network Agent.
 DependencyStatusType getStatus()
          Return the status of this dependency.
 int hashCode()
          Returns a hash code for this InternetworkDependencyInPlan object.
 boolean isSatisfied()
          Returns true if this dependency is satisfied, false otherwise
 void setDependency(java.lang.String string)
          Sets the real 'dependency' of this dependency object.
 void setInternalStatus(FlowNodeInternalStatusType type)
          Sets the Internal Status of the internetwork dependency For internal use only
 void setNetworkAgentId(Identifier identifier)
          Sets the Identifier of the Network Agent.
 void setNetworkAgentKey(WorkstationInPlanKey key)
          Sets the key of the Network Agent.
 void setSatisfied(boolean b)
          Sets if this dependency is satisfied or not.
 void setStatus(DependencyStatusType type)
          Sets the status of this dependency.
 java.lang.String toString()
          Returns a string representation of this InternetworkDependencyInPlan.
 
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

InternetworkDependencyInPlan

public InternetworkDependencyInPlan()
Creates an empty InternetworkDependencyInPlan.


InternetworkDependencyInPlan

public InternetworkDependencyInPlan(Identifier id)
Creates an InternetworkDependencyInPlan, specifying the identifier of the referenced network agent.

Parameters:
id - The identifier of the referenced network agent.

InternetworkDependencyInPlan

public InternetworkDependencyInPlan(WorkstationInPlanKey key)
Creates an InternetworkDependencyInPlan, specifying the key of the referenced network agent.

Parameters:
key - The key of the referenced network agent.

InternetworkDependencyInPlan

public InternetworkDependencyInPlan(Identifier id,
                                    WorkstationInPlanKey key)
Creates an InternetworkDependencyInPlan, specifying the identifier and key of the referenced network agent.

Parameters:
id - The identifier of the referenced network agent.
key - The key of the referenced network agent.
Method Detail

equals

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

Returns:
The object's hash code.

toString

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

Returns:
A text string including all InternetworkDependencyInPlan fields.

getStatus

public DependencyStatusType getStatus()
Return the status of this dependency. Valid statuses are: Satisfied, Unsatisfied, Undecided.

Returns:
the status of this dependency.

setStatus

public void setStatus(DependencyStatusType type)
Sets the status of this dependency. For Internal Use only.

Parameters:
type - the status of this dependency.

getDependency

public java.lang.String getDependency()
Returns the String representing the real 'dependency'

Returns:
a String containing the real 'dependency'.

getNetworkAgentId

public Identifier getNetworkAgentId()
Returns the Identifier of the Network Agent.

Returns:
the Identifier of the Network Agent.

getNetworkAgentKey

public WorkstationInPlanKey getNetworkAgentKey()
Returns the key of the Network Agent.

Returns:
the key of the Network Agent.

setDependency

public void setDependency(java.lang.String string)
Sets the real 'dependency' of this dependency object.

Parameters:
string - the real 'dependency' of this object.

setNetworkAgentId

public void setNetworkAgentId(Identifier identifier)
Sets the Identifier of the Network Agent.

Parameters:
identifier - the Identifier of the Network Agent.

setNetworkAgentKey

public void setNetworkAgentKey(WorkstationInPlanKey key)
Sets the key of the Network Agent.

Parameters:
key - the key of the Network Agent.

getId

public Identifier getId()
Returns the Identifier of the Network Agent.

Specified by:
getId in interface TWSLink
Returns:
the Identifier of the Network Agent.
See Also:
TWSLink.getId()

isSatisfied

public boolean isSatisfied()
Returns true if this dependency is satisfied, false otherwise

Returns:
true if this dependency is satisfied, false otherwise

setSatisfied

public void setSatisfied(boolean b)
Sets if this dependency is satisfied or not. For internal use only.

Parameters:
b - true if satisfied, false otherwise.

setInternalStatus

public void setInternalStatus(FlowNodeInternalStatusType type)
Sets the Internal Status of the internetwork dependency For internal use only

Parameters:
type - The flow node status to set

getInternalStatus

public FlowNodeInternalStatusType getInternalStatus()
Returns the Internal Status of the Job/ Job Stream

Returns:
the Internal Status of the Job/ Job Stream


Copyright © 2005 IBM All Rights Reserved.