org.alfresco.module.org_alfresco_module_rm.script.admin

Class RMEventBase

java.lang.Object

org.springframework.extensions.webscripts.AbstractWebScript

org.springframework.extensions.webscripts.DeclarativeWebScript

org.alfresco.module.org_alfresco_module_rm.script.admin.RMEventBase

All Implemented Interfaces:

org.springframework.extensions.webscripts.WebScript

Direct Known Subclasses:

RmEventPut, RmEventsPost

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

Base class for Records management event web scripts

Since:

2.1

Author:

Tuna Aksoy

Nested Class Summary

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

org.springframework.extensions.webscripts.AbstractWebScript.ScriptDetails

Constructor Summary

Constructors

Constructor and Description
RMEventBase()

Method Summary

Modifier and Type	Method and Description
protected void	doCheck(String key, String msg) Helper method for checking the key (e.g.
protected String	getValue(org.json.JSONObject json, String key) Helper method for getting the value for a key from a JSON object

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

RMEventBase

public RMEventBase()

Method Detail

getValue

protected String getValue(org.json.JSONObject json,
                          String key)
                   throws org.json.JSONException

Helper method for getting the value for a key from a JSON object

Parameters:

json - The request content as JSON object

key - The key for which the value should be retrieved (e.g. "eventName")

Returns:

String The value for the provided key if the key exists, null otherwise

Throws:

org.json.JSONException - If there is no string value for the key

doCheck

protected void doCheck(String key,
                       String msg)

Helper method for checking the key (e.g. "eventName")

Parameters:

key - String The key which will be checked

msg - String The error message to throw if the key doesn't have a value