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

Class OOOWfModelDesignate

java.lang.Object

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

public final class OOOWfModelDesignate
extends Object

Class for the AEM Inbox Out Of Office Workflow Model Designate. It represents who will be assignee for which workflow model along with the excluded workflow models when user is out of office.

Field Summary

Fields

Modifier and Type	Field	Description
static String	ALL_WORKFLOW_MODELS	A constant to specify to include all the current workflow models in the wfModels list.

Constructor Summary

Constructors

Constructor	Description
OOOWfModelDesignate(String outOfOfficeDesignate, List<String> wfModels, List<String> excludedWfmodels)	Constructor for AEM Inbox Out Of Office Workflow Model Designate.

Method Summary

Modifier and Type	Method	Description
List<String>	getExcludedWfmodels()	Returns the excluded workflow model id's when user is out of office or null if excluded workflow model id's are not present.
String	getOutOfOfficeDesignate()	Returns the designated user when user is out of office
List<String>	getWfModels()	Returns the list of workflow model id's for which task is delegated when user is out of office
void	setExcludedWfmodels(List<String> excludedWfmodels)	Sets the excluded workflow model id's when user is out of office or null if excluded workflow model id's are not present.
void	setOutOfOfficeDesignate(String outOfOfficeDesignate)	Sets the designated user id when user is out of office
void	setWfModels(List<String> wfModels)	Sets the list of workflow model id's for which task is delegated when user is out of office

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ALL_WORKFLOW_MODELS

public static final String ALL_WORKFLOW_MODELS

A constant to specify to include all the current workflow models in the wfModels list.

See Also:

Constant Field Values

Constructor Detail

OOOWfModelDesignate

public OOOWfModelDesignate(@Nonnull
                           String outOfOfficeDesignate,
                           @Nonnull
                           List<String> wfModels,
                           @Nullable
                           List<String> excludedWfmodels)

Constructor for AEM Inbox Out Of Office Workflow Model Designate.

Parameters:

outOfOfficeDesignate - designated user id

wfModels - the list of workflow model id's. If it contains ALL_WORKFLOW_MODELS then designated user will be set for all the workflow models

excludedWfmodels - the excluded workflow model id's when user is out of office

Method Detail

getOutOfOfficeDesignate

@Nonnull
public String getOutOfOfficeDesignate()

Returns the designated user when user is out of office

Returns:

The user id of the designated user

setOutOfOfficeDesignate

public void setOutOfOfficeDesignate(@Nonnull
                                    String outOfOfficeDesignate)

Sets the designated user id when user is out of office

Parameters:

outOfOfficeDesignate - designated user id

getWfModels

@Nonnull
public List<String> getWfModels()

Returns the list of workflow model id's for which task is delegated when user is out of office

Returns:

The list of workflow model id's for which task is delegated when user is out of office

setWfModels

public void setWfModels(@Nonnull
                        List<String> wfModels)

Sets the list of workflow model id's for which task is delegated when user is out of office

Parameters:

wfModels - the list of workflow model id's. If it contains ALL_WORKFLOW_MODELS then designated user will be set for all the workflow models

getExcludedWfmodels

@Nullable
public List<String> getExcludedWfmodels()

Returns the excluded workflow model id's when user is out of office or null if excluded workflow model id's are not present. This is applicable only when workflow model contain ALL_WORKFLOW_MODELS.

Returns:

The excluded workflow model id's when user is out of office

setExcludedWfmodels

public void setExcludedWfmodels(@Nullable
                                List<String> excludedWfmodels)

Sets the excluded workflow model id's when user is out of office or null if excluded workflow model id's are not present.

Parameters:

excludedWfmodels - the excluded workflow model id's when user is out of office