Package org.kuali.rice.kew.api.doctype

Enum Class DocumentTypePolicy

java.lang.Object
java.lang.Enum<DocumentTypePolicy>
org.kuali.rice.kew.api.doctype.DocumentTypePolicy
All Implemented Interfaces:
Serializable, Comparable<DocumentTypePolicy>, Constable, Coded
public enum DocumentTypePolicy extends Enum<DocumentTypePolicy> implements Coded
TODO...
Author:
Kuali Rice Team (rice.collab@kuali.org)

  • Enum Constant Details

    • DISAPPROVE

      public static final DocumentTypePolicy DISAPPROVE
      FIXME: needs docs

    • USE_KEW_SUPERUSER_DOCHANDLER

      public static final DocumentTypePolicy USE_KEW_SUPERUSER_DOCHANDLER
      This policy determines whether to use the internal KEW Super User document handler URL when opening a document from super user search. If set to false the client must implement a custom super user screen to be used when the doc handler URL has a post variable of the name defined by KewApiConstants#COMMAND_PARAMETER and a value of KewApiConstants#SUPERUSER_COMMAND. The default is 'true'.

    • ALLOW_UNREQUESTED_ACTION

      public static final DocumentTypePolicy ALLOW_UNREQUESTED_ACTION
      determines how to handle the situation where the user has initiated an action but there is not a corresponding pending request. This policy has a default of true. If set to false an exception should be thrown from ApproveAction, CompleteAction, AcknowledgeAction and ClearFYIAction classes when there does not exist a corresponding pending request for the user who is submitting the action. When set to false, this will result in one of the users getting an error message if 2 users attempt to submit the same action at the same time (this can happen in workgroup situtations).

    • DEFAULT_APPROVE

      public static final DocumentTypePolicy DEFAULT_APPROVE
      determines whether a document will go processed without any approval requests. If a document has this policy set to false and doesn't generate and approval requests the document will be put in exception routing, which is the exception workgroup associated with the last route node or the workgroup defined in the 'defaultExceptionGroupName'. This policy if not defined in this or a parent document type defaults to true

    • INITIATOR_MUST_ROUTE

      public static final DocumentTypePolicy INITIATOR_MUST_ROUTE
      determines if the user that initiated a document must 'route' the document when it is in the initiated state. Defaults to true.

    • INITIATOR_MUST_SAVE

      public static final DocumentTypePolicy INITIATOR_MUST_SAVE
      determines if the user that initiated a document must 'route' the document when it is in the initiated state. Defaults to true.

    • INITIATOR_MUST_CANCEL

      public static final DocumentTypePolicy INITIATOR_MUST_CANCEL

    • INITIATOR_MUST_BLANKET_APPROVE

      public static final DocumentTypePolicy INITIATOR_MUST_BLANKET_APPROVE

    • LOOK_FUTURE

      public static final DocumentTypePolicy LOOK_FUTURE
      determines whether the document can be brought into a simulated route from the route log. A simulation of where the document would end up if it where routed to completion now. Defaults to false. determines if route log will show the look into the future link

    • SEND_NOTIFICATION_ON_SU_APPROVE

      public static final DocumentTypePolicy SEND_NOTIFICATION_ON_SU_APPROVE

    • SUPPORTS_QUICK_INITIATE

      public static final DocumentTypePolicy SUPPORTS_QUICK_INITIATE

    • NOTIFY_ON_SAVE

      public static final DocumentTypePolicy NOTIFY_ON_SAVE

    • DOCUMENT_STATUS_POLICY

      public static final DocumentTypePolicy DOCUMENT_STATUS_POLICY
      The Document Status Policy determines whether the KEW Route Status or the Application Document Status (or both) are to be used for a specific document type.

    • ALLOW_SU_POSTPROCESSOR_OVERRIDE

      public static final DocumentTypePolicy ALLOW_SU_POSTPROCESSOR_OVERRIDE
      This document type policy allows us to configure if the "Perform Post Processor Logic" for the super user action on action requests is displayed. KULRICE-3584

    • FAIL_ON_INACTIVE_GROUP

      public static final DocumentTypePolicy FAIL_ON_INACTIVE_GROUP

    • ENROUTE_ERROR_SUPPRESSION

      public static final DocumentTypePolicy ENROUTE_ERROR_SUPPRESSION

    • REGENERATE_ACTION_REQUESTS_ON_CHANGE

      public static final DocumentTypePolicy REGENERATE_ACTION_REQUESTS_ON_CHANGE

    • NOTIFY_PENDING_ON_RETURN

      public static final DocumentTypePolicy NOTIFY_PENDING_ON_RETURN
      Governs whether FYIs should be sent on *pending* (not completed) action requests when returning to a previous node
      Since:
      2.1

    • NOTIFY_COMPLETED_ON_RETURN

      public static final DocumentTypePolicy NOTIFY_COMPLETED_ON_RETURN
      Governs whether FYIs should be sent on *completed* (not pending) action requests when returning to a previous node (for use with Recall)
      Since:
      2.1

    • RECALL_NOTIFICATION

      public static final DocumentTypePolicy RECALL_NOTIFICATION
      Specifies additional recipients of Recall notifications. This configuration is supplied as an additional recipients element in the document policy element, which conforms to the Rule:ResponsibilityIdentifiers group schema.
      Since:
      2.1

    • RECALL_VALID_ACTIONSTAKEN

      public static final DocumentTypePolicy RECALL_VALID_ACTIONSTAKEN
      Specifies list of prior actions taken for which a subsequent Recall action will be valid.
      Since:
      2.1

    • SEND_NOTIFICATION_ON_SU_DISAPPROVE

      public static final DocumentTypePolicy SEND_NOTIFICATION_ON_SU_DISAPPROVE
      Specifies whether to send acknowledgements on a super user disapprove action
      Since:
      2.1

    • ALLOW_SU_FINAL_APPROVAL

      public static final DocumentTypePolicy ALLOW_SU_FINAL_APPROVAL
      Specifies whether to disallow super user approval on the final route node
      Since:
      2.1

    • SUPPRESS_IMMEDIATE_EMAILS_ON_SU_ACTION

      public static final DocumentTypePolicy SUPPRESS_IMMEDIATE_EMAILS_ON_SU_ACTION
      Specifies whether immediate emails should be suppressed after a superuser action is taken
      Since:
      2.1.3

    • DOC_SEARCH_TARGET

      public static final DocumentTypePolicy DOC_SEARCH_TARGET
      Specifies target for document search URL building
      Since:
      2.5.0

    • SUPPRESS_ACKNOWLEDGEMENTS_ON_DISAPPROVE

      public static final DocumentTypePolicy SUPPRESS_ACKNOWLEDGEMENTS_ON_DISAPPROVE

  • Method Details

    • values

      public static DocumentTypePolicy[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static DocumentTypePolicy valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getCode

      public String getCode()
      Specified by:
      getCode in interface Coded

    • fromCode

      public static DocumentTypePolicy fromCode(String code)