com.oakgrovesystems.reactor.processMediation
Class Status

java.lang.Object
  |
  +--com.oakgrovesystems.reactor.processMediation.Status
All Implemented Interfaces:
ProcessAssociatedObject, ProcessMediationObject, java.io.Serializable

public class Status
extends java.lang.Object
implements java.io.Serializable, ProcessAssociatedObject

Status objects are very simple objects used to trigger conditions in Process objects or cause the execution of Policy objects, as well as to generally provide information about how a process is progressing.

See Also:
Serialized Form

Field Summary
protected  com.oakgrovesystems.reactor.processMediation.ACL acl
           
protected  boolean availableToEntireSubtree
           
protected  java.lang.String description
           
protected  java.lang.String id
           
protected  java.lang.String label
           
protected  com.oakgrovesystems.reactor.processMediation.MetaDataParser metaDataParser
           
protected  java.lang.String metaDataString
           
protected  com.oakgrovesystems.reactor.ReactorObjectId process
           
 
Constructor Summary
Status()
          Creates a new Status and sets it Id
Status(java.lang.String id)
          Creates a new Status with the specified Id
 
Method Summary
 com.oakgrovesystems.reactor.processMediation.ProcessMediationObject copy()
          returns a deep copy of this ProcessMediationObject
 com.oakgrovesystems.reactor.processMediation.ACL getACL()
          gets the ACL of this ProcessMediationObject.
 java.lang.String getDescription()
          gets the desciption of this ProcessMediationObject.
 java.lang.String getId()
          gets the Id of this ProcessMediationObject.
 java.lang.String getLabel()
          set the desciption of this ProcessMediationObject.
 java.lang.String getMetaDataString()
           
 java.lang.String getMetaDataValue(java.lang.String key)
           
 com.oakgrovesystems.reactor.ReactorObjectId getProcess()
          Gets the ReactorObjectId of the Process object with which this ProcessAssociatedObject is associated.
 boolean getScope()
          A boolean indicating the scope of this Status
 boolean sameAs(java.lang.Object o)
          compares two Statuses for content equality
 void setACL(com.oakgrovesystems.reactor.processMediation.ACL acl)
          set the ACL of this ProcessMediationObject.
 void setDescription(java.lang.String description)
          set the desciption of this ProcessMediationObject.
 void setId(java.lang.String id)
          set the Id of this ProcessMediationObject.
 void setLabel(java.lang.String label)
          set the label of this ProcessMediationObject.
 void setMetaDataKeyValue(java.lang.String key, java.lang.String value)
           
 void setMetaDataString(java.lang.String s)
           
 void setProcess(com.oakgrovesystems.reactor.ReactorObjectId id)
          Associates this ProcessAssociatedObject with the Process object referred to by the ReactorObjectId procId.
 void setScope(boolean availableToEntireSubtree)
          sets the scope of this Status.
 java.lang.String toString()
          returns the label if it is not empty or null.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

id

protected java.lang.String id

label

protected java.lang.String label

description

protected java.lang.String description

acl

protected com.oakgrovesystems.reactor.processMediation.ACL acl

availableToEntireSubtree

protected boolean availableToEntireSubtree

process

protected com.oakgrovesystems.reactor.ReactorObjectId process

metaDataString

protected java.lang.String metaDataString

metaDataParser

protected com.oakgrovesystems.reactor.processMediation.MetaDataParser metaDataParser
Constructor Detail

Status

public Status()
Creates a new Status and sets it Id


Status

public Status(java.lang.String id)
Creates a new Status with the specified Id

Parameters:
id - The id of the Status
Method Detail

setId

public void setId(java.lang.String id)
set the Id of this ProcessMediationObject. Ids are used to uniquely identify objects in the Reactor system ids should be created using the com.oakgrovesystems.util.UniqueId class

Specified by:
setId in interface ProcessMediationObject
Parameters:
id - the Id of this ProcessMediationObject

setLabel

public void setLabel(java.lang.String label)
set the label of this ProcessMediationObject. Labels are short human-readable strings that can be used as an alternative to ids to identify a Process. All the objects associated with a Process should have unique labels.

Specified by:
setLabel in interface ProcessMediationObject
Parameters:
label - the label of this ProcessMediationObject

setDescription

public void setDescription(java.lang.String description)
set the desciption of this ProcessMediationObject. Desciptions are human readable text describing a Process. They are not used by internal Reactor functionality, but are included for use by Reactor clients.

Specified by:
setDescription in interface ProcessMediationObject
Parameters:
description - the description of this ProcessMediationObject

setACL

public void setACL(com.oakgrovesystems.reactor.processMediation.ACL acl)
set the ACL of this ProcessMediationObject. ACLs describe the relationships between ProcessMediationObjects and users of the Reactor system.

Specified by:
setACL in interface ProcessMediationObject
Parameters:
acl - the acl of this ProcessMediationObject

setScope

public void setScope(boolean availableToEntireSubtree)
sets the scope of this Status.

Parameters:
availableToEntireSubtree - true if the Status can be added to the current statuses of any Process in the subtree of the Process with which it is associated. false if it can only be added to the current statuses of the Process with which it is associated.

getId

public java.lang.String getId()
gets the Id of this ProcessMediationObject. Ids are used to uniquely identify objects in the Reactor system ids should be created using the com.oakgrovesystems.util.UniqueId class

Specified by:
getId in interface ProcessMediationObject
Returns:
the Id of this ProcessMediationObject

getLabel

public java.lang.String getLabel()
set the desciption of this ProcessMediationObject. Desciptions are human readable text describing a Process. They are not used by internal Reactor functionality, but are included for use by Reactor clients.

Specified by:
getLabel in interface ProcessMediationObject
Returns:
the label of this ProcessMediationObject

getDescription

public java.lang.String getDescription()
gets the desciption of this ProcessMediationObject. Desciptions are human readable text describing a Process. They are not used by internal Reactor functionality, but are included for use by Reactor clients.

Specified by:
getDescription in interface ProcessMediationObject
Returns:
the description of this ProcessMediationObject

getACL

public com.oakgrovesystems.reactor.processMediation.ACL getACL()
gets the ACL of this ProcessMediationObject. ACLs describe the relationships between ProcessMediationObjects and users of the Reactor system.

Specified by:
getACL in interface ProcessMediationObject
Returns:
the acl of this ProcessMediationObject

getScope

public boolean getScope()
A boolean indicating the scope of this Status

Returns:
true if the Status can be added to the current statuses of any Process in the subtree of the Process with which it is associated. false if it can only be added to the current statuses of the Process with which it is associated.

setProcess

public void setProcess(com.oakgrovesystems.reactor.ReactorObjectId id)
Associates this ProcessAssociatedObject with the Process object referred to by the ReactorObjectId procId.

Specified by:
setProcess in interface ProcessAssociatedObject
Parameters:
id - The id of the Process with which this ProcessAssociatedObject should be associated.

getProcess

public com.oakgrovesystems.reactor.ReactorObjectId getProcess()
Gets the ReactorObjectId of the Process object with which this ProcessAssociatedObject is associated.

Specified by:
getProcess in interface ProcessAssociatedObject
Returns:
The ReactorObjectId of the Process object with which this ProcessAssociatedObject is associated.

getMetaDataString

public java.lang.String getMetaDataString()

setMetaDataString

public void setMetaDataString(java.lang.String s)

getMetaDataValue

public java.lang.String getMetaDataValue(java.lang.String key)

setMetaDataKeyValue

public void setMetaDataKeyValue(java.lang.String key,
                                java.lang.String value)

copy

public com.oakgrovesystems.reactor.processMediation.ProcessMediationObject copy()
returns a deep copy of this ProcessMediationObject

Specified by:
copy in interface ProcessMediationObject
Returns:
a deep copy of this ProcessMediationObject

sameAs

public boolean sameAs(java.lang.Object o)
compares two Statuses for content equality

Parameters:
o - the Status to compare for content equality
Returns:
a boolean indicating if the Statuses are equal

toString

public java.lang.String toString()
returns the label if it is not empty or null. otherwise, returns the id

Overrides:
toString in class java.lang.Object
Returns:
the label if it is not empty or null. otherwise, returns the id


Copyright (c) 1999-2004 Oak Grove Systems. All Rights Reserved.