javawebparts.misc.chain
Class ChainContext

java.lang.Object
  |
  +--javawebparts.misc.chain.ChainContext

public class ChainContext
extends java.lang.Object

This class represents a ChainContext.

Author:
Frank W. Zammetti.

Field Summary
private  java.util.Map attributes
          The collection of attributes in this context instance.
private  java.lang.String catalogID
          The ID of the Catalog the currently executing Chain that this context is being used by belongs to.
private  java.lang.String chainID
          The ID of the Chain that is currently executing that this context is being used by.
private  Result result
          The result of the Chain execution that this context is being used by.
 
Constructor Summary
ChainContext()
           
 
Method Summary
 java.lang.Object getAttribute(java.lang.String inKey)
          Gets an attribute from the context.
 java.lang.String getCatalogId()
          Getter for the ID of the Catalog this context is being used to service.
 java.lang.String getChainId()
          Getter for the ID of the Chain this context is being used to service.
 Result getResult()
          Gets the result of the Chain execution that this context is being used by.
 void setAttribute(java.lang.String inKey, java.lang.Object inAttribute)
          Sets an attribute in the context.
 void setCatalogId(java.lang.String inCatalogID)
          Setter for the ID of the Catalog this context is being used to service.
 void setChainId(java.lang.String inChainID)
          Setter for the ID of the Chain this context is being used to service.
 void setResult(Result inResult)
          Sets the result of the Chain execution that this context is being used by.
 java.lang.String toString()
          Overridden toString method.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

attributes

private java.util.Map attributes
The collection of attributes in this context instance.


catalogID

private java.lang.String catalogID
The ID of the Catalog the currently executing Chain that this context is being used by belongs to.


chainID

private java.lang.String chainID
The ID of the Chain that is currently executing that this context is being used by.


result

private Result result
The result of the Chain execution that this context is being used by.

Constructor Detail

ChainContext

public ChainContext()
Method Detail

setAttribute

public void setAttribute(java.lang.String inKey,
                         java.lang.Object inAttribute)
Sets an attribute in the context.

Parameters:
inKey - The key of the attribute to set.
inAttribute - The value of the attribute to set.

getAttribute

public java.lang.Object getAttribute(java.lang.String inKey)
Gets an attribute from the context.

Parameters:
inKey - The key of the attribute to get.
Returns:
The value of the attribute to get.

setCatalogId

public void setCatalogId(java.lang.String inCatalogID)
Setter for the ID of the Catalog this context is being used to service.

Parameters:
inCatalogID - The ID of the Catalog this context is being used to service.

getCatalogId

public java.lang.String getCatalogId()
Getter for the ID of the Catalog this context is being used to service.

Returns:
The ID of the Catalog this context is being used to service.

setChainId

public void setChainId(java.lang.String inChainID)
Setter for the ID of the Chain this context is being used to service.

Parameters:
inChainID - The ID of the Chain this Context is being used to service.

getChainId

public java.lang.String getChainId()
Getter for the ID of the Chain this context is being used to service.

Returns:
The ID of the Chain this Context is being used to service.

setResult

public void setResult(Result inResult)
Sets the result of the Chain execution that this context is being used by.

Parameters:
inResult - The Result object instance of the last Command (or subchain) that executed.

getResult

public Result getResult()
Gets the result of the Chain execution that this context is being used by.

Returns:
The Result object instance of the last Command (or subchain) that executed.

toString

public java.lang.String toString()
Overridden toString method.

Overrides:
toString in class java.lang.Object
Returns:
String representation of this bean.


Copyright 2005 Frank W. Zammetti