|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.springframework.extensions.webscripts.AbstractWebScript
org.springframework.extensions.webscripts.DeclarativeWebScript
org.alfresco.repo.web.scripts.workflow.AbstractWorkflowWebscript
public abstract class AbstractWorkflowWebscript
Base class for all workflow REST API implementations.
Nested Class Summary | |
---|---|
class |
AbstractWorkflowWebscript.ExcludeFilter
Helper class to check for excluded items. |
Nested classes/interfaces inherited from class org.springframework.extensions.webscripts.AbstractWebScript |
---|
org.springframework.extensions.webscripts.AbstractWebScript.ScriptDetails |
Field Summary | |
---|---|
protected org.alfresco.service.cmr.security.AuthenticationService |
authenticationService
|
protected org.alfresco.service.cmr.security.AuthorityService |
authorityService
|
static int |
DEFAULT_MAX_ITEMS
|
static int |
DEFAULT_SKIP_COUNT
|
protected org.alfresco.service.cmr.dictionary.DictionaryService |
dictionaryService
|
static java.lang.String |
EMPTY
|
protected org.alfresco.service.namespace.NamespaceService |
namespaceService
|
protected org.alfresco.service.cmr.repository.NodeService |
nodeService
|
static java.lang.String |
NULL
|
static java.lang.String |
PARAM_EXCLUDE
|
static java.lang.String |
PARAM_MAX_ITEMS
|
static java.lang.String |
PARAM_SKIP_COUNT
|
protected org.alfresco.service.cmr.security.PersonService |
personService
|
protected org.alfresco.service.cmr.workflow.WorkflowService |
workflowService
|
Constructor Summary | |
---|---|
AbstractWorkflowWebscript()
|
Method Summary | |
---|---|
protected java.util.List |
applyPagination(java.util.List results,
int maxItems,
int skipCount)
Make the pagination for given list of objects |
protected abstract java.util.Map |
buildModel(WorkflowModelBuilder modelBuilder,
org.springframework.extensions.webscripts.WebScriptRequest req,
org.springframework.extensions.webscripts.Status status,
org.springframework.extensions.webscripts.Cache cache)
This method uses a WorkflowModelBuilder to build up the model to return. |
protected java.util.Map |
createResultModel(org.springframework.extensions.webscripts.WebScriptRequest req,
java.lang.String dataPropertyName,
java.util.List results)
Builds the results model, applying pagination to the results if necessary. |
protected java.util.Map |
executeImpl(org.springframework.extensions.webscripts.WebScriptRequest req,
org.springframework.extensions.webscripts.Status status,
org.springframework.extensions.webscripts.Cache cache)
|
protected java.util.Date |
getDateParameter(org.springframework.extensions.webscripts.WebScriptRequest req,
java.lang.String paramName)
Retrieves the named paramter as a date. |
protected int |
getIntParameter(org.springframework.extensions.webscripts.WebScriptRequest req,
java.lang.String paramName,
int defaultValue)
Retrieves the named parameter as an integer, if the parameter is not present the default value is returned |
protected boolean |
isDateMatchForFilter(java.util.Date date,
java.lang.Object filterValue,
boolean dateBeforeFilter)
Determines whether the given date is a match for the given filter value. |
protected void |
processDateFilter(org.springframework.extensions.webscripts.WebScriptRequest req,
java.lang.String paramName,
java.util.Map filters)
Processes the given date filter parameter from the provided webscript request. |
void |
setAuthenticationService(org.alfresco.service.cmr.security.AuthenticationService authenticationService)
|
void |
setAuthorityService(org.alfresco.service.cmr.security.AuthorityService authorityService)
|
void |
setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)
|
void |
setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService)
|
void |
setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
|
void |
setPersonService(org.alfresco.service.cmr.security.PersonService personService)
|
void |
setWorkflowService(org.alfresco.service.cmr.workflow.WorkflowService workflowService)
|
Methods inherited from class org.springframework.extensions.webscripts.DeclarativeWebScript |
---|
execute, executeFinallyImpl, executeImpl, executeImpl, getTemplateModel, renderFormatTemplate |
Methods inherited from class org.springframework.extensions.webscripts.AbstractWebScript |
---|
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 |
---|
public static final java.lang.String NULL
public static final java.lang.String EMPTY
public static final java.lang.String PARAM_MAX_ITEMS
public static final java.lang.String PARAM_SKIP_COUNT
public static final java.lang.String PARAM_EXCLUDE
public static final int DEFAULT_MAX_ITEMS
public static final int DEFAULT_SKIP_COUNT
protected org.alfresco.service.namespace.NamespaceService namespaceService
protected org.alfresco.service.cmr.repository.NodeService nodeService
protected org.alfresco.service.cmr.security.PersonService personService
protected org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService
protected org.alfresco.service.cmr.security.AuthenticationService authenticationService
protected org.alfresco.service.cmr.security.AuthorityService authorityService
protected org.alfresco.service.cmr.workflow.WorkflowService workflowService
Constructor Detail |
---|
public AbstractWorkflowWebscript()
Method Detail |
---|
protected java.util.Map executeImpl(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.Status status, org.springframework.extensions.webscripts.Cache cache)
executeImpl
in class org.springframework.extensions.webscripts.DeclarativeWebScript
public void setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService)
public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
public void setPersonService(org.alfresco.service.cmr.security.PersonService personService)
public void setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)
public void setAuthenticationService(org.alfresco.service.cmr.security.AuthenticationService authenticationService)
public void setAuthorityService(org.alfresco.service.cmr.security.AuthorityService authorityService)
public void setWorkflowService(org.alfresco.service.cmr.workflow.WorkflowService workflowService)
protected abstract java.util.Map buildModel(WorkflowModelBuilder modelBuilder, org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.Status status, org.springframework.extensions.webscripts.Cache cache)
WorkflowModelBuilder
to build up the model to return.
modelBuilder
- A WorkflowModelBuilder
.req
- the WebScriptRequest
status
- the Status
cache
- the Cache
protected void processDateFilter(org.springframework.extensions.webscripts.WebScriptRequest req, java.lang.String paramName, java.util.Map filters)
req
- The WebScript requestparamName
- The name of the parameter to look forfilters
- Map of filters to add the date toprotected java.util.Date getDateParameter(org.springframework.extensions.webscripts.WebScriptRequest req, java.lang.String paramName)
req
- The WebScript requestparamName
- The name of parameter to look for
protected int getIntParameter(org.springframework.extensions.webscripts.WebScriptRequest req, java.lang.String paramName, int defaultValue)
req
- The WebScript requestparamName
- The name of parameter to look fordefaultValue
- The default value that should be returned if parameter is not present in request or if it is not positive
protected java.util.Map createResultModel(org.springframework.extensions.webscripts.WebScriptRequest req, java.lang.String dataPropertyName, java.util.List results)
req
- The WebScript requestdataPropertyName
- The name of the property to use in the modelresults
- The full set of results
protected java.util.List applyPagination(java.util.List results, int maxItems, int skipCount)
results
- the initial list of objects for paginationmaxItems
- maximum count of elements that should be included in paging resultskipCount
- the count of elements that should be skipped
protected boolean isDateMatchForFilter(java.util.Date date, java.lang.Object filterValue, boolean dateBeforeFilter)
date
- The date to check againstfilterValue
- The value of the filter, either an empty String or a Date objectdateBeforeFilter
- true to test the date is before the filterValue,
false to test the date is after the filterValue
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |