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

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 static String	ID
protected static String	INVERT
protected static String	PATH_SEPARATOR Constants
protected static String	STORE_ID
protected static String	STORE_TYPE
protected static String	SUCCESS

Constructor Summary

Constructors

Constructor and Description
AbstractRmWebScript()

Method Summary

Modifier and Type	Method and Description
protected DispositionService	getDispositionService() Gets the disposition service instance
protected org.alfresco.service.namespace.NamespaceService	getNamespaceService() Gets the namespace service instance
protected org.alfresco.service.cmr.repository.NodeService	getNodeService() Gets the node service instance
protected org.alfresco.service.cmr.repository.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(org.alfresco.service.namespace.NamespaceService namespaceService) Sets the namespace service instance
void	setNodeService(org.alfresco.service.cmr.repository.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 Detail

PATH_SEPARATOR

protected static final String PATH_SEPARATOR

Constants

See Also:

Constant Field Values

STORE_TYPE

protected static final String STORE_TYPE

See Also:

Constant Field Values

STORE_ID

protected static final String STORE_ID

See Also:

Constant Field Values

ID

protected static final String ID

See Also:

Constant Field Values

SUCCESS

protected static final String SUCCESS

See Also:

Constant Field Values

INVERT

protected static final String INVERT

See Also:

Constant Field Values

Constructor Detail

AbstractRmWebScript

public AbstractRmWebScript()

Method Detail

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 org.alfresco.service.namespace.NamespaceService getNamespaceService()

Gets the namespace service instance

Returns:

The namespace service instance

setNamespaceService

public void setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService)

Sets the namespace service instance

Parameters:

namespaceService - The namespace service instance

getNodeService

protected org.alfresco.service.cmr.repository.NodeService getNodeService()

Gets the node service instance

Returns:

The node service instance

setNodeService

public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)

Sets the node service instance

Parameters:

nodeService - The node service instance

parseRequestForNodeRef

protected org.alfresco.service.cmr.repository.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