org.kuali.rice.kew.api.actionlist

Interface ActionListService

All Known Implementing Classes:

ActionListServiceNewImpl

public interface ActionListService

Method Summary

Methods

Modifier and Type	Method and Description
List<ActionItem>	getActionItems(String documentId, List<String> actionRequestedCodes) Returns a list of ActionItems for a Document that match one of the passed in actionRequestCodes
List<ActionItem>	getActionItemsForPrincipal(String principalId) Returns a list of ActionItems for a Principal in the system
List<ActionItem>	getAllActionItems(String documentId) Returns a list of all ActionItems for a Document
Integer	getUserActionItemCount(String principalId) Gets the number of ActionItems for a given principal

Method Detail

getUserActionItemCount

Integer getUserActionItemCount(String principalId)
                               throws RiceIllegalArgumentException

Gets the number of ActionItems for a given principal

Parameters:

principalId - unique Id for a principal in the system

Returns:

a count of ActionItems for a given principal

Throws:

RiceIllegalArgumentException - if principalId is null

getAllActionItems

List<ActionItem> getAllActionItems(String documentId)
                                   throws RiceIllegalArgumentException

Returns a list of all ActionItems for a Document

Parameters:

documentId - unique id of the document to get the ActionItems for

Returns:

list of ActionItems for a document

Throws:

RiceIllegalArgumentException - if documentId is null

getActionItems

List<ActionItem> getActionItems(String documentId,
                              List<String> actionRequestedCodes)
                                throws RiceIllegalArgumentException

Returns a list of ActionItems for a Document that match one of the passed in actionRequestCodes

Parameters:

documentId - unique id of the document to get the ActionItems for

actionRequestedCodes - list of action request codes to match with the ActionItems

Returns:

list of ActionItems for a document with a given action request code

Throws:

RiceIllegalArgumentException - if documentId is null

getActionItemsForPrincipal

List<ActionItem> getActionItemsForPrincipal(String principalId)
                                            throws RiceIllegalArgumentException

Returns a list of ActionItems for a Principal in the system

Parameters:

principalId - unique Id for a principal in the system

Returns:

list of ActionItems for a given principal

Throws:

RiceIllegalArgumentException - if principalId is null