Package org.alfresco.module.org_alfresco_module_rm.script

Class ListOfValuesGet

java.lang.Object

org.springframework.extensions.webscripts.AbstractWebScript

org.springframework.extensions.webscripts.DeclarativeWebScript

org.alfresco.module.org_alfresco_module_rm.script.ListOfValuesGet

All Implemented Interfaces:

org.springframework.extensions.webscripts.WebScript

public class ListOfValuesGet
extends org.springframework.extensions.webscripts.DeclarativeWebScript

Implementation for Java backed webscript to return lists of values for various records management services.

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

Modifier and Type	Field	Description
protected DictionaryService	ddService
protected DispositionService	dispositionService
protected NamespaceService	namespaceService
protected RecordsManagementActionService	rmActionService
protected RecordsManagementAuditService	rmAuditService
protected RecordsManagementEventService	rmEventService

Constructor Summary

Constructors

Constructor	Description
ListOfValuesGet()

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	createAuditEventsModel(String baseUrl)	Creates the model for the list of audit events.
protected Map<String,Object>	createDispositionActionsModel(String baseUrl)	Creates the model for the list of disposition actions.
protected Map<String,Object>	createEventsModel(String baseUrl)	Creates the model for the list of events.
protected Map<String,Object>	createPeriodPropertiesModel(String baseUrl)	Creates the model for the list of period properties.
protected Map<String,Object>	createPeriodTypesModel(String baseUrl)	Creates the model for the list of period types.
protected Map<String,Object>	executeImpl(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.Status status, org.springframework.extensions.webscripts.Cache cache)
void	setDictionaryService(DictionaryService ddService)	Sets the DictionaryService instance
void	setDispositionService(DispositionService dispositionService)	Sets the disposition service
void	setNamespaceService(NamespaceService namespaceService)	Sets the NamespaceService instance
void	setRecordsManagementActionService(RecordsManagementActionService rmActionService)	Sets the RecordsManagementActionService instance
void	setRecordsManagementAuditService(RecordsManagementAuditService rmAuditService)	Sets the RecordsManagementAuditService instance
void	setRecordsManagementEventService(RecordsManagementEventService rmEventService)	Sets the RecordsManagementEventService instance

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 Details

rmActionService

protected RecordsManagementActionService rmActionService

rmAuditService

protected RecordsManagementAuditService rmAuditService

rmEventService

protected RecordsManagementEventService rmEventService

dispositionService

protected DispositionService dispositionService

ddService

protected DictionaryService ddService

namespaceService

protected NamespaceService namespaceService

Constructor Details

ListOfValuesGet

public ListOfValuesGet()

Method Details

setRecordsManagementActionService

public void setRecordsManagementActionService(RecordsManagementActionService rmActionService)

Sets the RecordsManagementActionService instance

Parameters:

rmActionService - The RecordsManagementActionService instance

setRecordsManagementAuditService

public void setRecordsManagementAuditService(RecordsManagementAuditService rmAuditService)

Sets the RecordsManagementAuditService instance

Parameters:

rmAuditService - The RecordsManagementAuditService instance

setRecordsManagementEventService

public void setRecordsManagementEventService(RecordsManagementEventService rmEventService)

Sets the RecordsManagementEventService instance

Parameters:

rmEventService - The RecordsManagementEventService instance

setDispositionService

public void setDispositionService(DispositionService dispositionService)

Sets the disposition service

Parameters:

dispositionService - the disposition service

setDictionaryService

public void setDictionaryService(DictionaryService ddService)

Sets the DictionaryService instance

Parameters:

ddService - The DictionaryService instance

setNamespaceService

public void setNamespaceService(NamespaceService namespaceService)

Sets the NamespaceService instance

Parameters:

namespaceService - The NamespaceService instance

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

createDispositionActionsModel

protected Map<String,Object> createDispositionActionsModel(String baseUrl)

Creates the model for the list of disposition actions.

Parameters:

baseUrl - The base URL of the service

Returns:

model of disposition actions list

createEventsModel

protected Map<String,Object> createEventsModel(String baseUrl)

Creates the model for the list of events.

Parameters:

baseUrl - The base URL of the service

Returns:

model of events list

createPeriodTypesModel

protected Map<String,Object> createPeriodTypesModel(String baseUrl)

Creates the model for the list of period types.

Parameters:

baseUrl - The base URL of the service

Returns:

model of period types list

createPeriodPropertiesModel

protected Map<String,Object> createPeriodPropertiesModel(String baseUrl)

Creates the model for the list of period properties.

Parameters:

baseUrl - The base URL of the service

Returns:

model of period properties list

createAuditEventsModel

protected Map<String,Object> createAuditEventsModel(String baseUrl)

Creates the model for the list of audit events.

Parameters:

baseUrl - The base URL of the service

Returns:

model of audit events list