org.alfresco.module.org_alfresco_module_rm.script

Class DispositionAbstractBase

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.DispositionAbstractBase

All Implemented Interfaces:

org.springframework.extensions.webscripts.WebScript

Direct Known Subclasses:

DispositionActionDefinitionDelete, DispositionActionDefinitionPost, DispositionActionDefinitionPut, DispositionLifecycleGet, DispositionScheduleGet

public class DispositionAbstractBase
extends AbstractRmWebScript

Abstract base class for all disposition related java backed webscripts.

Author:

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 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
DispositionAbstractBase()

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	createActionDefModel(DispositionActionDefinition actionDef, String url) Helper to create a model to represent the given disposition action definition.
protected Map<String,Object>	getDispositionScheduleModel(org.springframework.extensions.webscripts.WebScriptRequest req) Helper method to parse the request and retrieve the disposition schedule model.
protected DispositionActionDefinition	parseRequestForActionDefinition(org.springframework.extensions.webscripts.WebScriptRequest req, DispositionSchedule schedule) Parses the request and providing it's valid returns the DispositionActionDefinition object.
protected DispositionSchedule	parseRequestForSchedule(org.springframework.extensions.webscripts.WebScriptRequest req) Parses the request and providing it's valid returns the DispositionSchedule object.

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, 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 Detail

DispositionAbstractBase

public DispositionAbstractBase()

Method Detail

parseRequestForSchedule

protected DispositionSchedule parseRequestForSchedule(org.springframework.extensions.webscripts.WebScriptRequest req)

Parses the request and providing it's valid returns the DispositionSchedule object.

Parameters:

req - The webscript request

Returns:

The DispositionSchedule object the request is aimed at

parseRequestForActionDefinition

protected DispositionActionDefinition parseRequestForActionDefinition(org.springframework.extensions.webscripts.WebScriptRequest req,
                                                                      DispositionSchedule schedule)

Parses the request and providing it's valid returns the DispositionActionDefinition object.

Parameters:

req - The webscript request

schedule - The disposition schedule

Returns:

The DispositionActionDefinition object the request is aimed at

createActionDefModel

protected Map<String,Object> createActionDefModel(DispositionActionDefinition actionDef,
                                                  String url)

Helper to create a model to represent the given disposition action definition.

Parameters:

actionDef - The DispositionActionDefinition instance to generate model for

url - The URL for the DispositionActionDefinition

Returns:

Map representing the model

getDispositionScheduleModel

protected Map<String,Object> getDispositionScheduleModel(org.springframework.extensions.webscripts.WebScriptRequest req)

Helper method to parse the request and retrieve the disposition schedule model.

Parameters:

req - The webscript request

Returns:

Map representing the model