com.bea.wli.worklist.api
Class WorkSubstituteRule

java.lang.Object
  extended by com.bea.wli.worklist.api.WorkSubstituteRule
All Implemented Interfaces:
Serializable

public final class WorkSubstituteRule
extends Object
implements Serializable

This class defines a work substitution rule.

A rule is composed of:
- a unique id.
- an effective date that specifies when the rule takes effect. Null if it is always effective.
- an expiry date that specifies when the rule expires. Null if it never expires.
- a source that is the user/group to be substituted.
- a target that is the substitute user/group.

If the source is a user, the target must be a user; if the source is a group, the target must be a group.

When a task is assigned to a user, the worklist looks for an eventual substitute. The rules can be chained.

Since:
8.1
See Also:
Serialized Form

Field Summary
 int hashCode
           
 
Constructor Summary
WorkSubstituteRule()
           
WorkSubstituteRule(String workSubstituteRuleId, Date effectiveDate, Date expiryDate, String source, String target)
           
WorkSubstituteRule(WorkSubstituteRuleType ruleType)
           
 
Method Summary
 boolean equals(Object other)
           
 Date getEffectiveDate()
           
 Date getExpiryDate()
           
 String getSource()
           
 String getTarget()
           
 String getWorkSubstituteRuleId()
           
static WorkSubstituteRule[] getWorkSubstituteRulesArray(WorkSubstituteRulesDocument rulesDoc)
           
static WorkSubstituteRulesDocument getWorkSubstituteRulesDocument(WorkSubstituteRule[] rules)
           
static String getWorkSubstituteRulesXML(WorkSubstituteRule[] rules)
           
 int hashCode()
           
 void setEffectiveDate(Date effectiveDate)
           
 void setExpiryDate(Date expiryDate)
           
 void setSource(String source)
           
 void setTarget(String target)
           
 void toXML(WorkSubstituteRuleType ruleType)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

hashCode

public volatile int hashCode
Constructor Detail

WorkSubstituteRule

public WorkSubstituteRule(String workSubstituteRuleId,
                          Date effectiveDate,
                          Date expiryDate,
                          String source,
                          String target)

WorkSubstituteRule

public WorkSubstituteRule()

WorkSubstituteRule

public WorkSubstituteRule(WorkSubstituteRuleType ruleType)
Method Detail

toXML

public void toXML(WorkSubstituteRuleType ruleType)

equals

public boolean equals(Object other)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

getEffectiveDate

public Date getEffectiveDate()

setEffectiveDate

public void setEffectiveDate(Date effectiveDate)

getExpiryDate

public Date getExpiryDate()

setExpiryDate

public void setExpiryDate(Date expiryDate)

getSource

public String getSource()

setSource

public void setSource(String source)

getTarget

public String getTarget()

setTarget

public void setTarget(String target)

getWorkSubstituteRuleId

public String getWorkSubstituteRuleId()

getWorkSubstituteRulesArray

public static WorkSubstituteRule[] getWorkSubstituteRulesArray(WorkSubstituteRulesDocument rulesDoc)

getWorkSubstituteRulesDocument

public static WorkSubstituteRulesDocument getWorkSubstituteRulesDocument(WorkSubstituteRule[] rules)

getWorkSubstituteRulesXML

public static String getWorkSubstituteRulesXML(WorkSubstituteRule[] rules)