| edu.iu.uis.eden.server.SimpleDocumentActionsWebService
All known Subclasses: edu.iu.uis.eden.server.SimpleDocumentActionsWebServiceImpl,
| SimpleDocumentActionsWebService | | public interface SimpleDocumentActionsWebService (Code) | | 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
- initiatorId String - netid of document initiator
- appDocId String - application specific document id
- initiatorName String - display name of the document initiator
- routedByUserId 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:
Bryan G. Hutchinson (bh79 at cornell dot edu)
author:
Aaron Hamid (arh14 at cornell dot edu) |
| Inner Class :public static class UserInRouteLogResponse extends ErrorResponse | |
| Inner Class :public static class ErrorResponse | |
| Inner Class :public static class NoteResponse extends ErrorResponse | |
| Inner Class :public static class StandardResponse extends ErrorResponse | |
| Inner Class :public static class DocumentResponse extends StandardResponse | |
| Inner Class :public static class NoteDetail | |
| Method Summary | |
| public StandardResponse | acknowledge(String docId, String userId, String annotation)
Acknowledge the KEW document, in response to an acknowledge action request. | | public NoteResponse | addNote(String docId, String userId, String noteText)
Add a note (possibly including a binary attachment) to this KEW document. | | public StandardResponse | approve(String docId, String userId, String docTitle, String docContent, String annotation)
Approve the KEW document, in response to an approval action request. | | public StandardResponse | blanketApprove(String docId, String userId, 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. | | public StandardResponse | cancel(String docId, String userId, String annotation)
Cancel the KEW document. | | public DocumentResponse | create(String initiatorId, String appDocId, String docType, String docTitle)
Create a KEW document. | | public ErrorResponse | deleteNote(String docId, String noteId, String userId)
Delete an existing note. | | public StandardResponse | disapprove(String docId, String userId, String annotation)
Disapprove the KEW document, in response to an approval action request. | | public StandardResponse | fyi(String docId, String userId)
Clear an FYI request for this KEW document from the user's action list,
in response to an FYI action request. | | public DocumentResponse | getDocument(String docId, String userId)
Retrieve a KEW document based on the docId and userId passed in, and return the
information about the document. | | public UserInRouteLogResponse | isUserInRouteLog(String docId, String userId)
Check to see if the user is associated with this KEW document. | | public StandardResponse | requestAdHocAckToGroup(String docId, String userId, 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. | | public StandardResponse | requestAdHocAckToUser(String docId, String userId, String recipientUserId, 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. | | public StandardResponse | requestAdHocApproveToGroup(String docId, String userId, 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. | | public StandardResponse | requestAdHocApproveToUser(String docId, String userId, String recipientUserId, 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. | | public StandardResponse | requestAdHocFyiToGroup(String docId, String userId, 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. | | public StandardResponse | requestAdHocFyiToUser(String docId, String userId, String recipientUserId, 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. | | 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)
Route a KEW document. | | public StandardResponse | save(String docId, String userId, String docTitle, String annotation)
Save the KEW document, keeps it in the user's action list for completion later. | | public NoteResponse | updateNote(String docId, String noteId, String userId, String noteText)
Update an existing note (possibly including a binary attachment) to this KEW document. |
| acknowledge | | public StandardResponse acknowledge(String docId, String userId, String annotation)(Code) | | Acknowledge the KEW document, in response to an acknowledge action request.
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 StandardResponse including the standard set of return values |
| addNote | | public NoteResponse addNote(String docId, String userId, String noteText)(Code) | | 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
Parameters:
userId - netid of the user who is adding the note
Parameters:
noteText - text of the note NoteResponse containing relevant note information (author, noteId, timestamp, noteText)along with an error message (if any) |
| approve | | public StandardResponse approve(String docId, String userId, String docTitle, String docContent, String annotation)(Code) | | Approve the KEW document, in response to an approval action request.
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 StandardResponse including the standard set of return values |
| blanketApprove | | public StandardResponse blanketApprove(String docId, String userId, String docTitle, String docContent, String annotation)(Code) | | 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
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 StandardResponse including the standard set of return values |
| cancel | | public StandardResponse cancel(String docId, String userId, String annotation)(Code) | | Cancel the KEW document.
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 StandardResponse including the standard set of return values |
| create | | public DocumentResponse create(String initiatorId, String appDocId, String docType, String docTitle)(Code) | | Create a KEW 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 DocumentResponse including the standard set of return values and the docId of the newly created document |
| 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 ErrorResponse containing an error message if any |
| disapprove | | public StandardResponse disapprove(String docId, String userId, String annotation)(Code) | | Disapprove the KEW document, in response to an approval action request.
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 StandardResponse including the standard set of return values |
| fyi | | public StandardResponse fyi(String docId, String userId)(Code) | | 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
Parameters:
userId - netid of the user who is acknowledging the document StandardResponse including the standard set of return values |
| getDocument | | public DocumentResponse getDocument(String docId, String userId)(Code) | | Retrieve a KEW document based on the docId and userId passed in, and return the
information about the document.
Parameters:
docId - KEW document id of the document to retrieve information about
Parameters:
userId - netid of the user to retrieve the document for 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). |
| isUserInRouteLog | | public UserInRouteLogResponse isUserInRouteLog(String docId, String userId)(Code) | | 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
Parameters:
userId - netid of the user to check UserInRouteLogResponse containing True/False for isUserInRouteLog and an error message ifa problem occured |
| requestAdHocAckToGroup | | public StandardResponse requestAdHocAckToGroup(String docId, String userId, String recipientGroupId, String annotation)(Code) | | 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
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 StandardResponse including the standard set of return values |
| requestAdHocAckToUser | | public StandardResponse requestAdHocAckToUser(String docId, String userId, String recipientUserId, String annotation)(Code) | | 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
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 StandardResponse including the standard set of return values |
| requestAdHocApproveToGroup | | public StandardResponse requestAdHocApproveToGroup(String docId, String userId, String recipientGroupId, String annotation)(Code) | | 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
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 StandardResponse including the standard set of return values |
| requestAdHocApproveToUser | | public StandardResponse requestAdHocApproveToUser(String docId, String userId, String recipientUserId, String annotation)(Code) | | 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
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 StandardResponse including the standard set of return values |
| requestAdHocFyiToGroup | | public StandardResponse requestAdHocFyiToGroup(String docId, String userId, String recipientGroupId, String annotation)(Code) | | 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
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 StandardResponse including the standard set of return values |
| requestAdHocFyiToUser | | public StandardResponse requestAdHocFyiToUser(String docId, String userId, String recipientUserId, String annotation)(Code) | | 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
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 StandardResponse including the standard set of return values |
| 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:
docId - KEW document id of the document to return to a previous node
Parameters:
userId - netid of the user who is requesting this action
Parameters:
annotation - a comment associated with this request
Parameters:
nodeName - name of the route node to return to StandardResponse including the standard set of return values |
| route | | public StandardResponse route(String docId, String userId, String docTitle, String docContent, String annotation)(Code) | | Route a KEW document.
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 StandardResponse including the standard set of return values |
| save | | public StandardResponse save(String docId, String userId, String docTitle, String annotation)(Code) | | 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
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 StandardResponse including the standard set of return values |
| updateNote | | public NoteResponse updateNote(String docId, String noteId, String userId, String noteText)(Code) | | 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
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 NoteResponse containing relevant note information (author, noteId, timestamp, noteText)along with an error message (if any) |
|
|