org.alfresco.repo.web.scripts.dictionary

Class AbstractSubClassesGet

java.lang.Object

org.springframework.extensions.webscripts.AbstractWebScript

org.springframework.extensions.webscripts.DeclarativeWebScript

org.alfresco.repo.web.scripts.dictionary.DictionaryWebServiceBase

org.alfresco.repo.web.scripts.dictionary.AbstractSubClassesGet

All Implemented Interfaces:

org.springframework.extensions.webscripts.WebScript

Direct Known Subclasses:

SubClassesGet, SubClassesGet

public abstract class AbstractSubClassesGet
extends DictionaryWebServiceBase

Webscript to get the Sub-Classdefinitions using classfilter , namespacePrefix and name

Author:

Saravanan Sellathurai, Viachaslau Tsikhanovich

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.repo.web.scripts.dictionary.DictionaryWebServiceBase

dictionaryservice, MODEL_PROP_KEY_MESSAGE_LOOKUP, namespaceService

Constructor Summary

Constructors

Constructor and Description
AbstractSubClassesGet()

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	executeImpl(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.Status status, org.springframework.extensions.webscripts.Cache cache) Override method from DeclarativeWebScript
protected abstract Collection<org.alfresco.service.namespace.QName>	getQNameCollection(org.springframework.extensions.webscripts.WebScriptRequest req, boolean recursive)
protected abstract void	validateClassname(String namespacePrefix, String name) Throws WebScriptException if classname is invalid

Methods inherited from class org.alfresco.repo.web.scripts.dictionary.DictionaryWebServiceBase

createClassQName, createClassQName, getFullNamespaceURI, getFullNamespaceURI, getNamespaceURIfromQname, getPrefix, getPrefixFromModelName, getShortName, getValidInput, isValidAssociationFilter, isValidClassFilter, isValidClassname, isValidClassname, isValidModelName, isValidTypeorAspect, isValidTypeorAspect, reorderedValues, setDictionaryService, setNamespaceService

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

Constructor Detail

AbstractSubClassesGet

public AbstractSubClassesGet()

Method Detail

executeImpl

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

Override method from DeclarativeWebScript

Overrides:

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

getQNameCollection

protected abstract Collection<org.alfresco.service.namespace.QName> getQNameCollection(org.springframework.extensions.webscripts.WebScriptRequest req,
                                                                                       boolean recursive)

Parameters:

req - - webscript request

recursive - - flag to get SubAspects or SubTypes recursively

Returns:

collection of qualified names for subclasses

validateClassname

protected abstract void validateClassname(String namespacePrefix,
                                          String name)

Throws WebScriptException if classname is invalid

Parameters:

namespacePrefix - - namespace prefix of a class

name - - localname of a class