com.ibm.task.api

Class UserSubstitutionDetail

  • java.lang.Object
    • com.ibm.task.api.UserSubstitutionDetail
  • All Implemented Interfaces:
    java.io.Serializable


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

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT_ 
      static java.lang.String NL 
    • Constructor Summary

      Constructors 
      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

      Methods 
      Modifier and Type Method and Description
      java.util.Calendar getEndDate()
      Returns the end date of the user's absence period.
      java.util.Calendar getStartDate()
      Returns the start date of the user's absence period.
      java.util.List getSubstitutes()
      Returns the user IDs of the substitutes.
      void setEndDate(java.util.Calendar endDate)
      Sets the end date for the user's absence period.
      void setStartDate(java.util.Calendar startDate)
      Sets the start date for the user's absence period.
      void setSubstitutes(java.util.List substitutes)
      Sets the substitutes of the user.
      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

      • NL

        public static final java.lang.String NL
    • Constructor Detail

      • UserSubstitutionDetail

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

        public 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.
        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

        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

        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

        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

        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

        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

        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

        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.
IBM Business Process ManagerTM
Release 8