Index (Rice KEW Framework 2502.0002 API)

A B C D E F G I K L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

ACTION - Enum constant in enum class org.kuali.rice.kew.framework.document.security.AuthorizableAction.CheckType
ACTION_LIST_CUSTOMIZATION_HANDLER_SERVICE - Static variable in class org.kuali.rice.kew.framework.KewFrameworkServiceLocator
ACTION_LIST_CUSTOMIZATION_MEDIATOR - Static variable in class org.kuali.rice.kew.framework.KewFrameworkServiceLocator
ACTION_TAKEN - Static variable in interface org.kuali.rice.kew.framework.postprocessor.IDocumentEvent
ActionListCustomizationHandlerService - Interface in org.kuali.rice.kew.framework.actionlist: A remotable service which handles processing of a client application's custom processing of action list attributes.
ActionListCustomizationMediator - Interface in org.kuali.rice.kew.framework.actionlist: A remotable service which handles processing of a client application's custom processing of action list attributes.
ActionTakenEvent - Class in org.kuali.rice.kew.framework.postprocessor: Event sent to the postprocessor when an action has been taken
ActionTakenEvent(String, String, ActionTaken) - Constructor for class org.kuali.rice.kew.framework.postprocessor.ActionTakenEvent
actionType - Variable in class org.kuali.rice.kew.framework.document.security.AuthorizableAction: The document ActionType if application (CheckType.ACTION)
AFTER_PROCESS - Static variable in interface org.kuali.rice.kew.framework.postprocessor.IDocumentEvent
afterActionTaken(ActionType, ActionTakenEvent) - Method in interface org.kuali.rice.kew.framework.postprocessor.PostProcessor: Executed after an action is taken against the document.
afterActionTaken(ActionType, ActionTakenEvent) - Method in class org.kuali.rice.kew.postprocessor.DefaultPostProcessor
afterProcess(AfterProcessEvent) - Method in interface org.kuali.rice.kew.framework.postprocessor.PostProcessor: Executed after processing by the workflow engine has completed.
afterProcess(AfterProcessEvent) - Method in class org.kuali.rice.kew.postprocessor.DefaultPostProcessor
AfterProcessEvent - Class in org.kuali.rice.kew.framework.postprocessor: Event sent to the postprocessor when the processor is ended
AfterProcessEvent(String, String, boolean) - Constructor for class org.kuali.rice.kew.framework.postprocessor.AfterProcessEvent
AttributeFields - Class in org.kuali.rice.kew.framework.document.search: An immutable data transfer object used to hold a list of RemotableAttributeField objects and the name of the SearchableAttribute from which the fields are derived.
AuthorizableAction - Class in org.kuali.rice.kew.framework.document.security: Encapsulates the type of authorization check the DocumentTypeAuthorizer is making.
AuthorizableAction(ActionType) - Constructor for class org.kuali.rice.kew.framework.document.security.AuthorizableAction: Construct AuthorizableAction for a document action
AuthorizableAction(AuthorizableAction.CheckType) - Constructor for class org.kuali.rice.kew.framework.document.security.AuthorizableAction: Construct AuthorizableAction for non-action CheckType
AuthorizableAction(AuthorizableAction.CheckType, ActionType) - Constructor for class org.kuali.rice.kew.framework.document.security.AuthorizableAction
AuthorizableAction.CheckType - Enum Class in org.kuali.rice.kew.framework.document.security: The authorization check type: either a document action, initiation, or super user approve action request check
Authorization - Class in org.kuali.rice.kew.framework.document.security: Authorization response for document routing authorization checks
Authorization(boolean) - Constructor for class org.kuali.rice.kew.framework.document.security.Authorization: Short-hand constructor for authorization without a reason
Authorization(boolean, String) - Constructor for class org.kuali.rice.kew.framework.document.security.Authorization: Construct authorization response with a reason

B

BEFORE_PROCESS - Static variable in interface org.kuali.rice.kew.framework.postprocessor.IDocumentEvent
beforeProcess(BeforeProcessEvent) - Method in interface org.kuali.rice.kew.framework.postprocessor.PostProcessor: Executed prior to processing by the workflow engine.
beforeProcess(BeforeProcessEvent) - Method in class org.kuali.rice.kew.postprocessor.DefaultPostProcessor
BeforeProcessEvent - Class in org.kuali.rice.kew.framework.postprocessor: Event sent to the postprocessor when the processor is started
BeforeProcessEvent(String, String) - Constructor for class org.kuali.rice.kew.framework.postprocessor.BeforeProcessEvent
build() - Method in class org.kuali.rice.kew.framework.document.search.DocumentSearchCriteriaConfiguration.Builder
build() - Method in class org.kuali.rice.kew.framework.document.search.DocumentSearchResultSetConfiguration.Builder
build() - Method in class org.kuali.rice.kew.framework.document.search.DocumentSearchResultValue.Builder
build() - Method in class org.kuali.rice.kew.framework.document.search.DocumentSearchResultValues.Builder

C

CLEAR_CRITERIA - Enum constant in enum class org.kuali.rice.kew.framework.document.search.DocumentSearchCustomization: Customization of clearing of the document search criteria.
create() - Static method in class org.kuali.rice.kew.framework.document.search.DocumentSearchCriteriaConfiguration.Builder: Creates new empty builder instance.
create() - Static method in class org.kuali.rice.kew.framework.document.search.DocumentSearchResultSetConfiguration.Builder: Creates new empty builder instance.
create() - Static method in class org.kuali.rice.kew.framework.document.search.DocumentSearchResultValues.Builder: Creates new empty builder instance.
create(String) - Static method in class org.kuali.rice.kew.framework.document.search.DocumentSearchResultValue.Builder: Creates a new builder instance initialized with the given document id.
create(String, List<RemotableAttributeField>) - Static method in class org.kuali.rice.kew.framework.document.search.AttributeFields: Construct a new instance of AttributeFields with the given attribute name and list of remotable attribute fields.
create(List<String>, List<Document>) - Static method in class org.kuali.rice.kew.framework.document.security.DocumentSecurityDirective: Creates a new security directive from the given list of document secruity attribute names and documents.
create(List<RemotableAttributeError>, List<RemotableAttributeField>, Map<String, String>) - Static method in class org.kuali.rice.kew.framework.rule.attribute.WorkflowRuleAttributeFields: Construct a new instance of WorkflowRuleAttributeFields with the given validation errors, fields, and rule extension values.
create(DocumentSearchCriteriaConfigurationContract) - Static method in class org.kuali.rice.kew.framework.document.search.DocumentSearchCriteriaConfiguration.Builder: Creates a new builder instance initialized with copies of the properties from the given contract.
create(DocumentSearchResultSetConfigurationContract) - Static method in class org.kuali.rice.kew.framework.document.search.DocumentSearchResultSetConfiguration.Builder: Creates a new builder instance initialized with copies of the properties from the given contract.
create(DocumentSearchResultValueContract) - Static method in class org.kuali.rice.kew.framework.document.search.DocumentSearchResultValue.Builder: Creates a new builder instance initialized with copies of the properties from the given contract.
create(DocumentSearchResultValuesContract) - Static method in class org.kuali.rice.kew.framework.document.search.DocumentSearchResultValues.Builder: Creates a new builder instance initialized with copies of the properties from the given contract.
CRITERIA - Enum constant in enum class org.kuali.rice.kew.framework.document.search.DocumentSearchCustomization: Customization of the document search criteria.
customizeActionList(String, List<ActionItem>) - Method in interface org.kuali.rice.kew.framework.actionlist.ActionListCustomizationHandlerService: Returns a list of Action Item Customizations from the given list of Action Items and Principal ID.
customizeClearCriteria(DocumentSearchCriteria) - Method in interface org.kuali.rice.kew.framework.document.search.DocumentSearchCustomizer: Performs a customized "clear" of the given document search criteria.
customizeClearCriteria(DocumentSearchCriteria) - Method in class org.kuali.rice.kew.framework.document.search.DocumentSearchCustomizerBase: Always returns a null reference which instructs the document search framework that custom criteria clearing was not performed.
customizeClearCriteria(DocumentSearchCriteria, String) - Method in interface org.kuali.rice.kew.framework.document.search.DocumentSearchCustomizationHandlerService: Executes custom criteria clearing against the given criteria using the DocumentSearchCustomizer with the given customizer name.
customizeCriteria(DocumentSearchCriteria) - Method in interface org.kuali.rice.kew.framework.document.search.DocumentSearchCustomizer: Performs customization on the given document search criteria.
customizeCriteria(DocumentSearchCriteria) - Method in class org.kuali.rice.kew.framework.document.search.DocumentSearchCustomizerBase: Always returns a null reference which instructs the document search framework that the criteria was not customized.
customizeCriteria(DocumentSearchCriteria, String) - Method in interface org.kuali.rice.kew.framework.document.search.DocumentSearchCustomizationHandlerService: Executes criteria customization against the given criteria using the DocumentSearchCustomizer with the given customizer name.
customizeResults(DocumentSearchCriteria, List<DocumentSearchResult>) - Method in interface org.kuali.rice.kew.framework.document.search.DocumentSearchCustomizer: Performs customization of the given list of document search results.
customizeResults(DocumentSearchCriteria, List<DocumentSearchResult>) - Method in class org.kuali.rice.kew.framework.document.search.DocumentSearchCustomizerBase: Always returns a null reference which instructs the document search framework that the customization of results was not performed.
customizeResults(DocumentSearchCriteria, List<DocumentSearchResult>, String) - Method in interface org.kuali.rice.kew.framework.document.search.DocumentSearchCustomizationHandlerService: Executes customization of document search results using the DocumentSearchCustomizer with the given customizer name.
customizeResultSetConfiguration(DocumentSearchCriteria) - Method in interface org.kuali.rice.kew.framework.document.search.DocumentSearchCustomizer: Performs customization of what result fields should be displayed in the result set.
customizeResultSetConfiguration(DocumentSearchCriteria) - Method in class org.kuali.rice.kew.framework.document.search.DocumentSearchCustomizerBase: Always returns a null reference which instructs the document search framework that the customization of result set fields was not performed.
customizeResultSetConfiguration(DocumentSearchCriteria, String) - Method in interface org.kuali.rice.kew.framework.document.search.DocumentSearchCustomizationHandlerService: Executes customization of document search result set configuration using the DocumentSearchCustomizer with the given customizer name.

D

DATE_CREATED - Enum constant in enum class org.kuali.rice.kew.framework.document.search.StandardResultField
DefaultPostProcessor - Class in org.kuali.rice.kew.postprocessor: A simple default implementation of the PostProcessor which can be used as a superclass for post processor which don't want to implement all the methods on the interface.
DefaultPostProcessor() - Constructor for class org.kuali.rice.kew.postprocessor.DefaultPostProcessor
DELETE_CHANGE - Static variable in interface org.kuali.rice.kew.framework.postprocessor.IDocumentEvent
DeleteEvent - Class in org.kuali.rice.kew.framework.postprocessor
DeleteEvent(String, String) - Constructor for class org.kuali.rice.kew.framework.postprocessor.DeleteEvent
doActionTaken(ActionTakenEvent) - Method in interface org.kuali.rice.kew.framework.postprocessor.PostProcessor: Executed whenever an action is taken against the document.
doActionTaken(ActionTakenEvent) - Method in class org.kuali.rice.kew.postprocessor.DefaultPostProcessor
DOCSTATUS - Enum constant in enum class org.kuali.rice.kew.framework.document.security.DocumentTypeAuthorizer.ActionArgument
DOCUMENT_ID - Enum constant in enum class org.kuali.rice.kew.framework.document.search.StandardResultField
DOCUMENT_SEARCH_CUSTOMIZATION_HANDLER_SERVICE - Static variable in class org.kuali.rice.kew.framework.KewFrameworkServiceLocator
DOCUMENT_SECURITY_HANDLER_SERVICE - Static variable in class org.kuali.rice.kew.framework.KewFrameworkServiceLocator
DOCUMENT_TYPE - Enum constant in enum class org.kuali.rice.kew.framework.document.search.StandardResultField
DocumentLockingEvent - Class in org.kuali.rice.kew.framework.postprocessor: Event sent to the postprocessor when document locking ids are requested.
DocumentLockingEvent(String, String) - Constructor for class org.kuali.rice.kew.framework.postprocessor.DocumentLockingEvent
DocumentRouteLevelChange - Class in org.kuali.rice.kew.framework.postprocessor
DocumentRouteLevelChange(String, String, Integer, Integer) - Constructor for class org.kuali.rice.kew.framework.postprocessor.DocumentRouteLevelChange
DocumentRouteLevelChange(String, String, Integer, Integer, String, String, String, String) - Constructor for class org.kuali.rice.kew.framework.postprocessor.DocumentRouteLevelChange
DocumentRouteStatusChange - Class in org.kuali.rice.kew.framework.postprocessor
DocumentRouteStatusChange(String, String, String, String) - Constructor for class org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange
DocumentSearchCriteriaConfiguration - Class in org.kuali.rice.kew.framework.document.search: An immutable data transfer object implementation of the DocumentSearchCriteriaConfigurationContract.
DocumentSearchCriteriaConfiguration.Builder - Class in org.kuali.rice.kew.framework.document.search: A builder which can be used to construct DocumentSearchCriteriaConfiguration instances.
DocumentSearchCriteriaConfigurationContract - Interface in org.kuali.rice.kew.framework.document.search: Defines the contract for which specifies attribute fields that should be included as part of document search criteria on the document search user interface.
DocumentSearchCustomization - Enum Class in org.kuali.rice.kew.framework.document.search: An enumeration which defines the set of available document search customizations.
DocumentSearchCustomizationHandlerService - Interface in org.kuali.rice.kew.framework.document.search: A remotable service which handles processing of a client application's document search customizations.
DocumentSearchCustomizer - Interface in org.kuali.rice.kew.framework.document.search: Provides various mechanisms for an application to customize the behavior of the Document Search functionality for their document types.
DocumentSearchCustomizerBase - Class in org.kuali.rice.kew.framework.document.search: An abstract implementation of a DocumentSearchCustomizer which classes can extend from and override the individual methods that they require in order to perform desired customization.
DocumentSearchCustomizerBase() - Constructor for class org.kuali.rice.kew.framework.document.search.DocumentSearchCustomizerBase
DocumentSearchResultSetConfiguration - Class in org.kuali.rice.kew.framework.document.search: An immutable data transfer object implementation of the DocumentSearchResultSetConfigurationContract.
DocumentSearchResultSetConfiguration.Builder - Class in org.kuali.rice.kew.framework.document.search: A builder which can be used to construct DocumentSearchResultSetConfiguration instances.
DocumentSearchResultSetConfigurationContract - Interface in org.kuali.rice.kew.framework.document.search: Defines how the display of results on the document search should be customized and configured.
DocumentSearchResultValue - Class in org.kuali.rice.kew.framework.document.search: An immutable data transfer object implementation of the DocumentSearchResultValueContract.
DocumentSearchResultValue.Builder - Class in org.kuali.rice.kew.framework.document.search: A builder which can be used to construct DocumentSearchResultValue instances.
DocumentSearchResultValueContract - Interface in org.kuali.rice.kew.framework.document.search: Defines the contract for an object containing a customized result value for a specific document which is part of a set of document search results.
DocumentSearchResultValues - Class in org.kuali.rice.kew.framework.document.search: An immutable data transfer object implementation of the DocumentSearchResultValuesContract.
DocumentSearchResultValues.Builder - Class in org.kuali.rice.kew.framework.document.search: A builder which can be used to construct DocumentSearchResultValues instances.
DocumentSearchResultValuesContract - Interface in org.kuali.rice.kew.framework.document.search: Defines the contract for an object containing result values that are used to customize document search results.
DocumentSecurityAttribute - Interface in org.kuali.rice.kew.framework.document.security: This is an attribute used to implement custom document security for document search and the route log.
DocumentSecurityDirective - Class in org.kuali.rice.kew.framework.document.security: Defines a directive for processing a list of security attributes against a supplied list of documents.
DocumentSecurityHandlerService - Interface in org.kuali.rice.kew.framework.document.security: A remotable service which handles processing of a client application's custom security processing of workflow documents.
DocumentTypeAuthorizer - Interface in org.kuali.rice.kew.framework.document.security: Framework interface used by DocumentTypePermisionServiceAuthorizerImpl to allow applications to customize document routing permission checks.
DocumentTypeAuthorizer.ActionArgument - Enum Class in org.kuali.rice.kew.framework.document.security: Type of additional arguments for DocumentTypeAuthorizer.isActionAuthorized(AuthorizableAction, String, org.kuali.rice.kew.api.doctype.DocumentType, org.kuali.rice.kew.api.document.Document, java.util.Map)
doDeleteRouteHeader(DeleteEvent) - Method in interface org.kuali.rice.kew.framework.postprocessor.PostProcessor: Executed whenever a deletion of the document is required.
doDeleteRouteHeader(DeleteEvent) - Method in class org.kuali.rice.kew.postprocessor.DefaultPostProcessor
doRouteLevelChange(DocumentRouteLevelChange) - Method in interface org.kuali.rice.kew.framework.postprocessor.PostProcessor: Executed whenever the document transitions from one node to another.
doRouteLevelChange(DocumentRouteLevelChange) - Method in class org.kuali.rice.kew.postprocessor.DefaultPostProcessor
doRouteStatusChange(DocumentRouteStatusChange) - Method in interface org.kuali.rice.kew.framework.postprocessor.PostProcessor: Executed whenever the status of the document changes.
doRouteStatusChange(DocumentRouteStatusChange) - Method in class org.kuali.rice.kew.postprocessor.DefaultPostProcessor

E

extractDocumentAttributes(ExtensionDefinition, DocumentWithContent) - Method in interface org.kuali.rice.kew.framework.document.attribute.SearchableAttribute: Extracts and returns document attributes for the given document in order to allow indexing of those values for association with the document and use in document searches.

F

filterToSelectableRoleIds(String, List<String>) - Method in interface org.kuali.rice.kew.framework.peopleflow.PeopleFlowTypeService: Allows for the people flow to restrict the roles that can be selected when adding members to it.
fromFieldName(String) - Static method in enum class org.kuali.rice.kew.framework.document.search.StandardResultField

G

generateSearchContent(ExtensionDefinition, String, WorkflowAttributeDefinition) - Method in interface org.kuali.rice.kew.framework.document.attribute.SearchableAttribute: Allows for generation of custom XML for this searchable attribute.
getActionListCustomizationHandlerService(String) - Static method in class org.kuali.rice.kew.framework.KewFrameworkServiceLocator
getActionListCustomizationMediator() - Static method in class org.kuali.rice.kew.framework.KewFrameworkServiceLocator
getActionListCustomizations(String, List<ActionItem>) - Method in interface org.kuali.rice.kew.framework.actionlist.ActionListCustomizationMediator: Retrieves a Map from ActionItem id to ActionItemCustomization for the ActionItems provided.
getActionTaken() - Method in class org.kuali.rice.kew.framework.postprocessor.ActionTakenEvent
getAdditionalAttributeFields() - Method in class org.kuali.rice.kew.framework.document.search.DocumentSearchResultSetConfiguration.Builder
getAdditionalAttributeFields() - Method in class org.kuali.rice.kew.framework.document.search.DocumentSearchResultSetConfiguration
getAdditionalAttributeFields() - Method in interface org.kuali.rice.kew.framework.document.search.DocumentSearchResultSetConfigurationContract: Gets attribute field definitions for additional attributes that may be displayed in the result set.
getAdditionalFieldNames() - Method in enum class org.kuali.rice.kew.framework.document.search.StandardResultField: Returns additional field names that are valid and can be used to represent this standard result field as a string.
getAppDocId() - Method in class org.kuali.rice.kew.framework.postprocessor.ActionTakenEvent
getAppDocId() - Method in class org.kuali.rice.kew.framework.postprocessor.AfterProcessEvent
getAppDocId() - Method in class org.kuali.rice.kew.framework.postprocessor.BeforeProcessEvent
getAppDocId() - Method in class org.kuali.rice.kew.framework.postprocessor.DeleteEvent
getAppDocId() - Method in class org.kuali.rice.kew.framework.postprocessor.DocumentLockingEvent
getAppDocId() - Method in class org.kuali.rice.kew.framework.postprocessor.DocumentRouteLevelChange
getAppDocId() - Method in class org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange
getAppDocId() - Method in interface org.kuali.rice.kew.framework.postprocessor.IDocumentEvent
getAttributeFields() - Method in class org.kuali.rice.kew.framework.rule.attribute.WorkflowRuleAttributeFields
getAttributeFields(String) - Method in interface org.kuali.rice.kew.framework.peopleflow.PeopleFlowTypeService: get the attributes supported by the people flow type with the given kewTypeId.
getAttributeName() - Method in class org.kuali.rice.kew.framework.document.search.AttributeFields: Returns the name of the searchable attribute associated with this attribute fields instance.
getAuthorizedDocumentIds(String, List<DocumentSecurityDirective>) - Method in interface org.kuali.rice.kew.framework.document.security.DocumentSecurityHandlerService: Returns a list of document ids from the given list of document security directives for which the principal with the given principal id is allowed to view.
getCustomFieldNamesToAdd() - Method in class org.kuali.rice.kew.framework.document.search.DocumentSearchResultSetConfiguration.Builder
getCustomFieldNamesToAdd() - Method in class org.kuali.rice.kew.framework.document.search.DocumentSearchResultSetConfiguration
getCustomFieldNamesToAdd() - Method in interface org.kuali.rice.kew.framework.document.search.DocumentSearchResultSetConfigurationContract: Returns a list of field names of custom fields representing document attributes which should be added to the result set.
getDocumentAttributes() - Method in class org.kuali.rice.kew.framework.document.search.DocumentSearchResultValue.Builder
getDocumentAttributes() - Method in class org.kuali.rice.kew.framework.document.search.DocumentSearchResultValue
getDocumentAttributes() - Method in interface org.kuali.rice.kew.framework.document.search.DocumentSearchResultValueContract: Returns the customized document attribute values for this document search result.
getDocumentEventCode() - Method in class org.kuali.rice.kew.framework.postprocessor.ActionTakenEvent
getDocumentEventCode() - Method in class org.kuali.rice.kew.framework.postprocessor.AfterProcessEvent
getDocumentEventCode() - Method in class org.kuali.rice.kew.framework.postprocessor.BeforeProcessEvent
getDocumentEventCode() - Method in class org.kuali.rice.kew.framework.postprocessor.DeleteEvent
getDocumentEventCode() - Method in class org.kuali.rice.kew.framework.postprocessor.DocumentLockingEvent
getDocumentEventCode() - Method in class org.kuali.rice.kew.framework.postprocessor.DocumentRouteLevelChange
getDocumentEventCode() - Method in class org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange
getDocumentEventCode() - Method in interface org.kuali.rice.kew.framework.postprocessor.IDocumentEvent
getDocumentId() - Method in class org.kuali.rice.kew.framework.document.search.DocumentSearchResultValue.Builder
getDocumentId() - Method in class org.kuali.rice.kew.framework.document.search.DocumentSearchResultValue
getDocumentId() - Method in interface org.kuali.rice.kew.framework.document.search.DocumentSearchResultValueContract: Returns the id of the document for which this customized result value applies.
getDocumentId() - Method in class org.kuali.rice.kew.framework.postprocessor.ActionTakenEvent
getDocumentId() - Method in class org.kuali.rice.kew.framework.postprocessor.AfterProcessEvent
getDocumentId() - Method in class org.kuali.rice.kew.framework.postprocessor.BeforeProcessEvent
getDocumentId() - Method in class org.kuali.rice.kew.framework.postprocessor.DeleteEvent
getDocumentId() - Method in class org.kuali.rice.kew.framework.postprocessor.DocumentLockingEvent
getDocumentId() - Method in class org.kuali.rice.kew.framework.postprocessor.DocumentRouteLevelChange
getDocumentId() - Method in class org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange
getDocumentId() - Method in interface org.kuali.rice.kew.framework.postprocessor.IDocumentEvent
getDocumentIdsToLock(DocumentLockingEvent) - Method in interface org.kuali.rice.kew.framework.postprocessor.PostProcessor: Executed prior to document locking in the workflow engine.
getDocumentIdsToLock(DocumentLockingEvent) - Method in class org.kuali.rice.kew.postprocessor.DefaultPostProcessor
getDocuments() - Method in class org.kuali.rice.kew.framework.document.security.DocumentSecurityDirective: Returns the list of documents on this security directive.
getDocumentSearchConfiguration(String, List<String>) - Method in interface org.kuali.rice.kew.framework.document.search.DocumentSearchCustomizationHandlerService: Retrieves the custom DocumentSearchCriteriaConfiguration to use for the document type with the given name and for the given list of searchable attributes.
getDocumentSearchCustomizationHandlerService(String) - Static method in class org.kuali.rice.kew.framework.KewFrameworkServiceLocator
getDocumentSecurityAttributeNames() - Method in class org.kuali.rice.kew.framework.document.security.DocumentSecurityDirective: Returns the list of document security attribute names on this security directive.
getDocumentSecurityHandlerService(String) - Static method in class org.kuali.rice.kew.framework.KewFrameworkServiceLocator
getEnabledCustomizations(String, String) - Method in interface org.kuali.rice.kew.framework.document.search.DocumentSearchCustomizationHandlerService: Returns the set of customizations that are enabled and should be executed for the DocumentSearchCustomizer with the given customizer name.
getFlattenedSearchAttributeFields() - Method in class org.kuali.rice.kew.framework.document.search.DocumentSearchCriteriaConfiguration
getKey() - Method in class org.kuali.rice.kew.framework.actionlist.MapStringActionItemCustomizationAdapter.StringActionItemCustomizationMapEntry
getMessage() - Method in class org.kuali.rice.kew.framework.postprocessor.ProcessDocReport
getNewNodeInstanceId() - Method in class org.kuali.rice.kew.framework.postprocessor.DocumentRouteLevelChange
getNewNodeName() - Method in class org.kuali.rice.kew.framework.postprocessor.DocumentRouteLevelChange
getNewRouteLevel() - Method in class org.kuali.rice.kew.framework.postprocessor.DocumentRouteLevelChange
getNewRouteStatus() - Method in class org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange
getOldNodeInstanceId() - Method in class org.kuali.rice.kew.framework.postprocessor.DocumentRouteLevelChange
getOldNodeName() - Method in class org.kuali.rice.kew.framework.postprocessor.DocumentRouteLevelChange
getOldRouteLevel() - Method in class org.kuali.rice.kew.framework.postprocessor.DocumentRouteLevelChange
getOldRouteStatus() - Method in class org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange
getProcessException() - Method in class org.kuali.rice.kew.framework.postprocessor.ProcessDocReport
getReason() - Method in class org.kuali.rice.kew.framework.document.security.Authorization
getRemotableAttributeFields() - Method in class org.kuali.rice.kew.framework.document.search.AttributeFields: Returns a list of remotable attribute fields associated with the searchable attribute name of this instance.
getResultValues() - Method in class org.kuali.rice.kew.framework.document.search.DocumentSearchResultValues.Builder
getResultValues() - Method in class org.kuali.rice.kew.framework.document.search.DocumentSearchResultValues
getResultValues() - Method in interface org.kuali.rice.kew.framework.document.search.DocumentSearchResultValuesContract: Returns an unmodifiable list of the result values, one for each customized document.
getRoleNames(ExtensionDefinition) - Method in interface org.kuali.rice.kew.framework.rule.attribute.WorkflowRuleAttributeHandlerService: Gets a List of RoleName objects produced by the RoleAttribute defined by the given extension definition.
getRoutingDataFields(Map<String, String>, ExtensionDefinition, boolean) - Method in interface org.kuali.rice.kew.framework.rule.attribute.WorkflowRuleAttributeHandlerService: Using the WorkflowRuleAttribute defined by the given extension definition, does the following: validates the given rule attribute parameters, fetches the list of RemotableAttributeField objects to display for rule reporting then determines the rule extension values produced by the attribute and returns this information as a WorkflowRuleAttributeFields object.
getRuleExtensionValues() - Method in class org.kuali.rice.kew.framework.rule.attribute.WorkflowRuleAttributeFields
getRuleFields(Map<String, String>, ExtensionDefinition, boolean) - Method in interface org.kuali.rice.kew.framework.rule.attribute.WorkflowRuleAttributeHandlerService: Using the WorkflowRuleAttribute defined by the given extension definition, does the following: validates the given rule attribute parameters, fetches the list of RemotableAttributeField objects to display for the rule, and then determines the rule extension values produced by the attribute and returns this information as a WorkflowRuleAttributeFields object.
getRuleValidationAttributeExporterService(String) - Static method in class org.kuali.rice.kew.framework.KewFrameworkServiceLocator
getSearchAttributeFields() - Method in class org.kuali.rice.kew.framework.document.search.DocumentSearchCriteriaConfiguration.Builder
getSearchAttributeFields() - Method in class org.kuali.rice.kew.framework.document.search.DocumentSearchCriteriaConfiguration
getSearchAttributeFields() - Method in interface org.kuali.rice.kew.framework.document.search.DocumentSearchCriteriaConfigurationContract: Returns the additional attribute fields that should be included as part of the document search criteria on the document search user interface.
getSearchFields(Map<String, String>, ExtensionDefinition, boolean) - Method in interface org.kuali.rice.kew.framework.rule.attribute.WorkflowRuleAttributeHandlerService: Using the WorkflowRuleAttribute defined by the given extension definition, does the following: validates the given rule attribute parameters, fetches the list of RemotableAttributeField objects to display for the rule search, and then determines the rule extension values produced by the attribute and returns this information as a WorkflowRuleAttributeFields object.
getSearchFields(ExtensionDefinition, String) - Method in interface org.kuali.rice.kew.framework.document.attribute.SearchableAttribute: Returns a list of RemotableAttributeField objects which define which searchable attribute criteria fields should be included in the criteria section of the document search user interface for this searchable attribute.
getStandardFieldName() - Method in enum class org.kuali.rice.kew.framework.document.search.StandardResultField: Returns the standard field name of this standard result field as a string.
getStandardResultFieldsToRemove() - Method in class org.kuali.rice.kew.framework.document.search.DocumentSearchResultSetConfiguration.Builder
getStandardResultFieldsToRemove() - Method in class org.kuali.rice.kew.framework.document.search.DocumentSearchResultSetConfiguration
getStandardResultFieldsToRemove() - Method in interface org.kuali.rice.kew.framework.document.search.DocumentSearchResultSetConfigurationContract: Returns a list of the standard (built-in) document search result fields which should not be displayed in the result set.
getValidationErrors() - Method in class org.kuali.rice.kew.framework.rule.attribute.WorkflowRuleAttributeFields
getValue() - Method in class org.kuali.rice.kew.framework.actionlist.MapStringActionItemCustomizationAdapter.StringActionItemCustomizationMapEntry
getWorkflowRuleAttributeHandlerService(String) - Static method in class org.kuali.rice.kew.framework.KewFrameworkServiceLocator

I

IDocumentEvent - Interface in org.kuali.rice.kew.framework.postprocessor: Base event interface for events emitted from the workflow engine and hooked by the PostProcessor
INITIATION - Enum constant in enum class org.kuali.rice.kew.framework.document.security.AuthorizableAction.CheckType
INITIATOR - Enum constant in enum class org.kuali.rice.kew.framework.document.search.StandardResultField
isActionAuthorized(AuthorizableAction, String, DocumentType, Document, Map<DocumentTypeAuthorizer.ActionArgument, Object>) - Method in interface org.kuali.rice.kew.framework.document.security.DocumentTypeAuthorizer: Check whether specified action is authorized.
isAuthorized() - Method in class org.kuali.rice.kew.framework.document.security.Authorization
isAuthorizedForDocument(String, Document) - Method in interface org.kuali.rice.kew.framework.document.security.DocumentSecurityAttribute: Determines whether or not a principal is authorized to see information about a given document.
isCustomizeClearCriteriaEnabled(String) - Method in interface org.kuali.rice.kew.framework.document.search.DocumentSearchCustomizer: Indicates if the DocumentSearchCustomizer.customizeClearCriteria(org.kuali.rice.kew.api.document.search.DocumentSearchCriteria) on this customizer should be invoked for the document type with the given name.
isCustomizeClearCriteriaEnabled(String) - Method in class org.kuali.rice.kew.framework.document.search.DocumentSearchCustomizerBase: Always returns false indicating that criteria clearing customization is disabled and should not be performed.
isCustomizeCriteriaEnabled(String) - Method in interface org.kuali.rice.kew.framework.document.search.DocumentSearchCustomizer: Indicates if the DocumentSearchCustomizer.customizeCriteria(org.kuali.rice.kew.api.document.search.DocumentSearchCriteria) on this customizer should be invoked for the document type with the given name.
isCustomizeCriteriaEnabled(String) - Method in class org.kuali.rice.kew.framework.document.search.DocumentSearchCustomizerBase: Always returns false indicating that criteria customization is disabled and should not be performed.
isCustomizeResultsEnabled(String) - Method in interface org.kuali.rice.kew.framework.document.search.DocumentSearchCustomizer: Indicates if the DocumentSearchCustomizer.customizeResults(org.kuali.rice.kew.api.document.search.DocumentSearchCriteria, java.util.List) on this customizer should be invoked for the document type with the given name.
isCustomizeResultsEnabled(String) - Method in class org.kuali.rice.kew.framework.document.search.DocumentSearchCustomizerBase: Always returns false indicating that results customization is disabled and should not be performed.
isCustomizeResultSetFieldsEnabled(String) - Method in interface org.kuali.rice.kew.framework.document.search.DocumentSearchCustomizer: Indicates if the DocumentSearchCustomizer.customizeResultSetConfiguration(org.kuali.rice.kew.api.document.search.DocumentSearchCriteria) on this customizer should be invoked for the document type with the given name.
isCustomizeResultSetFieldsEnabled(String) - Method in class org.kuali.rice.kew.framework.document.search.DocumentSearchCustomizerBase: Always returns false indicating that result set field customization is disabled and should not be performed.
isFieldNameValid(String) - Method in enum class org.kuali.rice.kew.framework.document.search.StandardResultField: Returns true if the given field name represents a valid field name for this standard result field.
isOverrideSearchableAttributes() - Method in class org.kuali.rice.kew.framework.document.search.DocumentSearchResultSetConfiguration.Builder
isOverrideSearchableAttributes() - Method in class org.kuali.rice.kew.framework.document.search.DocumentSearchResultSetConfiguration
isOverrideSearchableAttributes() - Method in interface org.kuali.rice.kew.framework.document.search.DocumentSearchResultSetConfigurationContract: Returns true if the custom field names returned by DocumentSearchResultSetConfigurationContract.getCustomFieldNamesToAdd() should be used to define the order of searchable attributes as well as additional custom additional fields.
isSuccess() - Method in class org.kuali.rice.kew.framework.postprocessor.ProcessDocReport
isSuccessfullyProcessed() - Method in class org.kuali.rice.kew.framework.postprocessor.AfterProcessEvent

K

KewFrameworkServiceLocator - Class in org.kuali.rice.kew.framework: A static service locator which aids in locating the various KEW framework services.
KewFrameworkServiceLocator() - Constructor for class org.kuali.rice.kew.framework.KewFrameworkServiceLocator

L

LOCK_DOCUMENTS - Static variable in interface org.kuali.rice.kew.framework.postprocessor.IDocumentEvent

M

MapStringActionItemCustomizationAdapter - Class in org.kuali.rice.kew.framework.actionlist: Do jax-ws mapping of Mapinvalid input: '<'String, ActionItemCustomization> for KIM service method parameters, etc.
MapStringActionItemCustomizationAdapter() - Constructor for class org.kuali.rice.kew.framework.actionlist.MapStringActionItemCustomizationAdapter
MapStringActionItemCustomizationAdapter.StringActionItemCustomizationMapEntry - Class in org.kuali.rice.kew.framework.actionlist
marshal(Map<String, ActionItemCustomization>) - Method in class org.kuali.rice.kew.framework.actionlist.MapStringActionItemCustomizationAdapter: converts the map to an array

N

NullDocumentSearchCustomizer - Class in org.kuali.rice.kew.framework.document.search: A simple implementation of DocumentSearchCustomizer which performs no customization.
NullDocumentSearchCustomizer() - Constructor for class org.kuali.rice.kew.framework.document.search.NullDocumentSearchCustomizer

O

org.kuali.rice.kew.framework - package org.kuali.rice.kew.framework
org.kuali.rice.kew.framework.actionlist - package org.kuali.rice.kew.framework.actionlist
org.kuali.rice.kew.framework.document.attribute - package org.kuali.rice.kew.framework.document.attribute
org.kuali.rice.kew.framework.document.search - package org.kuali.rice.kew.framework.document.search
org.kuali.rice.kew.framework.document.security - package org.kuali.rice.kew.framework.document.security
org.kuali.rice.kew.framework.peopleflow - package org.kuali.rice.kew.framework.peopleflow
org.kuali.rice.kew.framework.postprocessor - package org.kuali.rice.kew.framework.postprocessor
org.kuali.rice.kew.framework.rule.attribute - package org.kuali.rice.kew.framework.rule.attribute
org.kuali.rice.kew.framework.validation - package org.kuali.rice.kew.framework.validation
org.kuali.rice.kew.postprocessor - package org.kuali.rice.kew.postprocessor

P

PeopleFlowTypeService - Interface in org.kuali.rice.kew.framework.peopleflow: Interface for services that implement the type-specific behaviors of people flows.
PostProcessor - Interface in org.kuali.rice.kew.framework.postprocessor: Hook for applications to perform logic due to workflow events from the engine.
ProcessDocReport - Class in org.kuali.rice.kew.framework.postprocessor: Returned from a PostProcessor to indicate success of failure of a particular event.
ProcessDocReport(boolean) - Constructor for class org.kuali.rice.kew.framework.postprocessor.ProcessDocReport
ProcessDocReport(boolean, String) - Constructor for class org.kuali.rice.kew.framework.postprocessor.ProcessDocReport
ProcessDocReport(boolean, String, Exception) - Constructor for class org.kuali.rice.kew.framework.postprocessor.ProcessDocReport

R

resolveMultipleRoleQualifiers(String, String, Document, DocumentContent) - Method in interface org.kuali.rice.kew.framework.peopleflow.PeopleFlowTypeService: Resolve any role qualifiers for the given roleId, and document (along with documentContent).
resolveRoleQualifiers(String, String, Document, DocumentContent) - Method in interface org.kuali.rice.kew.framework.peopleflow.PeopleFlowTypeService: Resolve any role qualifiers for the given roleId, and document (along with documentContent).
RESULT_SET_FIELDS - Enum constant in enum class org.kuali.rice.kew.framework.document.search.DocumentSearchCustomization: Customization of the document search result attribute fields.
RESULTS - Enum constant in enum class org.kuali.rice.kew.framework.document.search.DocumentSearchCustomization: Customization of document search results.
ROUTE_LEVEL_CHANGE - Static variable in interface org.kuali.rice.kew.framework.postprocessor.IDocumentEvent
ROUTE_LOG - Enum constant in enum class org.kuali.rice.kew.framework.document.search.StandardResultField
ROUTE_STATUS_CHANGE - Static variable in interface org.kuali.rice.kew.framework.postprocessor.IDocumentEvent
ROUTENODE_NAMES - Enum constant in enum class org.kuali.rice.kew.framework.document.security.DocumentTypeAuthorizer.ActionArgument
RULE_VALIDATION_ATTRIBUTE_EXPORTER_SERVICE - Static variable in class org.kuali.rice.kew.framework.KewFrameworkServiceLocator
RuleValidationAttributeExporterService - Interface in org.kuali.rice.kew.framework.validation: Service responsible for exposing custom RuleValidationAttribute functionality.

S

SearchableAttribute - Interface in org.kuali.rice.kew.framework.document.attribute: Allows for definition of custom attributes on a document that should be indexed along with that document and made searchable when performing document searches.
setAdditionalAttributeFields(List<RemotableAttributeField.Builder>) - Method in class org.kuali.rice.kew.framework.document.search.DocumentSearchResultSetConfiguration.Builder
setCustomFieldNamesToAdd(List<String>) - Method in class org.kuali.rice.kew.framework.document.search.DocumentSearchResultSetConfiguration.Builder
setDocumentAttributes(List<DocumentAttribute.AbstractBuilder<?>>) - Method in class org.kuali.rice.kew.framework.document.search.DocumentSearchResultValue.Builder: Sets the list of document attribute builders on this builder to the given list.
setDocumentId(String) - Method in class org.kuali.rice.kew.framework.document.search.DocumentSearchResultValue.Builder: Sets the document id on this builder to the given value.
setOverrideSearchableAttributes(boolean) - Method in class org.kuali.rice.kew.framework.document.search.DocumentSearchResultSetConfiguration.Builder
setResultValues(List<DocumentSearchResultValue.Builder>) - Method in class org.kuali.rice.kew.framework.document.search.DocumentSearchResultValues.Builder
setSearchAttributeFields(List<AttributeFields>) - Method in class org.kuali.rice.kew.framework.document.search.DocumentSearchCriteriaConfiguration.Builder: Sets the search attribute fields on this builder to the given list of attribute fields.
setStandardResultFieldsToRemove(List<StandardResultField>) - Method in class org.kuali.rice.kew.framework.document.search.DocumentSearchResultSetConfiguration.Builder
StandardResultField - Enum Class in org.kuali.rice.kew.framework.document.search: An enumeration which defines fields that are used on the document search screen and subject to customization by specific document types which configure such customizations via the document search framework.
STATUS - Enum constant in enum class org.kuali.rice.kew.framework.document.search.StandardResultField
StringActionItemCustomizationMapEntry() - Constructor for class org.kuali.rice.kew.framework.actionlist.MapStringActionItemCustomizationAdapter.StringActionItemCustomizationMapEntry: constructor used by JAXB.
StringActionItemCustomizationMapEntry(String, ActionItemCustomization) - Constructor for class org.kuali.rice.kew.framework.actionlist.MapStringActionItemCustomizationAdapter.StringActionItemCustomizationMapEntry
SU_APPROVE_ACTION_REQUEST - Enum constant in enum class org.kuali.rice.kew.framework.document.security.AuthorizableAction.CheckType

T

TITLE - Enum constant in enum class org.kuali.rice.kew.framework.document.search.StandardResultField
toString() - Method in class org.kuali.rice.kew.framework.postprocessor.DocumentRouteLevelChange
toString() - Method in class org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange
type - Variable in class org.kuali.rice.kew.framework.document.security.AuthorizableAction: The CheckType

U

unmarshal(MapStringActionItemCustomizationAdapter.StringActionItemCustomizationMapEntry[]) - Method in class org.kuali.rice.kew.framework.actionlist.MapStringActionItemCustomizationAdapter: converts the array back to a map

V

validate(String, RuleValidationContext) - Method in interface org.kuali.rice.kew.framework.validation.RuleValidationAttributeExporterService: Validates the rule within the given RuleValidationContext.
validateAttributes(String, Map<String, String>) - Method in interface org.kuali.rice.kew.framework.peopleflow.PeopleFlowTypeService: This method validates the passed in attributes for a kewTypeId generating a List of RemotableAttributeErrors.
validateAttributesAgainstExisting(String, Map<String, String>, Map<String, String>) - Method in interface org.kuali.rice.kew.framework.peopleflow.PeopleFlowTypeService: This method validates the passed in attributes for a kewTypeId generating a List of RemotableAttributeErrors.
validateCriteria(DocumentSearchCriteria, List<String>) - Method in interface org.kuali.rice.kew.framework.document.search.DocumentSearchCustomizationHandlerService: Executes validation of the given DocumentSearchCriteria against the searchable attributes with the given names..
validateDocumentAttributeCriteria(ExtensionDefinition, DocumentSearchCriteria) - Method in interface org.kuali.rice.kew.framework.document.attribute.SearchableAttribute: Performs custom validation of document attribute values that come from this searchable attribute whenever a document search is performed against a document type which uses this searchable attribute.
valueOf(String) - Static method in enum class org.kuali.rice.kew.framework.document.search.DocumentSearchCustomization: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.kuali.rice.kew.framework.document.search.StandardResultField: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.kuali.rice.kew.framework.document.security.AuthorizableAction.CheckType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.kuali.rice.kew.framework.document.security.DocumentTypeAuthorizer.ActionArgument: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.kuali.rice.kew.framework.document.search.DocumentSearchCustomization: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.kuali.rice.kew.framework.document.search.StandardResultField: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.kuali.rice.kew.framework.document.security.AuthorizableAction.CheckType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.kuali.rice.kew.framework.document.security.DocumentTypeAuthorizer.ActionArgument: Returns an array containing the constants of this enum class, in the order they are declared.

W

WORKFLOW_RULE_ATTRIBUTE_HANDLER_SERVICE - Static variable in class org.kuali.rice.kew.framework.KewFrameworkServiceLocator
WorkflowRuleAttributeFields - Class in org.kuali.rice.kew.framework.rule.attribute: An immutable data transfer object used to hold a list of validation errors, attribute fields, and rule extension values for a WorkflowRuleAttribute.
WorkflowRuleAttributeHandlerService - Interface in org.kuali.rice.kew.framework.rule.attribute: A remotable service which handles processing of a client application's document search customizations.

A B C D E F G I K L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form