| java.lang.Object
 edu.iu.uis.eden.server.SimpleDocumentActionsWebServiceImpl
| SimpleDocumentActionsWebServiceImpl | | public class SimpleDocumentActionsWebServiceImpl implements SimpleDocumentActionsWebService(Code) | | Implementation of the SimpleDocumentActionsWebService
author:
Bryan G. Hutchinson (bh79 at cornell dot edu)
author:
ewestfal
author:
Aaron Hamid (arh14 at cornell dot edu) |
| Method Summary | |
| public StandardResponse | acknowledge(String docId, String userId, String annotation)
| | public NoteResponse | addNote(String docId, String userId, String noteText)
Add a note to this KEW document. | | public StandardResponse | approve(String docId, String userId, String docTitle, String docContent, String annotation)
| | public StandardResponse | blanketApprove(String docId, String userId, String docTitle, String docContent, String annotation)
- Create a WorkflowDocument based on the docId and userId passed in
- Set the docTitle and docContent if they are passed in
- Blanket Approve the document with the passed in annotation
- Return the standard set of return values
Blanket Approval means all future approval requests will be satisfied
Can only be performed by a super user. | | public StandardResponse | cancel(String docId, String userId, String annotation)
| | public DocumentResponse | create(String initiatorId, String appDocId, String docType, String docTitle)
| | public ErrorResponse | deleteNote(String docId, String noteId, String userId)
Delete an existing note. | | public StandardResponse | disapprove(String docId, String userId, String annotation)
| | public StandardResponse | fyi(String docId, String userId)
| | public DocumentResponse | getDocument(String docId, String userId)
| | public UserInRouteLogResponse | isUserInRouteLog(String docId, String userId)
- Create a new WorkflowInfo object
- Call isUserAuthenticatedByRouteLog on the WorkflowInfo object to see if the user is in the route log
- Return True/False and an error message if any
Useful for security purposes (if return is False, user shouldn't
be able to see the document unless it's public.)
Call isUserAuthenticatedByRouteLog with true for the lookFuture parameter so that
we will check future workflow requests as well as currently outstanding requests. | | public StandardResponse | requestAdHocAckToGroup(String docId, String userId, String recipientGroupId, String annotation)
| | public StandardResponse | requestAdHocAckToUser(String docId, String userId, String recipientUserId, String annotation)
| | public StandardResponse | requestAdHocApproveToGroup(String docId, String userId, String recipientGroupId, String annotation)
| | public StandardResponse | requestAdHocApproveToUser(String docId, String userId, String recipientUserId, String annotation)
| | public StandardResponse | requestAdHocFyiToGroup(String docId, String userId, String recipientGroupId, String annotation)
| | public StandardResponse | requestAdHocFyiToUser(String docId, String userId, String recipientUserId, String annotation)
| | public StandardResponse | returnToPreviousNode(String docId, String userId, String annotation, String nodeName)
Return a KEW document to a previous route node. | | public StandardResponse | route(String docId, String userId, String docTitle, String docContent, String annotation)
| | public StandardResponse | save(String docId, String userId, String docTitle, String annotation)
| | public NoteResponse | updateNote(String docId, String noteId, String userId, String noteText)
Update an existing note to this KEW document. |
| acknowledge | | public StandardResponse acknowledge(String docId, String userId, String annotation)(Code) | |
- Create a WorkflowDocument based on the docId and userId passed in
- Acknowledge the document with the passed in annotation
- Return the standard set of return values.
Parameters:
docId - KEW document id of the document to acknowledge
Parameters:
userId - netid of the user who is acknowledging the document
Parameters:
annotation - a comment associated with this request Map including the standard set of return values
See Also: edu.cornell.kew.service.CornellKewService.acknowledge(java.lang.Stringjava.lang.Stringjava.lang.String) |
| addNote | | public NoteResponse addNote(String docId, String userId, String noteText)(Code) | | Add a note to this KEW document.
Parameters:
docId - KEW document id of the document to add the note to
Parameters:
userId - netid of the user who is adding the note
Parameters:
noteText - text of the note Map containing relevant note information (author, noteId, timestamp, noteText)along with an error message (if any)
See Also: edu.cornell.kew.service.CornellKewService.addNote(java.lang.Stringjava.lang.Stringjava.lang.String) |
| approve | | public StandardResponse approve(String docId, String userId, String docTitle, String docContent, String annotation)(Code) | |
- Create a WorkflowDocument based on the docId and userId passed in
- Set the docTitle and docContent if they are passed in
- Approve the document with the passed in annotation
- Return the standard set of return values
Parameters:
docId - KEW document id of the document to approve
Parameters:
userId - netid of the user who is approving the document
Parameters:
docTitle - title for this document
Parameters:
docContent - xml content for this document
Parameters:
annotation - a comment associated with this request Map including the standard set of return values
See Also: edu.cornell.kew.service.CornellKewService.approve(java.lang.Stringjava.lang.Stringjava.lang.Stringjava.lang.Stringjava.lang.String) |
| blanketApprove | | public StandardResponse blanketApprove(String docId, String userId, String docTitle, String docContent, String annotation)(Code) | |
- Create a WorkflowDocument based on the docId and userId passed in
- Set the docTitle and docContent if they are passed in
- Blanket Approve the document with the passed in annotation
- Return the standard set of return values
Blanket Approval means all future approval requests will be satisfied
Can only be performed by a super user.
Parameters:
docId - KEW document id of the document to blanket approve
Parameters:
userId - netid of the user who is blanket approving the document
Parameters:
docTitle - title for this document
Parameters:
docContent - xml content for this document
Parameters:
annotation - a comment associated with this request Map including the standard set of return values
See Also: edu.cornell.kew.service.CornellKewService.blanketApprove(java.lang.Stringjava.lang.Stringjava.lang.Stringjava.lang.Stringjava.lang.String) |
| cancel | | public StandardResponse cancel(String docId, String userId, String annotation)(Code) | |
- Create a WorkflowDocument based on the docId and userId passed in
- Cancel the document with the passed in annotation
- Return the standard set of return values
Parameters:
docId - KEW document id of the document to cancel
Parameters:
userId - netid of the user who is canceling the document
Parameters:
annotation - a comment associated with this request Map including the standard set of return values
See Also: edu.cornell.kew.service.CornellKewService.cancel(java.lang.Stringjava.lang.Stringjava.lang.String) |
| create | | public DocumentResponse create(String initiatorId, String appDocId, String docType, String docTitle)(Code) | |
- Create a WorkflowDocument with the docType and userId passed in
- Set the document title to be the docTitle that was passed in
Save the Routing data (Route Header info)
- Return the standard set of return values and the docId of the newly created document
Parameters:
initiatorId - netid of the document initiator
Parameters:
appDocId - application specific document id
Parameters:
docType - KEW document type for the document to be created
Parameters:
docTitle - title for this document Map including the standard set of return values and the docId of the newly created document
See Also: edu.cornell.kew.service.CornellKewService.create(java.lang.Stringjava.lang.Stringjava.lang.Stringjava.lang.String) |
| deleteNote | | public ErrorResponse deleteNote(String docId, String noteId, String userId)(Code) | | Delete an existing note.
Parameters:
docId - KEW document id of the document to delete the note from
Parameters:
noteId - the id of the note to delete
Parameters:
userId - netid of the user who is deleting the note Map containing an error message if any
See Also: edu.cornell.kew.service.CornellKewService.deleteNote(java.lang.Stringjava.lang.Stringjava.lang.String) |
| disapprove | | public StandardResponse disapprove(String docId, String userId, String annotation)(Code) | |
- Create a WorkflowDocument based on the docId and userId passed in
- Disapprove the document with the passed in annotation
- Return the standard set of return values
Parameters:
docId - KEW document id of the document to disapprove
Parameters:
userId - netid of the user who is disapproving the document
Parameters:
annotation - a comment associated with this request Map including the standard set of return values
See Also: edu.cornell.kew.service.CornellKewService.disapprove(java.lang.Stringjava.lang.Stringjava.lang.String) |
| fyi | | public StandardResponse fyi(String docId, String userId)(Code) | |
- Create a WorkflowDocument based on the docId and userId passed in
- Clear the FYI request on the document
- Return the standard set of return values
Parameters:
docId - KEW document id of the document to acknowledge
Parameters:
userId - netid of the user who is acknowledging the document Map including the standard set of return values
See Also: edu.cornell.kew.service.CornellKewService.fyi(java.lang.Stringjava.lang.String) |
| getDocument | | public DocumentResponse getDocument(String docId, String userId)(Code) | |
- Create a WorkflowDocument based on the docId and userId passed in
- Get the document content and the action requested (Approve, Acknowledge, etc) of the user
- Return the standard set of return values, the docContent, the title,
and the actionRequested
Parameters:
docId - KEW document id of the document to retrieve information about
Parameters:
userId - netid of the user to retrieve the document for Map including the standard set of return values, the xml document content,the action requested ( Approve, Aknowledge, Fyi, Complete ) and an array of Mapscontaining the following for each Note (author, noteId, timestamp, noteText).
See Also: edu.cornell.kew.service.CornellKewService.getDocument(java.lang.Stringjava.lang.String) |
| isUserInRouteLog | | public UserInRouteLogResponse isUserInRouteLog(String docId, String userId)(Code) | |
- Create a new WorkflowInfo object
- Call isUserAuthenticatedByRouteLog on the WorkflowInfo object to see if the user is in the route log
- Return True/False and an error message if any
Useful for security purposes (if return is False, user shouldn't
be able to see the document unless it's public.)
Call isUserAuthenticatedByRouteLog with true for the lookFuture parameter so that
we will check future workflow requests as well as currently outstanding requests.
Parameters:
docId - KEW document id of the document to check
Parameters:
userId - netid of the user to check Map containing True/False for isUserInRouteLog and an error message ifa problem occured
See Also: edu.cornell.kew.service.CornellKewService.isUserInRouteLog(java.lang.Stringjava.lang.String) |
| requestAdHocAckToGroup | | public StandardResponse requestAdHocAckToGroup(String docId, String userId, String recipientGroupId, String annotation)(Code) | |
- Create a WorkflowDocument based on the docId and userId passed in
- Add the adhoc acknowlege request (app specific route) to the passed in group with the passed in annotation
- Return the standard set of return values
Parameters:
docId - KEW document id of the document to create the adhoc request for
Parameters:
userId - netid of the user who is making this request
Parameters:
recipientGroupId - workgroupId of the group to create this request for
Parameters:
annotation - a comment associated with this request Map including the standard set of return values
See Also: edu.cornell.kew.service.CornellKewService.requestAdHocAckToGroup(java.lang.Stringjava.lang.Stringjava.lang.Stringjava.lang.String) |
| requestAdHocAckToUser | | public StandardResponse requestAdHocAckToUser(String docId, String userId, String recipientUserId, String annotation)(Code) | |
- Create a WorkflowDocument based on the docId and userId passed in
- Add the adhoc acknowlege request (app specific route) to the passed in user with the passed in annotation
- Return the standard set of return values
Parameters:
docId - KEW document id of the document to create the adhoc request for
Parameters:
userId - netid of the user who is making this request
Parameters:
recipientUserId - netid of the user for whom the request is being created
Parameters:
annotation - a comment associated with this request Map including the standard set of return values
See Also: edu.cornell.kew.service.CornellKewService.requestAdHocAckToUser(java.lang.Stringjava.lang.Stringjava.lang.Stringjava.lang.String) |
| requestAdHocApproveToGroup | | public StandardResponse requestAdHocApproveToGroup(String docId, String userId, String recipientGroupId, String annotation)(Code) | |
- Create a WorkflowDocument based on the docId and userId passed in
- Add the adhoc approve request (app specific route) to the passed in group with the passed in annotation
- Return the standard set of return values
Parameters:
docId - KEW document id of the document to create the adhoc request for
Parameters:
userId - netid of the user who is making this request
Parameters:
recipientGroupId - workgroupId of the group to create this request for
Parameters:
annotation - a comment associated with this request Map including the standard set of return values
See Also: edu.cornell.kew.service.CornellKewService.requestAdHocApproveToGroup(java.lang.Stringjava.lang.Stringjava.lang.Stringjava.lang.String) |
| requestAdHocApproveToUser | | public StandardResponse requestAdHocApproveToUser(String docId, String userId, String recipientUserId, String annotation)(Code) | |
- Create a WorkflowDocument based on the docId and userId passed in
- Add the adhoc approve request (app specific route) to the passed in user with the passed in annotation
- Return the standard set of return values
Parameters:
docId - KEW document id of the document to create the adhoc request for
Parameters:
userId - netid of the user who is making this request
Parameters:
recipientUserId - netid of the user for whom the request is being created
Parameters:
annotation - a comment associated with this request Map including the standard set of return values
See Also: edu.cornell.kew.service.CornellKewService.requestAdHocApproveToUser(java.lang.Stringjava.lang.Stringjava.lang.Stringjava.lang.String) |
| requestAdHocFyiToGroup | | public StandardResponse requestAdHocFyiToGroup(String docId, String userId, String recipientGroupId, String annotation)(Code) | |
- Create a WorkflowDocument based on the docId and userId passed in
- Add the adhoc fyi request (app specific route) to the passed in group with the passed in annotation
- Return the standard set of return values
Parameters:
docId - KEW document id of the document to create the adhoc request for
Parameters:
userId - netid of the user who is making this request
Parameters:
recipientGroupId - workgroupId of the group to create this request for
Parameters:
annotation - a comment associated with this request Map including the standard set of return values
See Also: edu.cornell.kew.service.CornellKewService.requestAdHocFyiToGroup(java.lang.Stringjava.lang.Stringjava.lang.Stringjava.lang.String) |
| requestAdHocFyiToUser | | public StandardResponse requestAdHocFyiToUser(String docId, String userId, String recipientUserId, String annotation)(Code) | |
- Create a WorkflowDocument based on the docId and userId passed in
- Add the adhoc fyi request (app specific route) to the passed in user with the passed in annotation
- Return the standard set of return values
Parameters:
docId - KEW document id of the document to create the adhoc request for
Parameters:
userId - netid of the user who is making this request
Parameters:
recipientUserId - netid of the user for whom the request is being created
Parameters:
annotation - a comment associated with this request Map including the standard set of return values
See Also: edu.cornell.kew.service.CornellKewService.requestAdHocFyiToUser(java.lang.Stringjava.lang.Stringjava.lang.Stringjava.lang.String) |
| returnToPreviousNode | | public StandardResponse returnToPreviousNode(String docId, String userId, String annotation, String nodeName)(Code) | | Return a KEW document to a previous route node. This method should
be used with caution.
Parameters:
annotation - a comment associated with this request
Parameters:
nodeName - name of the route node to return to Map including the standard set of return values
See Also: edu.cornell.kew.service.CornellKewService.returnToPreviousNode(java.lang.Stringjava.lang.String) |
| route | | public StandardResponse route(String docId, String userId, String docTitle, String docContent, String annotation)(Code) | |
- Create a WorkflowDocument based on the docId and userId passed in
- Set the docTitle and docContent if they are passed in
- Route the document with the passed in annotation
- Return the standard set of return values.
Parameters:
docId - KEW document id of the document to route
Parameters:
userId - netid of the user who is routing the document
Parameters:
docTitle - title for this document
Parameters:
docContent - xml content for this document
Parameters:
annotation - a comment associated with this request Map including the standard set of return values
See Also: edu.cornell.kew.service.CornellKewService.route(java.lang.Stringjava.lang.Stringjava.lang.Stringjava.lang.Stringjava.lang.String) |
| save | | public StandardResponse save(String docId, String userId, String docTitle, String annotation)(Code) | |
- Create a WorkflowDocument based on the docId and userId passed in
- Set the docTitle if it was passed in
- Save the document with the passed in annotation (keep in user's action list)
- Return the standard set of return values.
Parameters:
docId - KEW document id of the document to save
Parameters:
userId - netid of the user who is saving the document
Parameters:
docTitle - title for this document
Parameters:
annotation - a comment associated with this request Map including the standard set of return values
See Also: edu.cornell.kew.service.CornellKewService.save(java.lang.Stringjava.lang.Stringjava.lang.Stringjava.lang.String) |
| updateNote | | public NoteResponse updateNote(String docId, String noteId, String userId, String noteText)(Code) | | Update an existing note to this KEW document.
Parameters:
docId - KEW document id of the document to update the note for
Parameters:
noteId - the id of the note to update
Parameters:
userId - netid of the user who is updating the note
Parameters:
noteText - text of the note if changed Map containing relevant note information (author, noteId, timestamp, noteText)along with an error message (if any)
See Also: edu.cornell.kew.service.CornellKewService.updateNote(java.lang.Stringjava.lang.Stringjava.lang.Stringjava.lang.String) |
|
|