org.alfresco.module.org_alfresco_module_rm.script

Class CustomPropertyDefinitionPost

java.lang.Object

org.springframework.extensions.webscripts.AbstractWebScript

org.springframework.extensions.webscripts.DeclarativeWebScript

org.alfresco.module.org_alfresco_module_rm.script.AbstractRmWebScript

org.alfresco.module.org_alfresco_module_rm.script.BaseCustomPropertyWebScript

org.alfresco.module.org_alfresco_module_rm.script.CustomPropertyDefinitionPost

All Implemented Interfaces:

org.springframework.extensions.webscripts.WebScript

public class CustomPropertyDefinitionPost
extends BaseCustomPropertyWebScript

Implementation for Java backed webscript to add RM custom property definitions to the custom model.

Author:

Neil McErlean

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 and Description
protected RecordsManagementAdminService	rmAdminService

Fields inherited from class org.alfresco.module.org_alfresco_module_rm.script.AbstractRmWebScript

ID, INVERT, PATH_SEPARATOR, STORE_ID, STORE_TYPE, SUCCESS

Constructor Summary

Constructors

Constructor and Description
CustomPropertyDefinitionPost()

Method Summary

Modifier and Type	Method and Description
protected org.alfresco.service.namespace.QName	createNewPropertyDefinition(Map<String,Serializable> params) Create a property definition based on the parameter values provided
protected Map<String,Object>	createPropertyDefinition(org.springframework.extensions.webscripts.WebScriptRequest req, org.json.JSONObject json) Applies custom properties.
protected Map<String,Object>	executeImpl(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.Status status, org.springframework.extensions.webscripts.Cache cache)
protected Map<String,Serializable>	getParamsFromUrlAndJson(org.springframework.extensions.webscripts.WebScriptRequest req, org.json.JSONObject json)
void	setRecordsManagementAdminService(RecordsManagementAdminService rmAdminService)

Methods inherited from class org.alfresco.module.org_alfresco_module_rm.script.BaseCustomPropertyWebScript

mapToTypeQName

Methods inherited from class org.alfresco.module.org_alfresco_module_rm.script.AbstractRmWebScript

getDispositionService, getNamespaceService, getNodeService, parseRequestForNodeRef, setDispositionService, setNamespaceService, setNodeService

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

Field Detail

rmAdminService

protected RecordsManagementAdminService rmAdminService

Constructor Detail

CustomPropertyDefinitionPost

public CustomPropertyDefinitionPost()

Method Detail

setRecordsManagementAdminService

public void setRecordsManagementAdminService(RecordsManagementAdminService rmAdminService)

executeImpl

protected Map<String,Object> executeImpl(org.springframework.extensions.webscripts.WebScriptRequest req,
                                         org.springframework.extensions.webscripts.Status status,
                                         org.springframework.extensions.webscripts.Cache cache)

Overrides:

executeImpl in class org.springframework.extensions.webscripts.DeclarativeWebScript

createPropertyDefinition

protected Map<String,Object> createPropertyDefinition(org.springframework.extensions.webscripts.WebScriptRequest req,
                                                      org.json.JSONObject json)
                                               throws org.json.JSONException,
                                                      CustomMetadataException

Applies custom properties.

Throws:

CustomMetadataException

org.json.JSONException

getParamsFromUrlAndJson

protected Map<String,Serializable> getParamsFromUrlAndJson(org.springframework.extensions.webscripts.WebScriptRequest req,
                                                           org.json.JSONObject json)
                                                    throws org.json.JSONException

Throws:

org.json.JSONException

createNewPropertyDefinition

protected org.alfresco.service.namespace.QName createNewPropertyDefinition(Map<String,Serializable> params)
                                                                    throws CustomMetadataException

Create a property definition based on the parameter values provided

Parameters:

params - parameter values

Returns:

QName qname of the newly created custom property

Throws:

CustomMetadataException