Package org.alfresco.rest.requests

Class ProcessDefinitions

java.lang.Object

org.alfresco.rest.requests.ModelRequest<ProcessDefinitions>

org.alfresco.rest.requests.ProcessDefinitions

public class ProcessDefinitions
extends ModelRequest<ProcessDefinitions>

Declares all Rest API under the /process-definitions path

Field Summary

Fields inherited from class org.alfresco.rest.requests.ModelRequest

restWrapper

Constructor Summary

Constructors

Constructor	Description
ProcessDefinitions(RestWrapper restWrapper)
ProcessDefinitions(RestProcessDefinitionModel processDefinition, RestWrapper restWrapper)

Method Summary

Modifier and Type	Method	Description
RestProcessDefinitionModelsCollection	getAllProcessDefinitions()	Retrieve 100 process definitions (this is the default size when maxItems is not specified) from Alfresco using GET call on "/process-definitions"
RestProcessDefinitionModel	getProcessDefinition()	Retrieves a process definition using GET call on "/process-definitions/{processDefinitionId}"
RestHtmlResponse	getProcessDefinitionImage()	Retrieves an image that represents a single process definition using GET call on "/process-definitions/{processDefinitionId}/image"
RestFormModelsCollection	getProcessDefinitionStartFormModel()	Retrieves start form type definitions using GET call on "/process-definitions/{processDefinitionId}/start-form-model"

Methods inherited from class org.alfresco.rest.requests.ModelRequest

includePath, usingParams

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProcessDefinitions

public ProcessDefinitions(RestWrapper restWrapper)

ProcessDefinitions

public ProcessDefinitions(RestProcessDefinitionModel processDefinition,
                          RestWrapper restWrapper)

Method Detail

getAllProcessDefinitions

public RestProcessDefinitionModelsCollection getAllProcessDefinitions()
                                                               throws java.lang.Exception

Retrieve 100 process definitions (this is the default size when maxItems is not specified) from Alfresco using GET call on "/process-definitions"

Returns:

Throws:

JsonToModelConversionException

java.lang.Exception

getProcessDefinition

public RestProcessDefinitionModel getProcessDefinition()
                                                throws java.lang.Exception

Retrieves a process definition using GET call on "/process-definitions/{processDefinitionId}"

Returns:

Throws:

java.lang.Exception

getProcessDefinitionImage

public RestHtmlResponse getProcessDefinitionImage()
                                           throws java.lang.Exception

Retrieves an image that represents a single process definition using GET call on "/process-definitions/{processDefinitionId}/image"

Returns:

Throws:

java.lang.Exception

getProcessDefinitionStartFormModel

public RestFormModelsCollection getProcessDefinitionStartFormModel()
                                                            throws java.lang.Exception

Retrieves start form type definitions using GET call on "/process-definitions/{processDefinitionId}/start-form-model"

Returns:

Throws:

java.lang.Exception