org.kuali.rice.kew.actionlist.service
Interface ActionListService

All Known Implementing Classes:

ActionListServiceImpl

public interface ActionListService

Main service for doing action list data access work

Author:

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

Method Summary

ActionItem	createActionItemForActionRequest(ActionRequestValue actionRequest)
void	deleteActionItem(ActionItem actionItem)
void	deleteActionItem(ActionItem actionItem, boolean forceIntoOutbox)
void	deleteByDocumentId(String documentId)
ActionItem	findByActionItemId(String actionItemId)
Collection<ActionItem>	findByActionRequestId(String actionRequestId)
Collection<ActionItem>	findByDocumentId(String documentId)
Collection<ActionItem>	findByDocumentTypeName(String documentTypeName)
Collection<ActionItem>	findByPrincipalId(String principalId)
Collection<ActionItem>	findByWorkflowUserDocumentId(String workflowUserId, String documentId)
Collection<Recipient>	findUserPrimaryDelegations(String principalId) Retruns a list of recipients which are primary-delegated to by the source principalId
Collection<Recipient>	findUserSecondaryDelegators(String principalId) Returns a list of recipients which secondary-delegate to the target principalId
Collection<ActionItem>	getActionList(String principalId, ActionListFilter filter)
Collection<ActionItem>	getActionListForSingleDocument(String documentId)
int	getCount(String principalId) Retrieves the number of Action List items in the given user's primary Action List (does not include secondary delegations)
List<Object>	getMaxActionItemDateAssignedAndCountForUser(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)
DocumentRouteHeaderValue	getMinimalRouteHeader(String documentId) Pulls a proxied version of the document route header with only the properties needed by the action list display.
Collection<OutboxItem>	getOutbox(String principalId, ActionListFilter filter) Retrieves OutboxItem items for the given user
Collection<OutboxItem>	getOutboxItemsByDocumentType(String documentTypeName)
void	removeOutboxItems(String principalId, List<String> outboxItems)
ActionItem	saveActionItem(ActionItem actionItem)
void	saveOutboxItem(ActionItem actionItem)
void	saveOutboxItem(ActionItem actionItem, boolean forceIntoOutbox)
void	updateActionItemsForTitleChange(String documentId, String newTitle)

Method Detail

createActionItemForActionRequest

ActionItem createActionItemForActionRequest(ActionRequestValue actionRequest)

getActionList

Collection<ActionItem> getActionList(String principalId,
                                     ActionListFilter filter)

getActionListForSingleDocument

Collection<ActionItem> getActionListForSingleDocument(String documentId)

findUserSecondaryDelegators

Collection<Recipient> findUserSecondaryDelegators(String principalId)

Returns a list of recipients which secondary-delegate to the target principalId

Parameters:

principalId - the target principalId/delegate

Returns:

a list of recipients which secondary-delegate to the target principalId

findUserPrimaryDelegations

Collection<Recipient> findUserPrimaryDelegations(String principalId)

Retruns a list of recipients which are primary-delegated to by the source principalId

Parameters:

principalId - the source principalId to query for primary delegates

Returns:

a list of recipients which are primary-delegated to by the source principalId

saveActionItem

ActionItem saveActionItem(ActionItem actionItem)

deleteActionItem

void deleteActionItem(ActionItem actionItem)

deleteActionItem

void deleteActionItem(ActionItem actionItem,
                      boolean forceIntoOutbox)

deleteByDocumentId

void deleteByDocumentId(String documentId)

findByPrincipalId

Collection<ActionItem> findByPrincipalId(String principalId)

findByWorkflowUserDocumentId

Collection<ActionItem> findByWorkflowUserDocumentId(String workflowUserId,
                                                    String documentId)

findByDocumentId

Collection<ActionItem> findByDocumentId(String documentId)

findByDocumentTypeName

Collection<ActionItem> findByDocumentTypeName(String documentTypeName)

updateActionItemsForTitleChange

void updateActionItemsForTitleChange(String documentId,
                                     String newTitle)

findByActionItemId

ActionItem findByActionItemId(String actionItemId)

getCount

int getCount(String principalId)

Retrieves the number of Action List items in the given user's primary Action List (does not include secondary delegations)

getMaxActionItemDateAssignedAndCountForUser

List<Object> getMaxActionItemDateAssignedAndCountForUser(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)

Parameters:

principalId -

findByActionRequestId

Collection<ActionItem> findByActionRequestId(String actionRequestId)

getOutbox

Collection<OutboxItem> getOutbox(String principalId,
                                 ActionListFilter filter)

Retrieves OutboxItem items for the given user

Parameters:

principalId -

filter -

Returns:

getOutboxItemsByDocumentType

Collection<OutboxItem> getOutboxItemsByDocumentType(String documentTypeName)

removeOutboxItems

void removeOutboxItems(String principalId,
                       List<String> outboxItems)

saveOutboxItem

void saveOutboxItem(ActionItem actionItem)

saveOutboxItem

void saveOutboxItem(ActionItem actionItem,
                    boolean forceIntoOutbox)

getMinimalRouteHeader

DocumentRouteHeaderValue getMinimalRouteHeader(String documentId)

Pulls a proxied version of the document route header with only the properties needed by the action list display.