DocumentTypePolicy (Rice KEW API 2.3.10 API)

java.lang.Object
- java.lang.Enum<DocumentTypePolicy>
- - org.kuali.rice.kew.api.doctype.DocumentTypePolicy

All Implemented Interfaces:

Serializable, Comparable<DocumentTypePolicy>, Coded
```
public enum DocumentTypePolicy
extends Enum<DocumentTypePolicy>
implements Coded
```
TODO...

Author:

Kuali Rice Team (rice.collab@kuali.org)

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ALLOW_SU_FINAL_APPROVAL` Specifies whether to disallow super user approval on the final route node
`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.
`ALLOW_UNREQUESTED_ACTION` determines how to handle the situation where the user has initiated an action but there is not a corresponding pending request.
`DEFAULT_APPROVE` determines whether a document will go processed without any approval requests.
`DISAPPROVE` FIXME: needs docs
`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.
`ENROUTE_ERROR_SUPPRESSION`
`FAIL_ON_INACTIVE_GROUP`
`INITIATOR_MUST_BLANKET_APPROVE`
`INITIATOR_MUST_CANCEL`
`INITIATOR_MUST_ROUTE` determines if the user that initiated a document must 'route' the document when it is in the initiated state.
`INITIATOR_MUST_SAVE` determines if the user that initiated a document must 'route' the document when it is in the initiated state.
`LOOK_FUTURE` determines whether the document can be brought into a simulated route from the route log.
`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)
`NOTIFY_ON_SAVE`
`NOTIFY_PENDING_ON_RETURN` Governs whether FYIs should be sent on pending (not completed) action requests when returning to a previous node
`RECALL_NOTIFICATION` Specifies additional recipients of Recall notifications.
`RECALL_VALID_ACTIONSTAKEN` Specifies list of prior actions taken for which a subsequent Recall action will be valid.
`REGENERATE_ACTION_REQUESTS_ON_CHANGE`
`SEND_NOTIFICATION_ON_SU_APPROVE`
`SEND_NOTIFICATION_ON_SU_DISAPPROVE` Specifies whether to send acknowledgements on a super user disapprove action
`SUPPORTS_QUICK_INITIATE`
`SUPPRESS_IMMEDIATE_EMAILS_ON_SU_ACTION` Specifies whether immediate emails should be suppressed after a superuser action is taken
`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.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DocumentTypePolicy`	`fromCode(String code)`
`String`	`getCode()`
`static DocumentTypePolicy`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static DocumentTypePolicy[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - 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
    
    See Also:
    
    https://jira.kuali.org/browse/KULRICE-5931
  - 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
    
    See Also:
    
    https://jira.kuali.org/browse/KULRICE-5931
  - 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
    
    See Also:
    
    https://jira.kuali.org/browse/KULRICE-5931
  - 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
    
    See Also:
    
    https://jira.kuali.org/browse/KULRICE-7798
  - 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
    
    See Also:
    
    https://jira.kuali.org/browse/KULRICE-7056
  - 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
    
    See Also:
    
    https://jira.kuali.org/browse/KULRICE-7057
  - 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
    
    See Also:
    
    https://jira.kuali.org/browse/KULRICE-8289
- Method Detail
  - values
```
public static DocumentTypePolicy[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (DocumentTypePolicy c : DocumentTypePolicy.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static DocumentTypePolicy valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type 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)
```

Enum DocumentTypePolicy

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

DISAPPROVE

USE_KEW_SUPERUSER_DOCHANDLER

ALLOW_UNREQUESTED_ACTION

DEFAULT_APPROVE

INITIATOR_MUST_ROUTE

INITIATOR_MUST_SAVE

INITIATOR_MUST_CANCEL

INITIATOR_MUST_BLANKET_APPROVE

LOOK_FUTURE

SEND_NOTIFICATION_ON_SU_APPROVE

SUPPORTS_QUICK_INITIATE

NOTIFY_ON_SAVE

DOCUMENT_STATUS_POLICY

ALLOW_SU_POSTPROCESSOR_OVERRIDE

FAIL_ON_INACTIVE_GROUP

ENROUTE_ERROR_SUPPRESSION

REGENERATE_ACTION_REQUESTS_ON_CHANGE

NOTIFY_PENDING_ON_RETURN

NOTIFY_COMPLETED_ON_RETURN

RECALL_NOTIFICATION

RECALL_VALID_ACTIONSTAKEN

SEND_NOTIFICATION_ON_SU_DISAPPROVE

ALLOW_SU_FINAL_APPROVAL

SUPPRESS_IMMEDIATE_EMAILS_ON_SU_ACTION

Method Detail

values

valueOf

getCode

fromCode