com.adobe.idp.taskmanager.dsc.client.queuemanager
Interface OutOfOfficeInfo

All Superinterfaces:

java.io.Serializable

public interface OutOfOfficeInfo
extends java.io.Serializable

Manages Out of Office settings for the current user. Also manages Out of Office settings for other users if the current user is an administrator.

Method Summary

java.util.List	getDateRanges() Returns a List of out of office ranges during which the current user is Out of Office.
UserDef	getOutOfOfficeDesignate() Returns a fully-populated UserDef object for the user who is designated to receive tasks when the current user is Out of office.
java.util.List	getProcessSpecificDesignates() Retrieves the process-specific rules that assign designated tasks to alternate users while the current user is Out of office.
boolean	isNoPrimaryDesignate() Determines whether the current user has no designate for Out of office tasks.
boolean	isOutOfOffice() Indicates whether the current user is Out of Office
void	setDateRanges(java.util.List dateRanges) Sets a list of out of office date ranges during which the current user is out of office.
void	setNoPrimaryDesignate(boolean noDesignate) Sets whether the current user designates an alternate user.
void	setOutOfOffice(boolean isOutOfOffice) Specifies whether the current user is out of office.
void	setOutOfOfficeDesignate(UserDef user) Designates an alternate user who receives new tasks when the current user is Out of office.
void	setProcessSpecificDesignates(java.util.List designates) Sets process-specific rules that assign designated tasks to alternate users while the current user is Out of office. process-specific designates are used before the global designate.

Method Detail

isOutOfOffice

boolean isOutOfOffice()

Indicates whether the current user is Out of Office

Returns:

true if the user is out of office

setOutOfOffice

void setOutOfOffice(boolean isOutOfOffice)

Specifies whether the current user is out of office. This setting is independent of Out of Office date ranges.

Parameters:

isOutOfOffice - set to true if the user is out of office

getDateRanges

java.util.List getDateRanges()

Returns a List of out of office ranges during which the current user is Out of Office.

setDateRanges

void setDateRanges(java.util.List dateRanges)

Sets a list of out of office date ranges during which the current user is out of office. Depending on the parameter, existing date ranges are augmented or replaced:

• List<OutOfOfficeDateRange>. When you provide a List, the existing date ranges defined on the server are replaced with the new ones.
• OutOfOfficeDateRange. When you provide the OutOfOfficeDateRange type, the new date range is appended to the existing date ranges.

Parameters:

dateRanges - List of date ranges

setOutOfOfficeDesignate

void setOutOfOfficeDesignate(UserDef user)

Designates an alternate user who receives new tasks when the current user is Out of office.

Calling this method clears any previous call to setNoPrimaryDesignate(true).

Parameters:

user - a UserDef object populated with identifying information for the alternate user.

getOutOfOfficeDesignate

UserDef getOutOfOfficeDesignate()

Returns a fully-populated UserDef object for the user who is designated to receive tasks when the current user is Out of office.

Returns null if there is no user setup.

setNoPrimaryDesignate

void setNoPrimaryDesignate(boolean noDesignate)

Sets whether the current user designates an alternate user. The alternate user receives new tasks when the current user is Out of office. In this case, only the process-specific designations are performed.

Specifying no designated user clears any previous calls to setOutOfOfficeDesignate(userDef).

Parameters:

noDesignate - A value of true specifies that there is no designate for Out of office tasks.

isNoPrimaryDesignate

boolean isNoPrimaryDesignate()

Determines whether the current user has no designate for Out of office tasks.

Returns:

A value of true indicates that there is no designate for Out of office tasks.

setProcessSpecificDesignates

void setProcessSpecificDesignates(java.util.List designates)

Sets process-specific rules that assign designated tasks to alternate users while the current user is Out of office.
process-specific designates are used before the global designate.

Parameters:

designates - a List of designate objects to define who will receive OOO tasks for specific processes

getProcessSpecificDesignates

java.util.List getProcessSpecificDesignates()

Retrieves the process-specific rules that assign designated tasks to alternate users while the current user is Out of office.

Returns:

List of process designates for processes