com.oakgrovesystems.reactor.processMediation
Class Operand

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

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

Operand objects encapsulate arbitrary data that is relevant to the business process that a Process is being used to model. Examples include a document URL or a purchase order number.

See Also:
Serialized Form

Field Summary
protected  com.oakgrovesystems.reactor.processMediation.ACL acl
           
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  java.lang.String operand_value
           
protected  com.oakgrovesystems.reactor.ReactorObjectId process
           
protected  boolean visible_in_entire_subtree
           
 
Constructor Summary
Operand()
          Creates a new Operand and sets it 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()
          gets the scope of this Operand
 java.lang.String getValue()
          get the value of this Operand
 boolean sameAs(java.lang.Object o)
          compares two Operands 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 visibleInEntireSubtree)
          Sets the scop eof this Operand
 void setValue(java.lang.String operandValue)
          Sets the value of this Operand
 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

visible_in_entire_subtree

protected boolean visible_in_entire_subtree

operand_value

protected java.lang.String operand_value

process

protected com.oakgrovesystems.reactor.ReactorObjectId process

metaDataString

protected java.lang.String metaDataString

metaDataParser

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

Operand

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

Method Detail

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()
gets the scope of this Operand

Returns:
true if this Operand can be accessed from any Policy in the subtree of the Process with which it is associated. false if it can only be accessed from Policies associated with the same Process.

getValue

public java.lang.String getValue()
get the value of this Operand

Returns:
the value of this Operand

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.

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 visibleInEntireSubtree)
Sets the scop eof this Operand

Parameters:
visibleInEntireSubtree - true if this Operand can be accessed from any Policy in the subtree of the Process with which it is associated. false if it can only be accessed from Policies associated with the same Process.

setValue

public void setValue(java.lang.String operandValue)
Sets the value of this Operand

Parameters:
operandValue - the new value of this Operand

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.

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 Operands for content equality

Parameters:
o - the Operand to compare for content equality
Returns:
a boolean indicating if the Operands 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.