Package com.adobe.cq.inbox.api.preferences.domain.outofoffice

Interface OutOfOfficePreferences

@ProviderType
public interface OutOfOfficePreferences

Interface for the AEM Inbox Out Of Office Preferences

Method Summary

Modifier and Type	Method	Description
OutOfOfficeDateRange	getDateRange()	Returns the OutOfOfficeDateRange during which user is out of office or empty object if configuration is not present
List<OOOWfModelDesignate>	getWfModelSpecificDesignates()	Returns list of OOOWfModelDesignate that assign designated tasks to alternate users while user is out of office or empty list if configuration is not present
boolean	isOutOfOffice()	Returns if isOurOfOffice property is set to true by user or not.
boolean	isOutOfOfficeDesignateProvided()	Returns if isOutOfOfficeDesignateProvided property is set to true by user or not.
void	setOutOfOffice(boolean isOutOfOffice)	Sets isOutOfOffice property to true or false.
void	setOutOfOfficeDesignateProvided(boolean isOutOfOfficeDesignateProvided)	Sets isOutOfOfficeDesignateProvided property to true or false.

Method Detail

isOutOfOffice

boolean isOutOfOffice()

Returns if isOurOfOffice property is set to true by user or not. The return value is not sufficient to determine if user is out of office. It will depend on the date range set by the user.

Returns:

if ourOfOffice property is set to true by user or not.

setOutOfOffice

void setOutOfOffice(boolean isOutOfOffice)

Sets isOutOfOffice property to true or false.

Parameters:

isOutOfOffice - true or false

getDateRange

@Nonnull
OutOfOfficeDateRange getDateRange()

Returns the OutOfOfficeDateRange during which user is out of office or empty object if configuration is not present

Returns:

The OutOfOfficeDateRange during which user is out of office

getWfModelSpecificDesignates

@Nonnull
List<OOOWfModelDesignate> getWfModelSpecificDesignates()

Returns list of OOOWfModelDesignate that assign designated tasks to alternate users while user is out of office or empty list if configuration is not present

Returns:

The list of OOOWfModelDesignate

isOutOfOfficeDesignateProvided

boolean isOutOfOfficeDesignateProvided()

Returns if isOutOfOfficeDesignateProvided property is set to true by user or not.

Returns:

if isOutOfOfficeDesignateProvided property is set to true by user or not

setOutOfOfficeDesignateProvided

void setOutOfOfficeDesignateProvided(boolean isOutOfOfficeDesignateProvided)

Sets isOutOfOfficeDesignateProvided property to true or false.

Parameters:

isOutOfOfficeDesignateProvided - true or false