org.kuali.rice.kew.webservice
Interface SimpleDocumentActionsWebService

All Known Implementing Classes:

SimpleDocumentActionsWebServiceImpl

public interface SimpleDocumentActionsWebService

SimpleDocumentActionsWebService is a simplified view into KEW that exposes those methods that would be required by a basic client as a web service that is meant to be as interoperable as possible (using simple types, etc.) The standard return is a simple structure containing a standard set of return values:

• docStatus String - current status of document in KEW
• createDate String - date document was created in KEW
• initiatorPrincipalId String - principal id of document initiator
• appDocId String - application specific document id
• initiatorName String - display name of the document initiator
• routedByprincipalId String - id of the user that routed the document (can be different from initiator)
• routedByUserName String - display name of the user that routed the document (can be different from initiator)
• errorMessage String - error message from KEW if any

Author:

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

Method Summary

StandardResponse	acknowledge(String docId, String principalId, String annotation) Acknowledge the KEW document, in response to an acknowledge action request.
NoteResponse	addNote(String docId, String principalId, String noteText) Add a note (possibly including a binary attachment) to this KEW document.
StandardResponse	approve(String docId, String principalId, String docTitle, String docContent, String annotation) Approve the KEW document, in response to an approval action request.
StandardResponse	blanketApprove(String docId, String principalId, String docTitle, String docContent, String annotation) Blanket Approve the KEW document (all future approval requests will be satisfied), in response to an approval action request.
StandardResponse	cancel(String docId, String principalId, String annotation) Cancel the KEW document.
DocumentResponse	create(String initiatorPrincipalId, String appDocId, String docType, String docTitle) Create a KEW document.
ErrorResponse	deleteNote(String docId, String noteId, String principalId) Delete an existing note.
StandardResponse	disapprove(String docId, String principalId, String annotation) Disapprove the KEW document, in response to an approval action request.
StandardResponse	fyi(String docId, String principalId) Clear an FYI request for this KEW document from the user's action list, in response to an FYI action request.
DocumentResponse	getDocument(String docId, String principalId) Retrieve a KEW document based on the docId and principalId passed in, and return the information about the document.
UserInRouteLogResponse	isUserInRouteLog(String docId, String principalId) Check to see if the user is associated with this KEW document.
StandardResponse	requestAdHocAckToGroup(String docId, String principalId, String recipientGroupId, String annotation) Create an Adhoc Acknowledge request for another group for this KEW document.
StandardResponse	requestAdHocAckToPrincipal(String docId, String principalId, String recipientPrincipalId, String annotation) Create an Adhoc Acknowledge request for another user for this KEW document.
StandardResponse	requestAdHocApproveToGroup(String docId, String principalId, String recipientGroupId, String annotation) Create an Adhoc Approval request for another group for this KEW document.
StandardResponse	requestAdHocApproveToPrincipal(String docId, String principalId, String recipientPrincipalId, String annotation) Create an Adhoc Approval request for another user for this KEW document.
StandardResponse	requestAdHocFyiToGroup(String docId, String principalId, String recipientGroupId, String annotation) Create an Adhoc FYI request for another group for this KEW document.
StandardResponse	requestAdHocFyiToPrincipal(String docId, String principalId, String recipientPrincipalId, String annotation) Create an Adhoc FYI request for another user for this KEW document.
StandardResponse	returnToPreviousNode(String docId, String principalId, String annotation, String nodeName) Return a KEW document to a previous route node.
StandardResponse	returnToPreviousNodeWithUpdates(String docId, String principalId, String annotation, String nodeName, String docTitle, String docContent) Return a KEW document to a previous route node.
StandardResponse	revokeAdHocRequestsByActionRequestId(String docId, String principalId, String docTitle, String docContent, String actionRequestId, String annotation) This method revokes the AdHoc request set on the document for the specified action request.
StandardResponse	revokeAdHocRequestsByGroupId(String docId, String principalId, String docTitle, String docContent, String groupId, String annotation) This method revokes all AdHoc requests set on the document for a specified group.
StandardResponse	revokeAdHocRequestsByNodeName(String docId, String principalId, String docTitle, String docContent, String nodeName, String annotation) This method revokes all AdHoc requests set on the document at the specified node.
StandardResponse	revokeAdHocRequestsByPrincipalId(String docId, String principalId, String docTitle, String docContent, String adhocPrincipalId, String annotation) This method revokes all AdHoc requests set on the document for the specified principal.
StandardResponse	route(String docId, String principalId, String docTitle, String docContent, String annotation) Route a KEW document.
StandardResponse	save(String docId, String principalId, String docTitle, String docContent, String annotation) Save the KEW document, keeps it in the user's action list for completion later.
StandardResponse	saveDocumentContent(String docId, String principalId, String docTitle, String docContent) Save the KEW document content and update the docTitle if fields are non-null.
StandardResponse	superUserApprove(String docId, String superUserPrincipalId, String docTitle, String docContent, String annotation) This method will super user approve the document.
StandardResponse	superUserCancel(String docId, String superUserPrincipalId, String docTitle, String docContent, String annotation) This method will super user cancel the document.
StandardResponse	superUserDisapprove(String docId, String superUserPrincipalId, String docTitle, String docContent, String annotation) This method will super user disapprove the document.
StandardResponse	superUserReturnToPrevious(String docId, String superUserPrincipalId, String docTitle, String docContent, String nodeName, String annotation) Return a KEW document to a previous route node.
NoteResponse	updateNote(String docId, String noteId, String principalId, String noteText) Update an existing note (possibly including a binary attachment) to this KEW document.

Method Detail

create

DocumentResponse create(String initiatorPrincipalId,
                        String appDocId,
                        String docType,
                        String docTitle)

Create a KEW document.

Parameters:

initiatorPrincipalId - principal id of the document initiator

appDocId - application specific document id

docType - KEW document type for the document to be created

docTitle - title for this document

Returns:

DocumentResponse including the standard set of return values and the docId of the newly created document

route

StandardResponse route(String docId,
                       String principalId,
                       String docTitle,
                       String docContent,
                       String annotation)

Route a KEW document.

Parameters:

docId - KEW document id of the document to route

principalId - principal id of the user who is routing the document

docTitle - title for this document

docContent - xml content for this document

annotation - a comment associated with this request

Returns:

StandardResponse including the standard set of return values

approve

StandardResponse approve(String docId,
                         String principalId,
                         String docTitle,
                         String docContent,
                         String annotation)

Approve the KEW document, in response to an approval action request.

Parameters:

docId - KEW document id of the document to approve

principalId - principal id of the user who is approving the document

docTitle - title for this document

docContent - xml content for this document

annotation - a comment associated with this request

Returns:

StandardResponse including the standard set of return values

blanketApprove

StandardResponse blanketApprove(String docId,
                                String principalId,
                                String docTitle,
                                String docContent,
                                String annotation)

Blanket Approve the KEW document (all future approval requests will be satisfied), in response to an approval action request. Can only be performed by a super user.

Parameters:

docId - KEW document id of the document to blanket approve

principalId - principal id of the user who is blanket approving the document

docTitle - title for this document

docContent - xml content for this document

annotation - a comment associated with this request

Returns:

StandardResponse including the standard set of return values

cancel

StandardResponse cancel(String docId,
                        String principalId,
                        String annotation)

Cancel the KEW document.

Parameters:

docId - KEW document id of the document to cancel

principalId - principal id of the user who is canceling the document

annotation - a comment associated with this request

Returns:

StandardResponse including the standard set of return values

disapprove

StandardResponse disapprove(String docId,
                            String principalId,
                            String annotation)

Disapprove the KEW document, in response to an approval action request.

Parameters:

docId - KEW document id of the document to disapprove

principalId - principal id of the user who is disapproving the document

annotation - a comment associated with this request

Returns:

StandardResponse including the standard set of return values

acknowledge

StandardResponse acknowledge(String docId,
                             String principalId,
                             String annotation)

Acknowledge the KEW document, in response to an acknowledge action request.

Parameters:

docId - KEW document id of the document to acknowledge

principalId - principal id of the user who is acknowledging the document

annotation - a comment associated with this request

Returns:

StandardResponse including the standard set of return values

fyi

StandardResponse fyi(String docId,
                     String principalId)

Clear an FYI request for this KEW document from the user's action list, in response to an FYI action request.

Parameters:

docId - KEW document id of the document to acknowledge

principalId - principal id of the user who is acknowledging the document

Returns:

StandardResponse including the standard set of return values

save

StandardResponse save(String docId,
                      String principalId,
                      String docTitle,
                      String docContent,
                      String annotation)

Save the KEW document, keeps it in the user's action list for completion later.

Parameters:

docId - KEW document id of the document to save

principalId - principal id of the user who is saving the document

docTitle - title for this document

docContent - xml content for this document

annotation - a comment associated with this request

Returns:

StandardResponse including the standard set of return values

saveDocumentContent

StandardResponse saveDocumentContent(String docId,
                                     String principalId,
                                     String docTitle,
                                     String docContent)

Save the KEW document content and update the docTitle if fields are non-null.

Parameters:

docId - KEW document id of the document to save

principalId - principal id of the user who is saving the document

docTitle - title for this document

docContent - xml content for this document

Returns:

StandardResponse including the standard set of return values

requestAdHocFyiToPrincipal

StandardResponse requestAdHocFyiToPrincipal(String docId,
                                            String principalId,
                                            String recipientPrincipalId,
                                            String annotation)

Create an Adhoc FYI request for another user for this KEW document. NOTE: Must make a subsequent call to route in order for the action request to be created. This allows the user to create multiple adhoc requests at the same time prior to routing.

Parameters:

docId - KEW document id of the document to create the adhoc request for

principalId - principal id of the user who is making this request

recipientPrincipalId - principal id of the user for whom the request is being created

annotation - a comment associated with this request

Returns:

StandardResponse including the standard set of return values

requestAdHocFyiToGroup

StandardResponse requestAdHocFyiToGroup(String docId,
                                        String principalId,
                                        String recipientGroupId,
                                        String annotation)

Create an Adhoc FYI request for another group for this KEW document. NOTE: Must make a subsequent call to route in order for the action request to be created. This allows the user to create multiple adhoc requests at the same time prior to routing.

Parameters:

docId - KEW document id of the document to create the adhoc request for

principalId - principal id of the user who is making this request

recipientGroupId - group id of the group to create this request for

annotation - a comment associated with this request

Returns:

StandardResponse including the standard set of return values

requestAdHocAckToPrincipal

StandardResponse requestAdHocAckToPrincipal(String docId,
                                            String principalId,
                                            String recipientPrincipalId,
                                            String annotation)

Create an Adhoc Acknowledge request for another user for this KEW document. NOTE: Must make a subsequent call to route in order for the action request to be created. This allows the user to create multiple adhoc requests at the same time prior to routing.

Parameters:

docId - KEW document id of the document to create the adhoc request for

principalId - principal id of the user who is making this request

recipientPrincipalId - principal id of the user for whom the request is being created

annotation - a comment associated with this request

Returns:

StandardResponse including the standard set of return values

requestAdHocAckToGroup

StandardResponse requestAdHocAckToGroup(String docId,
                                        String principalId,
                                        String recipientGroupId,
                                        String annotation)

Create an Adhoc Acknowledge request for another group for this KEW document. NOTE: Must make a subsequent call to route in order for the action request to be created. This allows the user to create multiple adhoc requests at the same time prior to routing.

Parameters:

docId - KEW document id of the document to create the adhoc request for

principalId - principal id of the user who is making this request

recipientGroupId - group id of the group to create this request for

annotation - a comment associated with this request

Returns:

StandardResponse including the standard set of return values

requestAdHocApproveToPrincipal

StandardResponse requestAdHocApproveToPrincipal(String docId,
                                                String principalId,
                                                String recipientPrincipalId,
                                                String annotation)

Create an Adhoc Approval request for another user for this KEW document. NOTE: Must make a subsequent call to route in order for the action request to be created. This allows the user to create multiple adhoc requests at the same time prior to routing.

Parameters:

docId - KEW document id of the document to create the adhoc request for

principalId - principal id of the user who is making this request

recipientPrincipalId - principal id of the user for whom the request is being created

annotation - a comment associated with this request

Returns:

StandardResponse including the standard set of return values

requestAdHocApproveToGroup

StandardResponse requestAdHocApproveToGroup(String docId,
                                            String principalId,
                                            String recipientGroupId,
                                            String annotation)

Create an Adhoc Approval request for another group for this KEW document. NOTE: Must make a subsequent call to route in order for the action request to be created. This allows the user to create multiple adhoc requests at the same time prior to routing.

Parameters:

docId - KEW document id of the document to create the adhoc request for

principalId - principal id of the user who is making this request

recipientGroupId - group id of the group to create this request for

annotation - a comment associated with this request

Returns:

StandardResponse including the standard set of return values

isUserInRouteLog

UserInRouteLogResponse isUserInRouteLog(String docId,
                                        String principalId)

Check to see if the user is associated with this KEW document. Useful for security purposes (if return is False, user shouldn't be able to see the document unless it's public.)

Parameters:

docId - KEW document id of the document to check

principalId - principal id of the user to check

Returns:

UserInRouteLogResponse containing True/False for isUserInRouteLog and an error message if a problem occured

getDocument

DocumentResponse getDocument(String docId,
                             String principalId)

Retrieve a KEW document based on the docId and principalId passed in, and return the information about the document.

Parameters:

docId - KEW document id of the document to retrieve information about

principalId - principal id of the user to retrieve the document for

Returns:

DocumentResponse including the standard set of return values, the xml document content, the title, the action requested ( Approve, Aknowledge, Fyi, Complete ) and an array of Maps containing the following for each Note (author, noteId, timestamp, noteText).

addNote

NoteResponse addNote(String docId,
                     String principalId,
                     String noteText)

Add a note (possibly including a binary attachment) to this KEW document.

Parameters:

docId - KEW document id of the document to add the note to

principalId - principal id of the user who is adding the note

noteText - text of the note

Returns:

NoteResponse containing relevant note information (author, noteId, timestamp, noteText) along with an error message (if any)

updateNote

NoteResponse updateNote(String docId,
                        String noteId,
                        String principalId,
                        String noteText)

Update an existing note (possibly including a binary attachment) to this KEW document.

Parameters:

docId - KEW document id of the document to update the note for

noteId - the id of the note to update

principalId - principal id of the user who is updating the note

noteText - text of the note if changed

Returns:

NoteResponse containing relevant note information (author, noteId, timestamp, noteText) along with an error message (if any)

deleteNote

ErrorResponse deleteNote(String docId,
                         String noteId,
                         String principalId)

Delete an existing note.

Parameters:

docId - KEW document id of the document to delete the note from

noteId - the id of the note to delete

principalId - principal id of the user who is deleting the note

Returns:

ErrorResponse containing an error message if any

returnToPreviousNode

StandardResponse returnToPreviousNode(String docId,
                                      String principalId,
                                      String annotation,
                                      String nodeName)

Return a KEW document to a previous route node. This method should be used with caution.

Parameters:

docId - KEW document id of the document to return to a previous node

principalId - principal id of the user who is requesting this action

annotation - a comment associated with this request

nodeName - name of the route node to return to

Returns:

StandardResponse including the standard set of return values

returnToPreviousNodeWithUpdates

StandardResponse returnToPreviousNodeWithUpdates(String docId,
                                                 String principalId,
                                                 String annotation,
                                                 String nodeName,
                                                 String docTitle,
                                                 String docContent)

Return a KEW document to a previous route node. This method should be used with caution.

Parameters:

docId - KEW document id of the document to return to a previous node

principalId - principal id of the user who is requesting this action

annotation - a comment associated with this request

nodeName - name of the route node to return to

docTitle - title for this document

docContent - xml content for this document

Returns:

StandardResponse including the standard set of return values

revokeAdHocRequestsByNodeName

StandardResponse revokeAdHocRequestsByNodeName(String docId,
                                               String principalId,
                                               String docTitle,
                                               String docContent,
                                               String nodeName,
                                               String annotation)

This method revokes all AdHoc requests set on the document at the specified node.

Parameters:

docId - KEW document id of the document

principalId - principal id of the user who is revoking the requests

docTitle - title for this document (updated if non-null)

docContent - xml content for this document (updated if non-null)

nodeName - name of the route node that adhoc requests should be revoked from

annotation - a comment associated with this request

Returns:

StandardResponse including the standard set of return values

revokeAdHocRequestsByPrincipalId

StandardResponse revokeAdHocRequestsByPrincipalId(String docId,
                                                  String principalId,
                                                  String docTitle,
                                                  String docContent,
                                                  String adhocPrincipalId,
                                                  String annotation)

This method revokes all AdHoc requests set on the document for the specified principal.

Parameters:

docId - KEW document id of the document

principalId - principal id of the user who is revoking the requests

docTitle - title for this document (updated if non-null)

docContent - xml content for this document (updated if non-null)

adhocPrincipalId - principal ID of the principal that should have all their adhoc requests revoked

annotation - a comment associated with this request

Returns:

StandardResponse including the standard set of return values

revokeAdHocRequestsByGroupId

StandardResponse revokeAdHocRequestsByGroupId(String docId,
                                              String principalId,
                                              String docTitle,
                                              String docContent,
                                              String groupId,
                                              String annotation)

This method revokes all AdHoc requests set on the document for a specified group.

Parameters:

docId - KEW document id of the document that is being returned

principalId - principal id of the user who is revoking the requests

docTitle - title for this document (updated if non-null)

docContent - xml content for this document (updated if non-null)

groupId - groupId of the group that should have adhoc requests revoked

annotation - a comment associated with this request

Returns:

StandardResponse including the standard set of return values

revokeAdHocRequestsByActionRequestId

StandardResponse revokeAdHocRequestsByActionRequestId(String docId,
                                                      String principalId,
                                                      String docTitle,
                                                      String docContent,
                                                      String actionRequestId,
                                                      String annotation)

This method revokes the AdHoc request set on the document for the specified action request.

Parameters:

docId - KEW document id of the document

principalId - principal id of the user who is revoking the requests

docTitle - title for this document (updated if non-null)

docContent - xml content for this document (updated if non-null)

actionRequestId - the id of the adhoc request to be revoked

annotation - a comment associated with this request

Returns:

StandardResponse including the standard set of return values

superUserApprove

StandardResponse superUserApprove(String docId,
                                  String superUserPrincipalId,
                                  String docTitle,
                                  String docContent,
                                  String annotation)

This method will super user approve the document.

Parameters:

docId - KEW document id of the document

superUserPrincipalId - principal id of the super user who is taking the action

docTitle - title for this document (updated if non-null)

docContent - xml content for this document (updated if non-null)

annotation - a comment associated with this request

Returns:

StandardResponse including the standard set of return values

superUserDisapprove

StandardResponse superUserDisapprove(String docId,
                                     String superUserPrincipalId,
                                     String docTitle,
                                     String docContent,
                                     String annotation)

This method will super user disapprove the document.

Parameters:

docId - KEW document id of the document

superUserPrincipalId - principal id of the super user who is taking the action

docTitle - title for this document (updated if non-null)

docContent - xml content for this document (updated if non-null)

annotation - a comment associated with this request

Returns:

StandardResponse including the standard set of return values

superUserCancel

StandardResponse superUserCancel(String docId,
                                 String superUserPrincipalId,
                                 String docTitle,
                                 String docContent,
                                 String annotation)

This method will super user cancel the document.

Parameters:

docId - KEW document id of the document

superUserPrincipalId - principal id of the super user who is taking the action

docTitle - title for this document (updated if non-null)

docContent - xml content for this document (updated if non-null)

annotation - a comment associated with this request

Returns:

StandardResponse including the standard set of return values

superUserReturnToPrevious

StandardResponse superUserReturnToPrevious(String docId,
                                           String superUserPrincipalId,
                                           String docTitle,
                                           String docContent,
                                           String nodeName,
                                           String annotation)

Return a KEW document to a previous route node. This method should be used with caution.

Parameters:

docId - KEW document id of the document to return to a previous node

superUserPrincipalId - principal id of the super user who is requesting this action

docTitle - title for this document (updated if non-null)

docContent - xml content for this document (updated if non-null)

nodeName - name of the route node to return to

annotation - a comment associated with this request

Returns:

StandardResponse including the standard set of return values