org.osivia.portal.api.tasks

Interface ITasksService

public interface ITasksService

Tasks service interface.

Author:

Cédric Krommenhoek

Field Summary

Fields

Modifier and Type	Field and Description
static String	HOST_PROPERTY Customized host system property.
static String	MBEAN_NAME MBean name.

Method Summary

Modifier and Type	Method and Description
String	getCommandUrl(PortalControllerContext portalControllerContext, UUID uuid, String actionId, String redirectionUrl) Get update task command URL.
EcmDocument	getTask(PortalControllerContext portalControllerContext, String path) Get current user task.
EcmDocument	getTask(PortalControllerContext portalControllerContext, UUID uuid) Get current user task.
List<EcmDocument>	getTasks(PortalControllerContext portalControllerContext) Get current user tasks.
int	getTasksCount(PortalControllerContext portalControllerContext) Get current user tasks count.
void	resetTasksCount(PortalControllerContext portalControllerContext) Reset tasks count.

Field Detail

MBEAN_NAME

static final String MBEAN_NAME

MBean name.

See Also:

Constant Field Values

HOST_PROPERTY

static final String HOST_PROPERTY

Customized host system property.

See Also:

Constant Field Values

Method Detail

getTasks

List<EcmDocument> getTasks(PortalControllerContext portalControllerContext)
                    throws PortalException

Get current user tasks.

Parameters:

portalControllerContext - portal controller context

Returns:

tasks

Throws:

PortalException

getTask

EcmDocument getTask(PortalControllerContext portalControllerContext,
                    String path)
             throws PortalException

Get current user task.

Parameters:

portalControllerContext - portal controller context

path - task path

Returns:

task

Throws:

PortalException

getTask

EcmDocument getTask(PortalControllerContext portalControllerContext,
                    UUID uuid)
             throws PortalException

Get current user task.

Parameters:

portalControllerContext - portal controller context

uuid - task UUID

Returns:

task

Throws:

PortalException

getTasksCount

int getTasksCount(PortalControllerContext portalControllerContext)
           throws PortalException

Get current user tasks count.

Parameters:

portalControllerContext - portal controller context

Returns:

tasks count

Throws:

PortalException

resetTasksCount

void resetTasksCount(PortalControllerContext portalControllerContext)
              throws PortalException

Reset tasks count.

Parameters:

portalControllerContext - portal controller context

Throws:

PortalException

getCommandUrl

String getCommandUrl(PortalControllerContext portalControllerContext,
                     UUID uuid,
                     String actionId,
                     String redirectionUrl)
              throws PortalException

Get update task command URL.

Parameters:

portalControllerContext - portal controller context

uuid - UUID

actionId - action identifier

redirectionUrl - redirection URL

Returns:

URL

Throws:

PortalException