Class RmSubstitutionSuggestionsGet

java.lang.Object
org.springframework.extensions.webscripts.AbstractWebScript
org.springframework.extensions.webscripts.DeclarativeWebScript
org.alfresco.repo.web.scripts.substitutionsuggestions.RmSubstitutionSuggestionsGet
All Implemented Interfaces:
org.springframework.extensions.webscripts.WebScript

public class RmSubstitutionSuggestionsGet extends org.springframework.extensions.webscripts.DeclarativeWebScript
Implementation for Java backed webscript to get substitution suggestions given a text fragment (e.g. date.month for 'mon').
Since:
2.2
Author:
Mark Hibbins
  • Nested Class Summary

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

    org.springframework.extensions.webscripts.AbstractWebScript.ScriptDetails
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    protected Map<String,Object>
    executeImpl(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.Status status, org.springframework.extensions.webscripts.Cache cache)
    Return a list of substitutions for the given fragment.
    protected NodeRef
    getFilePlan(org.springframework.extensions.webscripts.WebScriptRequest req, boolean unfiled)
    Utility method to get the file plan from the passed parameters.
    void
     
    void
     
    void
    Set the node service
    void
    Set the parameter processor component bean
    void
    setPathSubstitutionMaximumNumberSuggestions(int pathSubstitutionMaximumNumberSuggestions)
    Set the maxmimum number of suggestions returned from the global property
    void
    setSubstitutionMinimumFragmentSize(int substitutionMinimumFragmentSize)
    Set the minimum fragment size to process for suggestion processing

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

    execute, executeFinallyImpl, 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
  • Constructor Details

    • RmSubstitutionSuggestionsGet

      public RmSubstitutionSuggestionsGet()
  • Method Details

    • setParameterProcessorComponent

      public void setParameterProcessorComponent(ParameterProcessorComponent parameterProcessorComponent)
      Set the parameter processor component bean
      Parameters:
      parameterProcessorComponent -
    • setNodeService

      public void setNodeService(NodeService nodeService)
      Set the node service
      Parameters:
      nodeService -
    • setFilePlanService

      public void setFilePlanService(FilePlanService filePlanService)
      Parameters:
      filePlanService - file plan service
    • setCapabilityService

      public void setCapabilityService(CapabilityService capabilityService)
      Parameters:
      capabilityService - file plan service
    • setSubstitutionMinimumFragmentSize

      public void setSubstitutionMinimumFragmentSize(int substitutionMinimumFragmentSize)
      Set the minimum fragment size to process for suggestion processing
      Parameters:
      substitutionMinimumFragmentSize -
    • setPathSubstitutionMaximumNumberSuggestions

      public void setPathSubstitutionMaximumNumberSuggestions(int pathSubstitutionMaximumNumberSuggestions)
      Set the maxmimum number of suggestions returned from the global property
      Parameters:
      pathSubstitutionMaximumNumberSuggestions -
    • executeImpl

      protected Map<String,Object> executeImpl(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.Status status, org.springframework.extensions.webscripts.Cache cache)
      Return a list of substitutions for the given fragment.
      Overrides:
      executeImpl in class org.springframework.extensions.webscripts.DeclarativeWebScript
      See Also:
      • DeclarativeWebScript.executeImpl(org.springframework.extensions.webscripts.WebScriptRequest, org.springframework.extensions.webscripts.Status, org.springframework.extensions.webscripts.Cache)
    • getFilePlan

      protected NodeRef getFilePlan(org.springframework.extensions.webscripts.WebScriptRequest req, boolean unfiled)
      Utility method to get the file plan from the passed parameters.
      Parameters:
      req -
      Returns: