ActionListService

Name ActionList
Version
Included Services  
Java Package org.kuali.rice.kew.api.actionlist

Copyright 2005-2012 The Kuali Foundation

Licensed under the Educational Community License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.opensource.org/licenses/ecl2.php

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Operations
Main Message Structures

Method getUserActionItemCount
Description Gets the number of ActionItems for a given principal
Parameters String principalId unique Id for a principal in the system
Return Integer a count of ActionItems for a given principal
Errors RiceIllegalArgumentException ???

Back to Operations

Method getAllActionItems
Description Returns a list of all {@link ActionItem}s for a {@link org.kuali.rice.kew.api.document.Document}
Parameters String documentId unique id of the document to get the ActionItems for
Return ActionItemList list of ActionItems for a document
Errors RiceIllegalArgumentException ???

Back to Operations

Method getActionItems
Description Returns a list of {@link ActionItem}s for a {@link org.kuali.rice.kew.api.document.Document} that match one of the
passed in actionRequestCodes
Parameters String documentId unique id of the document to get the ActionItems for
StringList actionRequestedCodes list of action request codes to match with the ActionItems
Return ActionItemList list of ActionItems for a document with a given action request code
Errors RiceIllegalArgumentException ???

Back to Operations

Method getActionItemsForPrincipal
Description Returns a list of {@link ActionItem}s for a Principal in the system
Parameters String principalId unique Id for a principal in the system
Return ActionItemList list of ActionItems for a given principal
Errors RiceIllegalArgumentException ???

Back to Operations