Package org.alfresco.rest.rm.community.requests.gscore.api

Class ActionsExecutionAPI

java.lang.Object
org.alfresco.rest.requests.ModelRequest<Request>
org.alfresco.rest.rm.community.requests.RMModelRequest
org.alfresco.rest.rm.community.requests.gscore.api.ActionsExecutionAPI
public class ActionsExecutionAPI extends RMModelRequest
Produces processed results from Core Actions API calls
Since:
3.1
Author:
Claudia Agache

  • Field Summary

    Fields inherited from class org.alfresco.rest.requests.ModelRequest

    restWrapper

  • Constructor Summary

    Constructors
    Constructor
    Description
    ActionsExecutionAPI(RMRestWrapper rmRestWrapper)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.json.JSONObject
    addWORMLock(org.alfresco.utility.model.RepoTestModel targetNode)
    Add WORM lock to a node using v1 actions api
    org.json.JSONObject
    addWORMLock(org.alfresco.utility.model.RepoTestModel targetNode, int retentionPeriod)
    WORM lock a node for a period of days
    org.json.JSONObject
    declareAndFile(org.alfresco.utility.model.RepoTestModel targetNode, String destinationPath)
    Declares and files a document as record to a record folder using v1 actions api
    org.json.JSONObject
    declareAndFileVersionAsRecord(org.alfresco.utility.model.RepoTestModel targetNode, String destinationPath)
    Declares and file a document version as record to a record folder using v1 actions api
    org.json.JSONObject
    declareAsRecord(org.alfresco.utility.model.RepoTestModel targetNode)
    Declares a document as record using v1 actions api
    org.json.JSONObject
    declareVersionAsRecord(org.alfresco.utility.model.RepoTestModel targetNode)
    Declares a document version as record using v1 actions api

    Methods inherited from class org.alfresco.rest.requests.ModelRequest

    include, includePath, usingParams

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • ActionsExecutionAPI

      public ActionsExecutionAPI(RMRestWrapper rmRestWrapper)
      Parameters:
      rmRestWrapper - RM REST Wrapper

  • Method Details

    • declareAndFile

      public org.json.JSONObject declareAndFile(org.alfresco.utility.model.RepoTestModel targetNode, String destinationPath) throws Exception
      Declares and files a document as record to a record folder using v1 actions api
      Parameters:
      targetNode - the node on which the action is executed
      destinationPath - the path to the record folder
      Throws:
      Exception

    • declareAsRecord

      public org.json.JSONObject declareAsRecord(org.alfresco.utility.model.RepoTestModel targetNode) throws Exception
      Declares a document as record using v1 actions api
      Parameters:
      targetNode - the node on which the action is executed
      Throws:
      Exception

    • declareAndFileVersionAsRecord

      public org.json.JSONObject declareAndFileVersionAsRecord(org.alfresco.utility.model.RepoTestModel targetNode, String destinationPath) throws Exception
      Declares and file a document version as record to a record folder using v1 actions api
      Parameters:
      targetNode - the node on which the action is executed
      destinationPath - the path to the record folder
      Throws:
      Exception

    • declareVersionAsRecord

      public org.json.JSONObject declareVersionAsRecord(org.alfresco.utility.model.RepoTestModel targetNode) throws Exception
      Declares a document version as record using v1 actions api
      Parameters:
      targetNode - the node on which the action is executed
      Throws:
      Exception

    • addWORMLock

      public org.json.JSONObject addWORMLock(org.alfresco.utility.model.RepoTestModel targetNode)
      Add WORM lock to a node using v1 actions api
      Parameters:
      targetNode - the node on which the action is executed
      Throws:
      Exception

    • addWORMLock

      public org.json.JSONObject addWORMLock(org.alfresco.utility.model.RepoTestModel targetNode, int retentionPeriod)
      WORM lock a node for a period of days
      Parameters:
      targetNode - the node on which the action is executed
      retentionPeriod - the retention period in days for the WORM lock
      Throws:
      Exception