com.edorasware.one.frontendobject

Interface UserDashboardManager

public interface UserDashboardManager

Manager interface for User Dashboard REST services.

Method Summary

Modifier and Type	Method and Description
void	activate(String ambiguousId, String comment) Activates a dashboard item.
String	archive(FrontendObject frontendObject, String comment) Archives the given work object.
void	completeTask(String ambiguousId, String comment) Completes a task.
FrontendObject	createQuery(FrontendObject frontendObject, String comment) Creates a new query work object.
InputStream	generateCasePreviewImage(String ambiguousId) Generates a preview image for the given case.
InputStream	generatePreviewImage(String ambiguousId) Generates a preview image for the given task.
InputStream	generateProcessPreviewImage(String ambiguousId) Generates a preview image for the given process.
FrontendObject	getNextTask(String ambiguousId) Deprecated.
FrontendObject	getNextTaskOfProcess(String ambiguousId) Deprecated.
FrontendObject	saveAndCompleteTask(FrontendObject frontendObject, String comment) Saves changes and completes a task.
void	updateDocumentPlaceholders(String ambiguousId, String comment) Updates the document placeholders in a given document.

Method Detail

activate

void activate(String ambiguousId,
              String comment)

Activates a dashboard item.

Parameters:

ambiguousId - the work object global ID

comment - the change comment

completeTask

void completeTask(String ambiguousId,
                  String comment)

Completes a task.

Parameters:

ambiguousId - the task global ID

comment - the change comment

saveAndCompleteTask

FrontendObject saveAndCompleteTask(FrontendObject frontendObject,
                                   String comment)
                            throws Exception

Saves changes and completes a task.

Parameters:

frontendObject - the frontend object containing the changes to be saved

comment - the change comment

Returns:

the new frontend object

Throws:

Exception - if the task could not be completed

archive

String archive(FrontendObject frontendObject,
               String comment)

Archives the given work object.

Parameters:

frontendObject - the frontend object to be archived

comment - the change comment

Returns:

a success message

createQuery

FrontendObject createQuery(FrontendObject frontendObject,
                           String comment)
                    throws Exception

Creates a new query work object.

Parameters:

frontendObject - the frontend object to be created

comment - the change comment

Returns:

the new frontend object

Throws:

Exception

updateDocumentPlaceholders

void updateDocumentPlaceholders(String ambiguousId,
                                String comment)

Updates the document placeholders in a given document.

Parameters:

ambiguousId - the document ID

comment - the change comment

getNextTaskOfProcess

@Deprecated
FrontendObject getNextTaskOfProcess(String ambiguousId)

Deprecated.

Returns the next task in the given process.

Parameters:

ambiguousId - the process global ID

Returns:

the frontend object for the next task

getNextTask

@Deprecated
FrontendObject getNextTask(String ambiguousId)

Deprecated.

Returns the next task after the given (completed) task.

Parameters:

ambiguousId - the task global ID

Returns:

the frontend object for the next task

generatePreviewImage

InputStream generatePreviewImage(String ambiguousId)

Generates a preview image for the given task.

Parameters:

ambiguousId - the task global ID

Returns:

an input stream for the preview image

generateProcessPreviewImage

InputStream generateProcessPreviewImage(String ambiguousId)

Generates a preview image for the given process.

Parameters:

ambiguousId - the process global ID

Returns:

an input stream for the preview image

generateCasePreviewImage

InputStream generateCasePreviewImage(String ambiguousId)

Generates a preview image for the given case.

Parameters:

ambiguousId - the case global ID

Returns:

an input stream for the preview image