Class WorkflowInstancesGet
- java.lang.Object
-
- org.springframework.extensions.webscripts.AbstractWebScript
-
- org.springframework.extensions.webscripts.DeclarativeWebScript
-
- org.alfresco.repo.web.scripts.workflow.AbstractWorkflowWebscript
-
- org.alfresco.repo.web.scripts.workflow.WorkflowInstancesGet
-
- All Implemented Interfaces:
org.springframework.extensions.webscripts.WebScript
public class WorkflowInstancesGet extends AbstractWorkflowWebscript
Java backed implementation for REST API to retrieve workflow instances.- Since:
- 3.4
- Author:
- Gavin Cornwell
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.alfresco.repo.web.scripts.workflow.AbstractWorkflowWebscript
AbstractWorkflowWebscript.ExcludeFilter
-
-
Field Summary
Fields Modifier and Type Field Description static String
PARAM_COMPLETED_AFTER
static String
PARAM_COMPLETED_BEFORE
static String
PARAM_DEFINITION_ID
static String
PARAM_DEFINITION_NAME
static String
PARAM_DUE_AFTER
static String
PARAM_DUE_BEFORE
static String
PARAM_INITIATOR
static String
PARAM_PRIORITY
static String
PARAM_STARTED_AFTER
static String
PARAM_STARTED_BEFORE
static String
PARAM_STATE
static QName
QNAME_INITIATOR
static String
VAR_DEFINITION_ID
-
Fields inherited from class org.alfresco.repo.web.scripts.workflow.AbstractWorkflowWebscript
authenticationService, authorityService, DEFAULT_MAX_ITEMS, DEFAULT_SKIP_COUNT, dictionaryService, EMPTY, namespaceService, nodeService, NULL, PARAM_EXCLUDE, PARAM_MAX_ITEMS, PARAM_SKIP_COUNT, personService, workflowService
-
-
Constructor Summary
Constructors Constructor Description WorkflowInstancesGet()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected Map<String,Object>
buildModel(WorkflowModelBuilder modelBuilder, org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.Status status, org.springframework.extensions.webscripts.Cache cache)
This method uses aWorkflowModelBuilder
to build up the model to return.-
Methods inherited from class org.alfresco.repo.web.scripts.workflow.AbstractWorkflowWebscript
applyPagination, createResultModel, executeImpl, getDateParameter, getIntParameter, isDateMatchForFilter, processDateFilter, setAuthenticationService, setAuthorityService, setDictionaryService, setNamespaceService, setNodeService, setPersonService, setWorkflowService
-
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
-
-
-
-
Field Detail
-
PARAM_STATE
public static final String PARAM_STATE
- See Also:
- Constant Field Values
-
PARAM_INITIATOR
public static final String PARAM_INITIATOR
- See Also:
- Constant Field Values
-
PARAM_PRIORITY
public static final String PARAM_PRIORITY
- See Also:
- Constant Field Values
-
PARAM_DUE_BEFORE
public static final String PARAM_DUE_BEFORE
- See Also:
- Constant Field Values
-
PARAM_DUE_AFTER
public static final String PARAM_DUE_AFTER
- See Also:
- Constant Field Values
-
PARAM_STARTED_BEFORE
public static final String PARAM_STARTED_BEFORE
- See Also:
- Constant Field Values
-
PARAM_STARTED_AFTER
public static final String PARAM_STARTED_AFTER
- See Also:
- Constant Field Values
-
PARAM_COMPLETED_BEFORE
public static final String PARAM_COMPLETED_BEFORE
- See Also:
- Constant Field Values
-
PARAM_COMPLETED_AFTER
public static final String PARAM_COMPLETED_AFTER
- See Also:
- Constant Field Values
-
PARAM_DEFINITION_NAME
public static final String PARAM_DEFINITION_NAME
- See Also:
- Constant Field Values
-
PARAM_DEFINITION_ID
public static final String PARAM_DEFINITION_ID
- See Also:
- Constant Field Values
-
VAR_DEFINITION_ID
public static final String VAR_DEFINITION_ID
- See Also:
- Constant Field Values
-
QNAME_INITIATOR
public static final QName QNAME_INITIATOR
-
-
Method Detail
-
buildModel
protected Map<String,Object> buildModel(WorkflowModelBuilder modelBuilder, org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.Status status, org.springframework.extensions.webscripts.Cache cache)
Description copied from class:AbstractWorkflowWebscript
This method uses aWorkflowModelBuilder
to build up the model to return.- Specified by:
buildModel
in classAbstractWorkflowWebscript
- Parameters:
modelBuilder
- AWorkflowModelBuilder
.req
- theWebScriptRequest
status
- theStatus
cache
- theCache
- Returns:
- the data model.
-
-