Package org.alfresco.module.org_alfresco_module_rm_share.forms

Class FormUIGet

  • All Implemented Interfaces:
    org.springframework.extensions.webscripts.WebScript
    public class FormUIGet
extends org.alfresco.web.scripts.forms.FormUIGet
    Form UI GET method implementation override.

    Allows custom and record metadata to be automatically displayed without need for form modificiations.

    Author:
    Roy Wetherall

    • Nested Class Summary

      • Nested classes/interfaces inherited from class org.alfresco.web.scripts.forms.FormUIGet

        org.alfresco.web.scripts.forms.FormUIGet.Constraint, org.alfresco.web.scripts.forms.FormUIGet.Element, org.alfresco.web.scripts.forms.FormUIGet.Field, org.alfresco.web.scripts.forms.FormUIGet.FieldControl, org.alfresco.web.scripts.forms.FormUIGet.FieldPointer, org.alfresco.web.scripts.forms.FormUIGet.MessageHelper, org.alfresco.web.scripts.forms.FormUIGet.ModelContext, org.alfresco.web.scripts.forms.FormUIGet.Set

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

        org.springframework.extensions.webscripts.AbstractWebScript.ScriptDetails

    • Field Summary

      • Fields inherited from class org.alfresco.web.scripts.forms.FormUIGet

        ALFRESCO_PROXY, ASSOC_PREFIX, ASSOCIATION, CM_NAME_PROP, CONFIG_FORMS, configService, CONSTRAINT_FILE_NAME_HANDLER, CONSTRAINT_LENGTH, CONSTRAINT_LIST, CONSTRAINT_MANDATORY, CONSTRAINT_MINMAX, CONSTRAINT_MSG_LENGTH, CONSTRAINT_MSG_MINMAX, CONSTRAINT_MSG_NUMBER, CONSTRAINT_NODE_HANDLER, CONSTRAINT_NUMBER, CONSTRAINT_REGEX, CONTROL_PARAM_OPTION_SEPARATOR, CONTROL_PARAM_OPTIONS, CONTROL_SELECT_MANY, CONTROL_SELECT_ONE, DEFAULT_CONSTRAINT_EVENT, DEFAULT_FIELD_TYPE, DEFAULT_METHOD, DEFAULT_MODE, DEFAULT_SUBMIT_TYPE, DELIMITER, ENCTYPE_JSON, ENCTYPE_MULTIPART, ENCTYPE_URL, ENDPOINT_ID, FIELD, INDENT, MODEL_ARGUMENTS, MODEL_CAPABILITIES, MODEL_CONSTRAINTS, MODEL_CREATE_TEMPLATE, MODEL_DATA, MODEL_DATA_KEY_NAME, MODEL_DATA_TYPE, MODEL_DATA_TYPE_PARAMETERS, MODEL_DEFAULT_VALUE, MODEL_DEFINITION, MODEL_DESCRIPTION, MODEL_DESTINATION, MODEL_EDIT_TEMPLATE, MODEL_ENCTYPE, MODEL_ENDPOINT_DIRECTION, MODEL_ENDPOINT_MANDATORY, MODEL_ENDPOINT_MANY, MODEL_ENDPOINT_TYPE, MODEL_ERROR, MODEL_FIELDS, MODEL_FORCE, MODEL_FORM, MODEL_FORM_DATA, MODEL_GROUP, MODEL_INDEX_TOKENISATION_MODE, MODEL_JAVASCRIPT, MODEL_LABEL, MODEL_MANDATORY, MODEL_MAX_LENGTH, MODEL_MESSAGE, MODEL_METHOD, MODEL_MODE, MODEL_NAME, MODEL_PARAMETERS, MODEL_PROTECTED_FIELD, MODEL_REDIRECT, MODEL_REPEATING, MODEL_SHOW_CANCEL_BUTTON, MODEL_SHOW_CAPTION, MODEL_SHOW_RESET_BUTTON, MODEL_SHOW_SUBMIT_BUTTON, MODEL_STRUCTURE, MODEL_SUBMISSION_URL, MODEL_TYPE, MODEL_VIEW_TEMPLATE, MSG_DEFAULT_FORM_ERROR, MSG_DEFAULT_SET_LABEL, OLD_DATA_TYPE_PREFIX, PARAM_ERROR_KEY, PARAM_FORM_ID, PARAM_ITEM_ID, PARAM_ITEM_KIND, PARAM_JS, PARAM_SUBMISSION_URL, PARAM_SUBMIT_TYPE, PROP_PREFIX, PROPERTY, SET, SUBMIT_TYPE_JSON, SUBMIT_TYPE_MULTIPART, SUBMIT_TYPE_URL

    • Constructor Summary

      Constructors 
      Constructor Description
      FormUIGet()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected Collection<org.alfresco.web.config.forms.FormSet> getRecordMetaDataSetConfig​(org.alfresco.web.scripts.forms.FormUIGet.ModelContext context)
      Gets all the record meta-data sets present in the form data.
      protected List<org.alfresco.web.config.forms.FormSet> getRootSetsAsList​(org.alfresco.web.scripts.forms.FormUIGet.ModelContext context)
      Gets the root sets as a list, including the dynamically discovered record meta-data sets.
      protected List<String> getVisibleFieldsInSet​(org.alfresco.web.scripts.forms.FormUIGet.ModelContext context, org.alfresco.web.config.forms.FormSet setConfig)  
      protected void processServerFields​(org.alfresco.web.scripts.forms.FormUIGet.ModelContext context)  
      protected void processVisibleFields​(org.alfresco.web.scripts.forms.FormUIGet.ModelContext context)  

      • Methods inherited from class org.alfresco.web.scripts.forms.FormUIGet

        discoverArguments, discoverBooleanParam, discoverBooleanParam, discoverData, discoverEncodingFormat, discoverFieldDefinition, discoverSetLabel, discoverSetMembership, discoverSubmissionUrl, dumpFormUIModel, dumpMap, executeImpl, generateConstraintModel, generateConstraintModel, generateConstraintModel, generateDefaultSetModelUsingServerFields, generateErrorModel, generateErrorModel, generateFieldModel, generateFormDefPostBody, generateFormModel, generateFormUIModel, generateModel, generateSetModel, generateSetModelUsingServerFields, generateSetModelUsingVisibleFields, generateTransientFieldModel, generateTransientFieldModel, getFormConfig, getParameter, getParameter, getProxyPath, getVisibleFields, isFieldAmbiguous, processCapabilities, processFieldConstraintControl, processFieldConstraintHelp, processFieldConstraints, processFieldContent, processFieldControl, processFieldData, processFieldIdentification, processFields, processFieldState, processFieldText, processTemplates, retrieveFormDefinition, retrieveMessage, setConfigService

      • 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

    • Constructor Detail

      • FormUIGet

        public FormUIGet()

    • Method Detail

      • getVisibleFieldsInSet

        protected List<String> getVisibleFieldsInSet​(org.alfresco.web.scripts.forms.FormUIGet.ModelContext context,
                                             org.alfresco.web.config.forms.FormSet setConfig)
        Overrides:
        getVisibleFieldsInSet in class org.alfresco.web.scripts.forms.FormUIGet
        See Also:
        FormUIGet.getVisibleFieldsInSet(org.alfresco.web.scripts.forms.FormUIGet.ModelContext, org.alfresco.web.config.forms.FormSet)

      • processVisibleFields

        protected void processVisibleFields​(org.alfresco.web.scripts.forms.FormUIGet.ModelContext context)
        Overrides:
        processVisibleFields in class org.alfresco.web.scripts.forms.FormUIGet
        See Also:
        FormUIGet.processVisibleFields(org.alfresco.web.scripts.forms.FormUIGet.ModelContext)

      • processServerFields

        protected void processServerFields​(org.alfresco.web.scripts.forms.FormUIGet.ModelContext context)
        Overrides:
        processServerFields in class org.alfresco.web.scripts.forms.FormUIGet
        See Also:
        FormUIGet.processServerFields(org.alfresco.web.scripts.forms.FormUIGet.ModelContext)

      • getRootSetsAsList

        protected List<org.alfresco.web.config.forms.FormSet> getRootSetsAsList​(org.alfresco.web.scripts.forms.FormUIGet.ModelContext context)
        Gets the root sets as a list, including the dynamically discovered record meta-data sets.
        Parameters:
        context - The model context
        Returns:
        The root sets as list, including the dynamically discovered record meta-data sets.

      • getRecordMetaDataSetConfig

        protected Collection<org.alfresco.web.config.forms.FormSet> getRecordMetaDataSetConfig​(org.alfresco.web.scripts.forms.FormUIGet.ModelContext context)
        Gets all the record meta-data sets present in the form data.
        Parameters:
        context - The model context
        Returns:
        All the record meta-data sets present in the form data.