Coverage Report - org.kuali.rice.kew.webservice.SimpleDocumentActionsWebService
 
Classes in this File Line Coverage Branch Coverage Complexity
SimpleDocumentActionsWebService
N/A
N/A
N/A
N/A
1
 
 1   
 /*
 2   
  * Copyright 2005-2008 The Kuali Foundation
 3   
  *
 4   
  *
 5   
  * Licensed under the Educational Community License, Version 2.0 (the "License");
 6   
  * you may not use this file except in compliance with the License.
 7   
  * You may obtain a copy of the License at
 8   
  *
 9   
  * http://www.opensource.org/licenses/ecl2.php
 10   
  *
 11   
  * Unless required by applicable law or agreed to in writing, software
 12   
  * distributed under the License is distributed on an "AS IS" BASIS,
 13   
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 14   
  * See the License for the specific language governing permissions and
 15   
  * limitations under the License.
 16   
  */
 17   
 package org.kuali.rice.kew.webservice;
 18   
 
 19   
 import javax.jws.WebParam;
 20   
 import javax.jws.WebService;
 21   
 import javax.jws.soap.SOAPBinding;
 22   
 
 23   
 import org.kuali.rice.kew.util.KEWWebServiceConstants;
 24   
 
 25   
 /**
 26   
  * SimpleDocumentActionsWebService is a simplified view into KEW that exposes those methods that would be required by a basic
 27   
  * client as a web service that is meant to be as interoperable as possible (using simple types, etc.) The standard return is
 28   
  * a simple structure containing a standard set of return values:
 29   
  * <ul>
 30   
  * <li>docStatus String - current status of document in KEW</li>
 31   
  * <li>createDate String - date document was created in KEW</li>
 32   
  * <li>initiatorPrincipalId String - principal id of document initiator</li>
 33   
  * <li>appDocId String - application specific document id</li>
 34   
  * <li>initiatorName String - display name of the document initiator</li>
 35   
  * <li>routedByprincipalId String - id of the user that routed the document (can be different from initiator)</li>
 36   
  * <li>routedByUserName String - display name of the user that routed the document (can be different from initiator)</li>
 37   
  * <li>errorMessage String - error message from KEW if any</li>
 38   
  * </ul>
 39   
  *
 40   
  * @author Kuali Rice Team (rice.collab@kuali.org)
 41   
  */
 42   
 @WebService(name = KEWWebServiceConstants.SimpleDocumentActionsWebService.WEB_SERVICE_NAME, targetNamespace = KEWWebServiceConstants.MODULE_TARGET_NAMESPACE)
 43   
 @SOAPBinding(style = SOAPBinding.Style.DOCUMENT, use = SOAPBinding.Use.LITERAL, parameterStyle = SOAPBinding.ParameterStyle.WRAPPED)
 44   
 public interface SimpleDocumentActionsWebService {
 45   
 
 46   
     /**
 47   
      * Create a KEW document.
 48   
      *
 49   
      * @param initiatorPrincipalId
 50   
      *            principal id of the document initiator
 51   
      * @param appDocId
 52   
      *            application specific document id
 53   
      * @param docType
 54   
      *            KEW document type for the document to be created
 55   
      * @param docTitle
 56   
      *            title for this document
 57   
      * @return DocumentResponse including the standard set of return values and the docId of the newly created document
 58   
      */
 59   
     public DocumentResponse create( @WebParam(name = "initiatorPrincipalId") String initiatorPrincipalId,
 60   
                                     @WebParam(name = "appDocId") String appDocId,
 61   
                                     @WebParam(name = "docType") String docType,
 62   
                                     @WebParam(name = "docTitle") String docTitle);
 63   
 
 64   
     /**
 65   
      * Route a KEW document.
 66   
      *
 67   
      * @param docId
 68   
      *            KEW document id of the document to route
 69   
      * @param principalId
 70   
      *            principal id of the user who is routing the document
 71   
      * @param docTitle
 72   
      *            title for this document
 73   
      * @param docContent
 74   
      *            xml content for this document
 75   
      * @param annotation
 76   
      *            a comment associated with this request
 77   
      * @return StandardResponse including the standard set of return values
 78   
      */
 79   
     public StandardResponse route(  @WebParam(name = "docId") String docId,
 80   
                                     @WebParam(name = "principalId")String principalId,
 81   
                                     @WebParam(name = "docTitle")String docTitle,
 82   
                                     @WebParam(name = "docContent")String docContent,
 83   
                                     @WebParam(name = "annotation")String annotation);
 84   
 
 85   
     /**
 86   
      * Approve the KEW document, in response to an approval action request.
 87   
      *
 88   
      * @param docId
 89   
      *            KEW document id of the document to approve
 90   
      * @param principalId
 91   
      *            principal id of the user who is approving the document
 92   
      * @param docTitle
 93   
      *            title for this document
 94   
      * @param docContent
 95   
      *            xml content for this document
 96   
      * @param annotation
 97   
      *            a comment associated with this request
 98   
      * @return StandardResponse including the standard set of return values
 99   
      */
 100   
     public StandardResponse approve(    @WebParam(name = "docId") String docId,
 101   
                                         @WebParam(name = "principalId") String principalId,
 102   
                                         @WebParam(name = "docTitle") String docTitle,
 103   
                                         @WebParam(name = "docContent") String docContent,
 104   
                                         @WebParam(name = "annotation") String annotation);
 105   
 
 106   
     /**
 107   
      * Blanket Approve the KEW document (all future approval requests will be satisfied), in response to an approval action
 108   
      * request. Can only be performed by a super user.
 109   
      *
 110   
      * @param docId
 111   
      *            KEW document id of the document to blanket approve
 112   
      * @param principalId
 113   
      *            principal id of the user who is blanket approving the document
 114   
      * @param docTitle
 115   
      *            title for this document
 116   
      * @param docContent
 117   
      *            xml content for this document
 118   
      * @param annotation
 119   
      *            a comment associated with this request
 120   
      * @return StandardResponse including the standard set of return values
 121   
      */
 122   
     public StandardResponse blanketApprove( @WebParam(name = "docId") String docId,
 123   
                                             @WebParam(name = "principalId") String principalId,
 124   
                                             @WebParam(name = "docTitle") String docTitle,
 125   
                                             @WebParam(name = "docContent") String docContent,
 126   
                                             @WebParam(name = "annotation") String annotation);
 127   
 
 128   
     /**
 129   
      * Cancel the KEW document.
 130   
      *
 131   
      * @param docId
 132   
      *            KEW document id of the document to cancel
 133   
      * @param principalId
 134   
      *            principal id of the user who is canceling the document
 135   
      * @param annotation
 136   
      *            a comment associated with this request
 137   
      * @return StandardResponse including the standard set of return values
 138   
      */
 139   
     public StandardResponse cancel( @WebParam(name = "docId") String docId,
 140   
                                     @WebParam(name = "principalId") String principalId,
 141   
                                     @WebParam(name = "annotation") String annotation);
 142   
 
 143   
     /**
 144   
      * Disapprove the KEW document, in response to an approval action request.
 145   
      *
 146   
      * @param docId
 147   
      *            KEW document id of the document to disapprove
 148   
      * @param principalId
 149   
      *            principal id of the user who is disapproving the document
 150   
      * @param annotation
 151   
      *            a comment associated with this request
 152   
      * @return StandardResponse including the standard set of return values
 153   
      */
 154   
     public StandardResponse disapprove( @WebParam(name = "docId") String docId,
 155   
                                         @WebParam(name = "principalId") String principalId,
 156   
                                         @WebParam(name = "annotation") String annotation);
 157   
 
 158   
     /**
 159   
      * Acknowledge the KEW document, in response to an acknowledge action request.
 160   
      *
 161   
      * @param docId
 162   
      *            KEW document id of the document to acknowledge
 163   
      * @param principalId
 164   
      *            principal id of the user who is acknowledging the document
 165   
      * @param annotation
 166   
      *            a comment associated with this request
 167   
      * @return StandardResponse including the standard set of return values
 168   
      */
 169   
     public StandardResponse acknowledge(    @WebParam(name = "docId") String docId,
 170   
                                             @WebParam(name = "principalId") String principalId,
 171   
                                             @WebParam(name = "annotation") String annotation);
 172   
 
 173   
     /**
 174   
      * Clear an FYI request for this KEW document from the user's action list, in response to an FYI action request.
 175   
      *
 176   
      * @param docId
 177   
      *            KEW document id of the document to acknowledge
 178   
      * @param principalId
 179   
      *            principal id of the user who is acknowledging the document
 180   
      * @return StandardResponse including the standard set of return values
 181   
      */
 182   
     public StandardResponse fyi(    @WebParam(name = "docId") String docId,
 183   
                                     @WebParam(name = "principalId") String principalId);
 184   
 
 185   
     /**
 186   
      * Save the KEW document, keeps it in the user's action list for completion later.
 187   
      *
 188   
      * @param docId
 189   
      *            KEW document id of the document to save
 190   
      * @param principalId
 191   
      *            principal id of the user who is saving the document
 192   
      * @param docTitle
 193   
      *            title for this document
 194   
      * @param docContent
 195   
      *            xml content for this document
 196   
      * @param annotation
 197   
      *            a comment associated with this request
 198   
      * @return StandardResponse including the standard set of return values
 199   
      */
 200   
     public StandardResponse save(   @WebParam(name = "docId") String docId,
 201   
                                     @WebParam(name = "principalId") String principalId,
 202   
                                     @WebParam(name = "docTitle") String docTitle,
 203   
                                     @WebParam(name = "docContent") String docContent,
 204   
                                     @WebParam(name = "annotation") String annotation);
 205   
 
 206   
     /**
 207   
      * Save the KEW document content and update the docTitle if fields are non-null.
 208   
      *
 209   
      * @param docId
 210   
      *            KEW document id of the document to save
 211   
      * @param principalId
 212   
      *            principal id of the user who is saving the document
 213   
      * @param docTitle
 214   
      *            title for this document
 215   
      * @param docContent
 216   
      *            xml content for this document
 217   
      * @return StandardResponse including the standard set of return values
 218   
      */
 219   
     public StandardResponse saveDocumentContent(    @WebParam(name = "docId") String docId,
 220   
                                                     @WebParam(name = "principalId") String principalId,
 221   
                                                     @WebParam(name = "docTitle") String docTitle,
 222   
                                                     @WebParam(name = "docContent") String docContent);
 223   
 
 224   
     /**
 225   
      * Create an Adhoc FYI request for another user for this KEW document. NOTE: Must make a subsequent call to route in
 226   
      * order for the action request to be created. This allows the user to create multiple adhoc requests at the same time
 227   
      * prior to routing.
 228   
      *
 229   
      * @param docId
 230   
      *            KEW document id of the document to create the adhoc request for
 231   
      * @param principalId
 232   
      *            principal id of the user who is making this request
 233   
      * @param recipientPrincipalId
 234   
      *            principal id of the user for whom the request is being created
 235   
      * @param annotation
 236   
      *            a comment associated with this request
 237   
      * @return StandardResponse including the standard set of return values
 238   
      */
 239   
     public StandardResponse requestAdHocFyiToPrincipal( @WebParam(name = "docId") String docId,
 240   
                                                         @WebParam(name = "principalId") String principalId,
 241   
                                                         @WebParam(name = "recipientPrincipalId") String recipientPrincipalId,
 242   
                                                         @WebParam(name = "annotation") String annotation);
 243   
 
 244   
     /**
 245   
      * Create an Adhoc FYI request for another group for this KEW document. NOTE: Must make a subsequent call to route in
 246   
      * order for the action request to be created. This allows the user to create multiple adhoc requests at the same time
 247   
      * prior to routing.
 248   
      *
 249   
      * @param docId
 250   
      *            KEW document id of the document to create the adhoc request for
 251   
      * @param principalId
 252   
      *            principal id of the user who is making this request
 253   
      * @param recipientGroupId
 254   
      *            group id of the group to create this request for
 255   
      * @param annotation
 256   
      *            a comment associated with this request
 257   
      * @return StandardResponse including the standard set of return values
 258   
      */
 259   
     public StandardResponse requestAdHocFyiToGroup( @WebParam(name = "docId") String docId,
 260   
                                                     @WebParam(name = "principalId") String principalId,
 261   
                                                     @WebParam(name = "recipientGroupId") String recipientGroupId,
 262   
                                                     @WebParam(name = "annotation") String annotation);
 263   
 
 264   
     /**
 265   
      * Create an Adhoc Acknowledge request for another user for this KEW document. NOTE: Must make a subsequent call to route
 266   
      * in order for the action request to be created. This allows the user to create multiple adhoc requests at the same time
 267   
      * prior to routing.
 268   
      *
 269   
      * @param docId
 270   
      *            KEW document id of the document to create the adhoc request for
 271   
      * @param principalId
 272   
      *            principal id of the user who is making this request
 273   
      * @param recipientPrincipalId
 274   
      *            principal id of the user for whom the request is being created
 275   
      * @param annotation
 276   
      *            a comment associated with this request
 277   
      * @return StandardResponse including the standard set of return values
 278   
      */
 279   
     public StandardResponse requestAdHocAckToPrincipal( @WebParam(name = "docId") String docId,
 280   
                                                         @WebParam(name = "principalId") String principalId,
 281   
                                                         @WebParam(name = "recipientPrincipalId") String recipientPrincipalId,
 282   
                                                         @WebParam(name = "annotation") String annotation);
 283   
 
 284   
     /**
 285   
      * Create an Adhoc Acknowledge request for another group for this KEW document. NOTE: Must make a subsequent call to
 286   
      * route in order for the action request to be created. This allows the user to create multiple adhoc requests at the
 287   
      * same time prior to routing.
 288   
      *
 289   
      * @param docId
 290   
      *            KEW document id of the document to create the adhoc request for
 291   
      * @param principalId
 292   
      *            principal id of the user who is making this request
 293   
      * @param recipientGroupId
 294   
      *            group id of the group to create this request for
 295   
      * @param annotation
 296   
      *            a comment associated with this request
 297   
      * @return StandardResponse including the standard set of return values
 298   
      */
 299   
     public StandardResponse requestAdHocAckToGroup( @WebParam(name = "docId") String docId,
 300   
                                                     @WebParam(name = "principalId") String principalId,
 301   
                                                     @WebParam(name = "recipientGroupId") String recipientGroupId,
 302   
                                                     @WebParam(name = "annotation") String annotation);
 303   
 
 304   
     /**
 305   
      * Create an Adhoc Approval request for another user for this KEW document. NOTE: Must make a subsequent call to route in
 306   
      * order for the action request to be created. This allows the user to create multiple adhoc requests at the same time
 307   
      * prior to routing.
 308   
      *
 309   
      * @param docId
 310   
      *            KEW document id of the document to create the adhoc request for
 311   
      * @param principalId
 312   
      *            principal id of the user who is making this request
 313   
      * @param recipientPrincipalId
 314   
      *            principal id of the user for whom the request is being created
 315   
      * @param annotation
 316   
      *            a comment associated with this request
 317   
      * @return StandardResponse including the standard set of return values
 318   
      */
 319   
     public StandardResponse requestAdHocApproveToPrincipal( @WebParam(name = "docId") String docId,
 320   
                                                             @WebParam(name = "principalId") String principalId,
 321   
                                                             @WebParam(name = "recipientPrincipalId") String recipientPrincipalId,
 322   
                                                             @WebParam(name = "annotation") String annotation);
 323   
 
 324   
     /**
 325   
      * Create an Adhoc Approval request for another group for this KEW document. NOTE: Must make a subsequent call to route
 326   
      * in order for the action request to be created. This allows the user to create multiple adhoc requests at the same time
 327   
      * prior to routing.
 328   
      *
 329   
      * @param docId
 330   
      *            KEW document id of the document to create the adhoc request for
 331   
      * @param principalId
 332   
      *            principal id of the user who is making this request
 333   
      * @param recipientGroupId
 334   
      *            group id of the group to create this request for
 335   
      * @param annotation
 336   
      *            a comment associated with this request
 337   
      * @return StandardResponse including the standard set of return values
 338   
      */
 339   
     public StandardResponse requestAdHocApproveToGroup( @WebParam(name = "docId") String docId,
 340   
                                                         @WebParam(name = "principalId") String principalId,
 341   
                                                         @WebParam(name = "recipientGroupId") String recipientGroupId,
 342   
                                                         @WebParam(name = "annotation") String annotation);
 343   
 
 344   
     /**
 345   
      * Check to see if the user is associated with this KEW document. Useful for security purposes (if return is False, user
 346   
      * shouldn't be able to see the document unless it's public.)
 347   
      *
 348   
      * @param docId
 349   
      *            KEW document id of the document to check
 350   
      * @param principalId
 351   
      *            principal id of the user to check
 352   
      * @return UserInRouteLogResponse containing True/False for isUserInRouteLog and an error message if a problem occured
 353   
      */
 354   
     public UserInRouteLogResponse isUserInRouteLog( @WebParam(name = "docId") String docId,
 355   
                                                     @WebParam(name = "principalId") String principalId);
 356   
 
 357   
     /**
 358   
      * Retrieve a KEW document based on the docId and principalId passed in, and return the information about the document.
 359   
      *
 360   
      * @param docId
 361   
      *            KEW document id of the document to retrieve information about
 362   
      * @param principalId
 363   
      *            principal id of the user to retrieve the document for
 364   
      * @return DocumentResponse including the standard set of return values, the xml document content, the title, the action
 365   
      *         requested ( Approve, Aknowledge, Fyi, Complete ) and an array of Maps containing the following for each Note
 366   
      *         (author, noteId, timestamp, noteText).
 367   
      */
 368   
     public DocumentResponse getDocument(    @WebParam(name = "docId") String docId,
 369   
                                             @WebParam(name = "principalId") String principalId);
 370   
 
 371   
     /**
 372   
      * Add a note (possibly including a binary attachment) to this KEW document.
 373   
      *
 374   
      * @param docId
 375   
      *            KEW document id of the document to add the note to
 376   
      * @param principalId
 377   
      *            principal id of the user who is adding the note
 378   
      * @param noteText
 379   
      *            text of the note
 380   
      * @return NoteResponse containing relevant note information (author, noteId, timestamp, noteText) along with an error
 381   
      *         message (if any)
 382   
      */
 383   
     public NoteResponse addNote(    @WebParam(name = "docId") String docId,
 384   
                                     @WebParam(name = "principalId") String principalId,
 385   
                                     @WebParam(name = "noteText") String noteText);
 386   
 
 387   
     /**
 388   
      * Update an existing note (possibly including a binary attachment) to this KEW document.
 389   
      *
 390   
      * @param docId
 391   
      *            KEW document id of the document to update the note for
 392   
      * @param noteId
 393   
      *            the id of the note to update
 394   
      * @param principalId
 395   
      *            principal id of the user who is updating the note
 396   
      * @param noteText
 397   
      *            text of the note if changed
 398   
      * @return NoteResponse containing relevant note information (author, noteId, timestamp, noteText) along with an error
 399   
      *         message (if any)
 400   
      */
 401   
     public NoteResponse updateNote( @WebParam(name = "docId") String docId,
 402   
                                     @WebParam(name = "noteId") String noteId,
 403   
                                     @WebParam(name = "principalId") String principalId,
 404   
                                     @WebParam(name = "noteText") String noteText);
 405   
 
 406   
     /**
 407   
      * Delete an existing note.
 408   
      *
 409   
      * @param docId
 410   
      *            KEW document id of the document to delete the note from
 411   
      * @param noteId
 412   
      *            the id of the note to delete
 413   
      * @param principalId
 414   
      *            principal id of the user who is deleting the note
 415   
      * @return ErrorResponse containing an error message if any
 416   
      */
 417   
     public ErrorResponse deleteNote(    @WebParam(name = "docId") String docId,
 418   
                                         @WebParam(name = "noteId") String noteId,
 419   
                                         @WebParam(name = "principalId") String principalId);
 420   
 
 421   
     /**
 422   
      * Return a KEW document to a previous route node. This method should be used with caution.
 423   
      *
 424   
      * @param docId
 425   
      *            KEW document id of the document to return to a previous node
 426   
      * @param principalId
 427   
      *            principal id of the user who is requesting this action
 428   
      * @param annotation
 429   
      *            a comment associated with this request
 430   
      * @param nodeName
 431   
      *            name of the route node to return to
 432   
      * @return StandardResponse including the standard set of return values
 433   
      */
 434   
     public StandardResponse returnToPreviousNode(   @WebParam(name = "docId") String docId,
 435   
                                                     @WebParam(name = "principalId") String principalId,
 436   
                                                     @WebParam(name = "annotation") String annotation,
 437   
                                                     @WebParam(name = "nodeName") String nodeName);
 438   
 
 439   
     /**
 440   
      * Return a KEW document to a previous route node. This method should be used with caution.
 441   
      *
 442   
      * @param docId
 443   
      *            KEW document id of the document to return to a previous node
 444   
      * @param principalId
 445   
      *            principal id of the user who is requesting this action
 446   
      * @param annotation
 447   
      *            a comment associated with this request
 448   
      * @param nodeName
 449   
      *            name of the route node to return to
 450   
      * @param docTitle
 451   
      *            title for this document
 452   
      * @param docContent
 453   
      *            xml content for this document
 454   
      * @return StandardResponse including the standard set of return values
 455   
      */
 456   
     public StandardResponse returnToPreviousNodeWithUpdates(    @WebParam(name = "docId") String docId,
 457   
                                                                 @WebParam(name = "principalId") String principalId,
 458   
                                                                 @WebParam(name = "annotation") String annotation,
 459   
                                                                 @WebParam(name = "nodeName") String nodeName,
 460   
                                                                 @WebParam(name = "docTitle") String docTitle,
 461   
                                                                 @WebParam(name = "docContent") String docContent);
 462   
 
 463   
     /**
 464   
      * This method revokes all AdHoc requests set on the document at the specified node.
 465   
      *
 466   
      * @param docId
 467   
      *            KEW document id of the document
 468   
      * @param principalId
 469   
      *            principal id of the user who is revoking the requests
 470   
      * @param docTitle
 471   
      *            title for this document (updated if non-null)
 472   
      * @param docContent
 473   
      *            xml content for this document (updated if non-null)
 474   
      * @param nodeName
 475   
      *            name of the route node that adhoc requests should be revoked from
 476   
      * @param annotation
 477   
      *            a comment associated with this request
 478   
      * @return StandardResponse including the standard set of return values
 479   
      */
 480   
     public StandardResponse revokeAdHocRequestsByNodeName(String docId, String principalId, String docTitle, String docContent, String nodeName, String annotation);
 481   
 
 482   
     /**
 483   
      * This method revokes all AdHoc requests set on the document for the specified principal.
 484   
      *
 485   
      * @param docId
 486   
      *            KEW document id of the document
 487   
      * @param principalId
 488   
      *            principal id of the user who is revoking the requests
 489   
      * @param docTitle
 490   
      *            title for this document (updated if non-null)
 491   
      * @param docContent
 492   
      *            xml content for this document (updated if non-null)
 493   
      * @param adhocPrincipalId
 494   
      *            principal ID of the principal that should have all their adhoc requests revoked
 495   
      * @param annotation
 496   
      *            a comment associated with this request
 497   
      * @return StandardResponse including the standard set of return values
 498   
      */
 499   
     public StandardResponse revokeAdHocRequestsByPrincipalId(String docId, String principalId, String docTitle, String docContent, String adhocPrincipalId, String annotation);
 500   
 
 501   
     /**
 502   
      * This method revokes all AdHoc requests set on the document for a specified group.
 503   
      *
 504   
      * @param docId
 505   
      *            KEW document id of the document that is being returned
 506   
      * @param principalId
 507   
      *            principal id of the user who is revoking the requests
 508   
      * @param docTitle
 509   
      *            title for this document (updated if non-null)
 510   
      * @param docContent
 511   
      *            xml content for this document (updated if non-null)
 512   
      * @param groupId
 513   
      *            groupId of the group that should have adhoc requests revoked
 514   
      * @param annotation
 515   
      *            a comment associated with this request
 516   
      * @return StandardResponse including the standard set of return values
 517   
      */
 518   
     public StandardResponse revokeAdHocRequestsByGroupId(String docId, String principalId, String docTitle, String docContent, String groupId, String annotation);
 519   
 
 520   
     /**
 521   
      * This method revokes the AdHoc request set on the document for the specified action request.
 522   
      *
 523   
      * @param docId
 524   
      *            KEW document id of the document
 525   
      * @param principalId
 526   
      *            principal id of the user who is revoking the requests
 527   
      * @param docTitle
 528   
      *            title for this document (updated if non-null)
 529   
      * @param docContent
 530   
      *            xml content for this document (updated if non-null)
 531   
      * @param actionRequestId
 532   
      *            the id of the adhoc request to be revoked
 533   
      * @param annotation
 534   
      *            a comment associated with this request
 535   
      * @return StandardResponse including the standard set of return values
 536   
      */
 537   
     public StandardResponse revokeAdHocRequestsByActionRequestId(String docId, String principalId, String docTitle, String docContent, String actionRequestId, String annotation);
 538   
 
 539   
     /**
 540   
      * This method will super user approve the document.
 541   
      *
 542   
      * @param docId
 543   
      *            KEW document id of the document
 544   
      * @param superUserPrincipalId
 545   
      *            principal id of the super user who is taking the action
 546   
      * @param docTitle
 547   
      *            title for this document (updated if non-null)
 548   
      * @param docContent
 549   
      *            xml content for this document (updated if non-null)
 550   
      * @param annotation
 551   
      *            a comment associated with this request
 552   
      * @return StandardResponse including the standard set of return values
 553   
      */
 554   
     public StandardResponse superUserApprove(String docId, String superUserPrincipalId, String docTitle, String docContent, String annotation);
 555   
 
 556   
     /**
 557   
      * This method will super user disapprove the document.
 558   
      *
 559   
      * @param docId
 560   
      *            KEW document id of the document
 561   
      * @param superUserPrincipalId
 562   
      *            principal id of the super user who is taking the action
 563   
      * @param docTitle
 564   
      *            title for this document (updated if non-null)
 565   
      * @param docContent
 566   
      *            xml content for this document (updated if non-null)
 567   
      * @param annotation
 568   
      *            a comment associated with this request
 569   
      * @return StandardResponse including the standard set of return values
 570   
      */
 571   
     public StandardResponse superUserDisapprove(String docId, String superUserPrincipalId, String docTitle, String docContent, String annotation);
 572   
 
 573   
     /**
 574   
      * This method will super user cancel the document.
 575   
      *
 576   
      * @param docId
 577   
      *            KEW document id of the document
 578   
      * @param superUserPrincipalId
 579   
      *            principal id of the super user who is taking the action
 580   
      * @param docTitle
 581   
      *            title for this document (updated if non-null)
 582   
      * @param docContent
 583   
      *            xml content for this document (updated if non-null)
 584   
      * @param annotation
 585   
      *            a comment associated with this request
 586   
      * @return StandardResponse including the standard set of return values
 587   
      */
 588   
     public StandardResponse superUserCancel(String docId, String superUserPrincipalId, String docTitle, String docContent, String annotation);
 589   
 
 590   
     /**
 591   
      * Return a KEW document to a previous route node. This method should be used with caution.
 592   
      *
 593   
      * @param docId
 594   
      *            KEW document id of the document to return to a previous node
 595   
      * @param superUserPrincipalId
 596   
      *            principal id of the super user who is requesting this action
 597   
      * @param docTitle
 598   
      *            title for this document (updated if non-null)
 599   
      * @param docContent
 600   
      *            xml content for this document (updated if non-null)
 601   
      * @param nodeName
 602   
      *            name of the route node to return to
 603   
      * @param annotation
 604   
      *            a comment associated with this request
 605   
      * @return StandardResponse including the standard set of return values
 606   
      */
 607   
     public StandardResponse superUserReturnToPrevious(String docId, String superUserPrincipalId, String docTitle, String docContent, String nodeName, String annotation);
 608   
 
 609   
 }
Report generated by Cobertura 1.9.4.1 on 7/2/11 3:58 AM.