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

Class OOOWfModelDesignate

  • public final class OOOWfModelDesignate
extends java.lang.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 java.lang.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​(java.lang.String outOfOfficeDesignate, java.util.List<java.lang.String> wfModels, java.util.List<java.lang.String> excludedWfmodels)
      Constructor for AEM Inbox Out Of Office Workflow Model Designate.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.List<java.lang.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.
      java.lang.String getOutOfOfficeDesignate()
      Returns the designated user when user is out of office
      java.util.List<java.lang.String> getWfModels()
      Returns the list of workflow model id's for which task is delegated when user is out of office
      void setExcludedWfmodels​(java.util.List<java.lang.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​(java.lang.String outOfOfficeDesignate)
      Sets the designated user id when user is out of office
      void setWfModels​(java.util.List<java.lang.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 java.lang.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
                           java.lang.String outOfOfficeDesignate,
                           @Nonnull
                           java.util.List<java.lang.String> wfModels,
                           @Nullable
                           java.util.List<java.lang.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 java.lang.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
                                    java.lang.String outOfOfficeDesignate)
        Sets the designated user id when user is out of office
        Parameters:
        outOfOfficeDesignate - designated user id

      • getWfModels

        @Nonnull
public java.util.List<java.lang.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
                        java.util.List<java.lang.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 java.util.List<java.lang.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
                                java.util.List<java.lang.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