com.edorasware.one.frontendobject

Interface UserDashboardManager

public interface UserDashboardManager

Manager interface for User Dashboard REST services.

Method Summary

Methods

Modifier and Type	Method and Description
void	activate(com.edorasware.commons.core.entity.WorkObjectId id, String comment) Activates a dashboard item.
String	archive(FrontendObject frontendObject, String comment) Archives the given work object.
void	completeTask(com.edorasware.commons.core.entity.WorkObjectId taskId, String comment) Completes a task.
FrontendObject	createQuery(FrontendObject frontendObject, String comment) Creates a new query work object.
InputStream	generateCasePreviewImage(com.edorasware.gear.core.caze.CaseId caseId) Generates a preview image for the given case.
InputStream	generatePreviewImage(com.edorasware.commons.core.entity.WorkObjectId taskId) Generates a preview image for the given task.
InputStream	generateProcessPreviewImage(com.edorasware.gear.core.process.ProcessId processId) Generates a preview image for the given process.
FrontendObject	getNextTask(com.edorasware.gear.core.task.TaskId taskId) Deprecated.
FrontendObject	getNextTaskOfProcess(com.edorasware.gear.core.process.ProcessId id) Deprecated.
FrontendObject	saveAndCompleteTask(FrontendObject frontendObject, String comment) Saves changes and completes a task.
void	updateDocumentPlaceholders(com.edorasware.commons.core.entity.WorkObjectId id, String comment) Updates the document placeholders in a given document.

Method Detail

activate

void activate(com.edorasware.commons.core.entity.WorkObjectId id,
            String comment)

Activates a dashboard item.

Parameters:

id - the work object ID

comment - the change comment

completeTask

void completeTask(com.edorasware.commons.core.entity.WorkObjectId taskId,
                String comment)

Completes a task.

Parameters:

taskId - the task 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(com.edorasware.commons.core.entity.WorkObjectId id,
                              String comment)

Updates the document placeholders in a given document.

Parameters:

id - the document ID

comment - the change comment

getNextTaskOfProcess

@Deprecated
FrontendObject getNextTaskOfProcess(com.edorasware.gear.core.process.ProcessId id)

Deprecated.

Returns the next task in the given process.

Parameters:

id - the process ID

Returns:

the frontend object for the next task

getNextTask

@Deprecated
FrontendObject getNextTask(com.edorasware.gear.core.task.TaskId taskId)

Deprecated.

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

Parameters:

taskId - the task ID

Returns:

the frontend object for the next task

generatePreviewImage

InputStream generatePreviewImage(com.edorasware.commons.core.entity.WorkObjectId taskId)

Generates a preview image for the given task.

Parameters:

taskId - the task ID

Returns:

an input stream for the preview image

generateProcessPreviewImage

InputStream generateProcessPreviewImage(com.edorasware.gear.core.process.ProcessId processId)

Generates a preview image for the given process.

Parameters:

processId - the process ID

Returns:

an input stream for the preview image

generateCasePreviewImage

InputStream generateCasePreviewImage(com.edorasware.gear.core.caze.CaseId caseId)

Generates a preview image for the given case.

Parameters:

caseId - the case ID

Returns:

an input stream for the preview image