Package org.alfresco.module.org_alfresco_module_rm.script

Class AbstractRmWebScript

java.lang.Object
org.springframework.extensions.webscripts.AbstractWebScript
org.springframework.extensions.webscripts.DeclarativeWebScript
org.alfresco.module.org_alfresco_module_rm.script.AbstractRmWebScript
All Implemented Interfaces:
org.springframework.extensions.webscripts.WebScript
Direct Known Subclasses:
BaseCustomPropertyWebScript, CustomPropertyDefinitionDelete, CustomRefDelete, CustomReferenceDefinitionBase, CustomRefPost, CustomRefsGet, DispositionAbstractBase, RecordedVersionConfigGet, RecordedVersionConfigPost, RelationshipDelete, RelationshipLabelsGet, RelationshipsGet
public abstract class AbstractRmWebScript extends org.springframework.extensions.webscripts.DeclarativeWebScript
Abstract base class for all RM webscript classes. Includes utility methods for processing the webscript request.
Author:
Neil McErlean, Tuna Aksoy, Gavin Cornwell

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.springframework.extensions.webscripts.AbstractWebScript

    org.springframework.extensions.webscripts.AbstractWebScript.ScriptDetails

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected static final String
    ID
     
    protected static final String
    INVERT
     
    protected static final String
    PATH_SEPARATOR
    Constants
    protected static final String
    STORE_ID
     
    protected static final String
    STORE_TYPE
     
    protected static final String
    SUCCESS
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    AbstractRmWebScript()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected DispositionService
    getDispositionService()
    Gets the disposition service instance
    protected NamespaceService
    getNamespaceService()
    Gets the namespace service instance
    protected NodeService
    getNodeService()
    Gets the node service instance
    protected NodeRef
    parseRequestForNodeRef(org.springframework.extensions.webscripts.WebScriptRequest req)
    Parses the request and providing it's valid returns the NodeRef.
    void
    setDispositionService(DispositionService dispositionService)
    Sets the disposition service instance
    void
    setNamespaceService(NamespaceService namespaceService)
    Sets the namespace service instance
    void
    setNodeService(NodeService nodeService)
    Sets the node service instance

    Methods inherited from class org.springframework.extensions.webscripts.DeclarativeWebScript

    execute, executeFinallyImpl, executeImpl, executeImpl, executeImpl, getTemplateModel, renderFormatTemplate

    Methods inherited from class org.springframework.extensions.webscripts.AbstractWebScript

    addModuleBundleToCache, checkModuleBundleCache, createArgs, createArgsM, createHeaders, createHeadersM, createScriptParameters, createStatusException, createTemplateParameters, executeScript, getContainer, getDescription, getExecuteScript, getResources, getStatusTemplate, init, renderString, renderString, renderTemplate, sendStatus, setURLModelFactory, toString

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

    • AbstractRmWebScript

      public AbstractRmWebScript()

  • Method Details

    • getDispositionService

      protected DispositionService getDispositionService()
      Gets the disposition service instance
      Returns:
      The disposition service instance

    • setDispositionService

      public void setDispositionService(DispositionService dispositionService)
      Sets the disposition service instance
      Parameters:
      dispositionService - The disposition service instance

    • getNamespaceService

      protected NamespaceService getNamespaceService()
      Gets the namespace service instance
      Returns:
      The namespace service instance

    • setNamespaceService

      public void setNamespaceService(NamespaceService namespaceService)
      Sets the namespace service instance
      Parameters:
      namespaceService - The namespace service instance

    • getNodeService

      protected NodeService getNodeService()
      Gets the node service instance
      Returns:
      The node service instance

    • setNodeService

      public void setNodeService(NodeService nodeService)
      Sets the node service instance
      Parameters:
      nodeService - The node service instance

    • parseRequestForNodeRef

      protected NodeRef parseRequestForNodeRef(org.springframework.extensions.webscripts.WebScriptRequest req)
      Parses the request and providing it's valid returns the NodeRef.
      Parameters:
      req - The webscript request
      Returns:
      The NodeRef passed in the request