com.waveset.object
Class WSUser.Delegate

java.lang.Object
  extended by com.waveset.object.WSUser.Delegate
Enclosing class:
WSUser

public static class WSUser.Delegate
extends java.lang.Object

A class which defines the type, to whom, and start/end dates for delegating future workitems


Field Summary
static java.lang.String DELEGATE_WORKITEMS_RULE_TYPE
           
static java.lang.String MANAGER_TYPE
           
static java.lang.String SELECTED_USERS_TYPE
           
 
Constructor Summary
WSUser.Delegate()
          Create a delegate.
WSUser.Delegate(org.w3c.dom.Element e)
          Create a delegate by parsing its DOM representation.
 
Method Summary
 boolean equals(java.lang.Object o)
           
 java.util.List getDelegateToRefs()
          Get delegate to user refs
 java.lang.String getDelegateType()
          Get delegate type
 java.util.Date getEndDate()
          Get delegate end date
 java.util.Date getStartDate()
          Get delegate start date
 java.lang.String getWorkItemType()
          Get the WorkItem type being delegated.
 java.util.List getWorkItemTypeObjectRefs()
           
 boolean isActive()
           
 boolean isEnded()
          Indicates whether or not the delegation has ended based soley on the delegation's end date.
 boolean isPending()
          Indicates whether or not the delegation has begun or would begin based on the delegation's start date.
 void parseXml(org.w3c.dom.Element e)
          Parse the DOM representation of the delegate, and set the corresponding fields.
 void setDelegateToRefs(java.util.List delegateToRefs)
           
 void setDelegateType(java.lang.String delegateType)
          Set delegate type
 void setEndDate(java.util.Date endDate)
          Set delegate end date
 void setStartDate(java.util.Date startDate)
          Set delegate start date
 void setWorkItemType(java.lang.String workItemType)
           
 void setWorkItemTypeObjectRefs(java.util.List workItemTypeObjectRefs)
           
 void toXml(java.lang.StringBuffer b, int indent)
          Serialize the delegate to an XML string buffer.
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DELEGATE_WORKITEMS_RULE_TYPE

public static java.lang.String DELEGATE_WORKITEMS_RULE_TYPE

MANAGER_TYPE

public static java.lang.String MANAGER_TYPE

SELECTED_USERS_TYPE

public static java.lang.String SELECTED_USERS_TYPE
Constructor Detail

WSUser.Delegate

public WSUser.Delegate()
Create a delegate.


WSUser.Delegate

public WSUser.Delegate(org.w3c.dom.Element e)
                throws com.waveset.util.WavesetException
Create a delegate by parsing its DOM representation.

Throws:
com.waveset.util.WavesetException
Method Detail

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

getDelegateToRefs

public java.util.List getDelegateToRefs()
Get delegate to user refs


getDelegateType

public java.lang.String getDelegateType()
Get delegate type


getEndDate

public java.util.Date getEndDate()
Get delegate end date


getStartDate

public java.util.Date getStartDate()
Get delegate start date


getWorkItemType

public java.lang.String getWorkItemType()
Get the WorkItem type being delegated.


getWorkItemTypeObjectRefs

public java.util.List getWorkItemTypeObjectRefs()

isActive

public boolean isActive()

isEnded

public boolean isEnded()
Indicates whether or not the delegation has ended based soley on the delegation's end date. Note that a delegation could also end through manual intervention but this method would not reflect such a situation.

Returns:
true indicates that the delegation has ended; false otherwise

isPending

public boolean isPending()
Indicates whether or not the delegation has begun or would begin based on the delegation's start date.

Returns:
true indicates that the delegation has not begun; false otherwise

parseXml

public void parseXml(org.w3c.dom.Element e)
              throws com.waveset.util.WavesetException
Parse the DOM representation of the delegate, and set the corresponding fields.

Throws:
com.waveset.util.WavesetException

setDelegateToRefs

public void setDelegateToRefs(java.util.List delegateToRefs)

setDelegateType

public void setDelegateType(java.lang.String delegateType)
Set delegate type


setEndDate

public void setEndDate(java.util.Date endDate)
Set delegate end date

Parameters:
endDate - - Date

setStartDate

public void setStartDate(java.util.Date startDate)
Set delegate start date

Parameters:
startDate - - Date

setWorkItemType

public void setWorkItemType(java.lang.String workItemType)

setWorkItemTypeObjectRefs

public void setWorkItemTypeObjectRefs(java.util.List workItemTypeObjectRefs)

toXml

public void toXml(java.lang.StringBuffer b,
                  int indent)
Serialize the delegate to an XML string buffer.