Class ActionListServiceImpl
java.lang.Object
org.kuali.rice.kew.actionlist.service.impl.ActionListServiceImpl
- All Implemented Interfaces:
ActionListService
Default implementation of the
ActionListService.- Author:
- Kuali Rice Team (rice.collab@kuali.org)
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected ActionListDAOprotected ActionRequestServiceprotected org.kuali.rice.krad.data.DataObjectServiceprotected org.kuali.rice.core.api.datetime.DateTimeServiceprotected DocumentTypeServiceprotected NotificationServiceprotected RouteHeaderServiceprotected UserOptionsService -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected voidapplyPrimaryDelegationCriteria(String actionListUserPrincipalId, ActionListFilter filter, Collection<org.kuali.rice.core.api.criteria.Predicate> crit, List<String> filteredByItems) protected TimestampbeginningOfDay(Date date) createActionItemForActionRequest(ActionRequestValue actionRequest) protected Collection<ActionItem> createActionListForRouteHeader(Collection<ActionItem> actionItems) Creates an Action List from the given collection of Action Items.voiddeleteActionItem(ActionItem actionItem) voiddeleteActionItem(ActionItem actionItem, boolean forceIntoOutbox) protected voiddeleteActionItem(ActionItem actionItem, boolean forceIntoOutbox, boolean putInOutbox) voiddeleteActionItemNoOutbox(ActionItem actionItem) voiddeleteByDocumentId(String documentId) protected TimestampfindByActionItemId(String actionItemId) findByActionRequestId(String actionRequestId) findByDocumentId(String documentId) findByDocumentTypeName(String documentTypeName) findByPrincipalId(String principalId) findByWorkflowUserDocumentId(String workflowUserId, String documentId) findUserPrimaryDelegations(String principalId) Retruns a list of recipients which are primary-delegated to by the source principalIdfindUserSecondaryDelegators(String principalId) Returns a list of recipients which secondary-delegate to the target principalIdgetActionList(String principalId, ActionListFilter filter) getActionListForSingleDocument(String documentId) protected Collection<DocumentType> getAllChildDocumentTypes(DocumentType docType) intRetrieves the number of Action List items in the given user's primary Action List (does not include secondary delegations)org.kuali.rice.kim.api.group.GroupServicegetMaxActionItemDateAssignedAndCountForUser(String principalId) Retrieves the max action item Id and the total number of action items for the given user's primary Action List (does not include secondary delegations)getMinimalRouteHeader(String documentId) Pulls a proxied version of the document route header with only the properties needed by the action list display.getOutbox(String principalId, ActionListFilter filter) RetrievesOutboxItemitems for the given userprotected OutboxItemgetOutboxItemByDocumentIdUserId(String documentId, String principalId) getOutboxItemsByDocumentType(String documentTypeName) protected List<org.kuali.rice.core.api.criteria.Predicate> handleActionItemCriteria(String principalId, ActionListFilter filter, List<String> filteredByItems) protected voidhandleActionRequestedCriteria(ActionListFilter filter, Collection<org.kuali.rice.core.api.criteria.Predicate> crit, List<String> filteredByItems) protected voidhandleAssignedDateCriteria(ActionListFilter filter, Collection<org.kuali.rice.core.api.criteria.Predicate> crit, List<String> filteredByItems) protected voidhandleDateCriteria(String propertyPath, String filterLabel, Date fromDate, Date toDate, boolean excludeDates, Collection<org.kuali.rice.core.api.criteria.Predicate> crit, List<String> filteredByItems) protected voidhandleDocumentCreateDateCriteria(ActionListFilter filter, Collection<org.kuali.rice.core.api.criteria.Predicate> crit, List<String> filteredByItems) protected voidhandleDocumentTitleCriteria(ActionListFilter filter, Collection<org.kuali.rice.core.api.criteria.Predicate> crit, List<String> filteredByItems) protected voidhandleDocumentTypeCriteria(ActionListFilter filter, Collection<org.kuali.rice.core.api.criteria.Predicate> crit, List<String> filteredByItems) protected booleanhandlePrimaryDelegation(String actionListUserPrincipalId, ActionListFilter filter, Collection<org.kuali.rice.core.api.criteria.Predicate> crit, List<String> filteredByItems) Apply criteria related to primary delegations.protected voidhandleRecipientCriteria(String actionListUserPrincipalId, ActionListFilter filter, Collection<org.kuali.rice.core.api.criteria.Predicate> crit, List<String> filteredByItems) Handle the general recipient criteria (user, delegate)protected voidhandleRouteStatusCriteria(ActionListFilter filter, Collection<org.kuali.rice.core.api.criteria.Predicate> crit, List<String> filteredByItems) protected booleanhandleSecondaryDelegation(String actionListUserPrincipalId, ActionListFilter filter, Collection<org.kuali.rice.core.api.criteria.Predicate> crit, List<String> filteredByItems) Apply criteria related to secondary delegations.protected voidhandleWorkgroupCriteria(ActionListFilter filter, Collection<org.kuali.rice.core.api.criteria.Predicate> crit, List<String> filteredByItems) voidremoveOutboxItems(String principalId, List<String> outboxItems) saveActionItem(ActionItem actionItem) protected <T extends ActionItemBase>
TsaveActionItemBase(T actionItemBase) saveOutboxItem(ActionItem actionItem) saveOutboxItem(ActionItem actionItem, boolean forceIntoOutbox) save the ouboxitem unless the document is saved or the user already has the item in their outbox.saveOutboxItem(OutboxItem outboxItem) voidsetActionListDAO(ActionListDAO actionListDAO) voidsetActionRequestService(ActionRequestService actionRequestService) voidsetDataObjectService(org.kuali.rice.krad.data.DataObjectService dataObjectService) voidsetDateTimeService(org.kuali.rice.core.api.datetime.DateTimeService dateTimeService) voidsetDocumentTypeService(DocumentTypeService documentTypeService) voidsetNotificationService(NotificationService notificationService) voidsetRouteHeaderService(RouteHeaderService routeHeaderService) voidsetUserOptionsService(UserOptionsService userOptionsService) voidupdateActionItemsForTitleChange(String documentId, String newTitle)
-
Field Details
-
dataObjectService
protected org.kuali.rice.krad.data.DataObjectService dataObjectService -
notificationService
-
dateTimeService
protected org.kuali.rice.core.api.datetime.DateTimeService dateTimeService -
actionRequestService
-
documentTypeService
-
userOptionsService
-
routeHeaderService
-
actionListDAO
-
-
Constructor Details
-
ActionListServiceImpl
public ActionListServiceImpl()
-
-
Method Details
-
findUserSecondaryDelegators
Description copied from interface:ActionListServiceReturns a list of recipients which secondary-delegate to the target principalId- Specified by:
findUserSecondaryDelegatorsin interfaceActionListService- Parameters:
principalId- the target principalId/delegate- Returns:
- a list of recipients which secondary-delegate to the target principalId
-
findUserPrimaryDelegations
Description copied from interface:ActionListServiceRetruns a list of recipients which are primary-delegated to by the source principalId- Specified by:
findUserPrimaryDelegationsin interfaceActionListService- Parameters:
principalId- the source principalId to query for primary delegates- Returns:
- a list of recipients which are primary-delegated to by the source principalId
-
getActionList
- Specified by:
getActionListin interfaceActionListService
-
handleActionItemCriteria
protected List<org.kuali.rice.core.api.criteria.Predicate> handleActionItemCriteria(String principalId, ActionListFilter filter, List<String> filteredByItems) -
handleActionRequestedCriteria
protected void handleActionRequestedCriteria(ActionListFilter filter, Collection<org.kuali.rice.core.api.criteria.Predicate> crit, List<String> filteredByItems) -
handleDateCriteria
-
handleDocumentCreateDateCriteria
protected void handleDocumentCreateDateCriteria(ActionListFilter filter, Collection<org.kuali.rice.core.api.criteria.Predicate> crit, List<String> filteredByItems) -
handleAssignedDateCriteria
protected void handleAssignedDateCriteria(ActionListFilter filter, Collection<org.kuali.rice.core.api.criteria.Predicate> crit, List<String> filteredByItems) -
handleRouteStatusCriteria
protected void handleRouteStatusCriteria(ActionListFilter filter, Collection<org.kuali.rice.core.api.criteria.Predicate> crit, List<String> filteredByItems) -
handleDocumentTitleCriteria
protected void handleDocumentTitleCriteria(ActionListFilter filter, Collection<org.kuali.rice.core.api.criteria.Predicate> crit, List<String> filteredByItems) -
handleDocumentTypeCriteria
protected void handleDocumentTypeCriteria(ActionListFilter filter, Collection<org.kuali.rice.core.api.criteria.Predicate> crit, List<String> filteredByItems) -
getAllChildDocumentTypes
-
handleWorkgroupCriteria
protected void handleWorkgroupCriteria(ActionListFilter filter, Collection<org.kuali.rice.core.api.criteria.Predicate> crit, List<String> filteredByItems) -
applyPrimaryDelegationCriteria
protected void applyPrimaryDelegationCriteria(String actionListUserPrincipalId, ActionListFilter filter, Collection<org.kuali.rice.core.api.criteria.Predicate> crit, List<String> filteredByItems) -
handlePrimaryDelegation
protected boolean handlePrimaryDelegation(String actionListUserPrincipalId, ActionListFilter filter, Collection<org.kuali.rice.core.api.criteria.Predicate> crit, List<String> filteredByItems) Apply criteria related to primary delegations. Called only after detecting that the user is filtering on primary validations.- Returns:
- true if any criteria were applied, false otherwise
-
handleSecondaryDelegation
protected boolean handleSecondaryDelegation(String actionListUserPrincipalId, ActionListFilter filter, Collection<org.kuali.rice.core.api.criteria.Predicate> crit, List<String> filteredByItems) Apply criteria related to secondary delegations. Called only after detecting that the user is filtering on secondary validations.- Returns:
- true if any criteria were applied, false otherwise
-
handleRecipientCriteria
protected void handleRecipientCriteria(String actionListUserPrincipalId, ActionListFilter filter, Collection<org.kuali.rice.core.api.criteria.Predicate> crit, List<String> filteredByItems) Handle the general recipient criteria (user, delegate)- Parameters:
actionListUserPrincipalId-filter-crit-filteredByItems-
-
getActionListForSingleDocument
- Specified by:
getActionListForSingleDocumentin interfaceActionListService
-
createActionListForRouteHeader
Creates an Action List from the given collection of Action Items. The Action List should contain only one action item per user. The action item chosen should be the most "critical" or "important" one on the document.- Returns:
- the Action List as a Collection of ActionItems
-
setActionListDAO
-
getActionListDAO
-
deleteActionItemNoOutbox
- Specified by:
deleteActionItemNoOutboxin interfaceActionListService
-
deleteActionItem
- Specified by:
deleteActionItemin interfaceActionListService
-
deleteActionItem
- Specified by:
deleteActionItemin interfaceActionListService
-
deleteActionItem
protected void deleteActionItem(ActionItem actionItem, boolean forceIntoOutbox, boolean putInOutbox) -
deleteByDocumentId
- Specified by:
deleteByDocumentIdin interfaceActionListService
-
findByDocumentId
- Specified by:
findByDocumentIdin interfaceActionListService
-
findByActionRequestId
- Specified by:
findByActionRequestIdin interfaceActionListService
-
findByWorkflowUserDocumentId
public Collection<ActionItem> findByWorkflowUserDocumentId(String workflowUserId, String documentId) - Specified by:
findByWorkflowUserDocumentIdin interfaceActionListService
-
findByDocumentTypeName
- Specified by:
findByDocumentTypeNamein interfaceActionListService
-
createActionItemForActionRequest
- Specified by:
createActionItemForActionRequestin interfaceActionListService
-
updateActionItemsForTitleChange
- Specified by:
updateActionItemsForTitleChangein interfaceActionListService
-
saveActionItem
- Specified by:
saveActionItemin interfaceActionListService
-
saveOutboxItem
- Specified by:
saveOutboxItemin interfaceActionListService
-
saveActionItemBase
-
getGroupService
public org.kuali.rice.kim.api.group.GroupService getGroupService() -
findByActionItemId
- Specified by:
findByActionItemIdin interfaceActionListService
-
getCount
Description copied from interface:ActionListServiceRetrieves the number of Action List items in the given user's primary Action List (does not include secondary delegations)- Specified by:
getCountin interfaceActionListService
-
getMaxActionItemDateAssignedAndCountForUser
Retrieves the max action item Id and the total number of action items for the given user's primary Action List (does not include secondary delegations)- Specified by:
getMaxActionItemDateAssignedAndCountForUserin interfaceActionListService- Parameters:
principalId-
-
getOutbox
RetrievesOutboxItemitems for the given user- Specified by:
getOutboxin interfaceActionListService- Parameters:
principalId-filter-- Returns:
-
getOutboxItemsByDocumentType
- Specified by:
getOutboxItemsByDocumentTypein interfaceActionListService
-
removeOutboxItems
- Specified by:
removeOutboxItemsin interfaceActionListService
-
saveOutboxItem
- Specified by:
saveOutboxItemin interfaceActionListService
-
saveOutboxItem
save the ouboxitem unless the document is saved or the user already has the item in their outbox.- Specified by:
saveOutboxItemin interfaceActionListService- See Also:
-
getOutboxItemByDocumentIdUserId
-
findByPrincipalId
- Specified by:
findByPrincipalIdin interfaceActionListService
-
getMinimalRouteHeader
Pulls a proxied version of the document route header with only the properties needed by the action list display.- Specified by:
getMinimalRouteHeaderin interfaceActionListService
-
beginningOfDay
-
endOfDay
-
setDataObjectService
public void setDataObjectService(org.kuali.rice.krad.data.DataObjectService dataObjectService) -
setNotificationService
-
setDateTimeService
public void setDateTimeService(org.kuali.rice.core.api.datetime.DateTimeService dateTimeService) -
setActionRequestService
-
setDocumentTypeService
-
setUserOptionsService
-
setRouteHeaderService
-