com.ibm.task.api

Class UserSubstitutionDetail

  1. java.lang.Object
  2. extended bycom.ibm.task.api.UserSubstitutionDetail
All implemented interfaces:
java.io.Serializable

  1. public class UserSubstitutionDetail
  2. extends java.lang.Object
  3. implements java.io.Serializable
Handles the absence and substitution details of a user.
Since:
7.0
See Also:
Serialized Form

Field Summary

Modifier and Type Field and Description
  1. static
  2. java.lang.String
COPYRIGHT_
  1. static
  2. java.lang.String
NL

Constructor Summary

Constructor and Description
UserSubstitutionDetail()
Default constructor to initialize the user absence and substitution details.
UserSubstitutionDetail(java.util.List substitutes,java.util.Calendar startDate,java.util.Calendar endDate)
Constructor that creates a user substitution details object from the passed values.

Method Summary

Modifier and Type Method and Description
  1. java.util.Calendar
getEndDate()
Returns the end date of the user's absence period.
  1. java.util.Calendar
getStartDate()
Returns the start date of the user's absence period.
  1. java.util.List
getSubstitutes()
Returns the user IDs of the substitutes.
  1. void
setEndDate(java.util.Calendar endDate)
Sets the end date for the user's absence period.
  1. void
setStartDate(java.util.Calendar startDate)
Sets the start date for the user's absence period.
  1. void
setSubstitutes(java.util.List substitutes)
Sets the substitutes of the user.
  1. java.lang.String
toString()
Returns a string representation of the UserSubstitutionDetail object.
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

  1. public static final java.lang.String COPYRIGHT_
See Also:

NL

  1. public static final java.lang.String NL

Constructor Detail

UserSubstitutionDetail

  1. public UserSubstitutionDetail()
Default constructor to initialize the user absence and substitution details.

UserSubstitutionDetail

  1. public UserSubstitutionDetail(java.util.List substitutes,
  2. java.util.Calendar startDate,
  3. java.util.Calendar endDate)
Constructor that creates a user substitution details object from the passed values.
Parameters:
substitutes - The substitutes for the user during the absence period. If null is specified, there are no substitutes.
startDate - The start date for the user's absence period. If null is specified, the end date must also be null. Note that validity checks are executed when the object is passed to the Human Task Manager - refer to setUserSubstitutionDetail.
endDate - The end date for the user's absence period. If null is specified, the end date of user's absence is open.

Method Detail

getSubstitutes

  1. public java.util.List getSubstitutes( )
Returns the user IDs of the substitutes.
Returns:
The substitutes, Returns an empty list if there are no substitutes.

getStartDate

  1. public java.util.Calendar getStartDate( )
Returns the start date of the user's absence period.
Returns:
The start date of the user's absence period.

getEndDate

  1. public java.util.Calendar getEndDate( )
Returns the end date of the user's absence period.
Returns:
The end date of the user's absence period.

setSubstitutes

  1. public void setSubstitutes(java.util.List substitutes)
Sets the substitutes of the user.
Parameters:
substitutes - The substitutes for the user during the absence period. If null is specified, there are no substitutes.

setStartDate

  1. public void setStartDate(java.util.Calendar startDate)
Sets the start date for the user's absence period.
Parameters:
startDate - The start date for the user's absence period. If null is specified, the end date must also be null. Note that validity checks are executed when the object is passed to the Human Task Manager - refer to setUserSubstitutionDetail.

setEndDate

  1. public void setEndDate(java.util.Calendar endDate)
Sets the end date for the user's absence period.
Parameters:
endDate - The end date for the user's absence period. If null is specified, the end date of the user's absence is open.

toString

  1. public java.lang.String toString( )
Returns a string representation of the UserSubstitutionDetail object.
Overrides:
toString in class java.lang.Object
Returns:
String - A string representation of the object.