Package com.activeviam.risk.ref.signoff.service.impl

Class SignOffRestService

java.lang.Object

com.activeviam.risk.ref.signoff.service.impl.SignOffRestService

All Implemented Interfaces:

ISignOffRestService

@Configuration
public class SignOffRestService
extends Object
implements ISignOffRestService

RESTful service used for sign-off operations

Field Summary

Fields

Modifier and Type	Field	Description
static String	AS_OF_DATE
static String	DEFINITION_NAME
static String	ERROR_MESSAGE
static org.slf4j.Logger	LOGGER
protected ISignOffService	signOffService

Constructor Summary

Constructors

Constructor	Description
SignOffRestService(ISignOffService signOffService)

Method Summary

Modifier and Type	Method	Description
void	approve(Map<String,String> parameters)	Approve mandate from DTO
javax.ws.rs.core.Response	export(com.activeviam.signoff.core.model.dto.SignOffProcessInstanceExportDTO instance)	Export data for mandate
void	initiate(Map<String,String> parameters)	Initiate mandate from DTO
javax.ws.rs.core.Response	kpis(com.activeviam.signoff.core.model.dto.SignOffProcessInstanceExportDTO completion)	Fetch KPIs for
javax.ws.rs.core.Response	members(String hierarchy)	Retrieve available members for the first level of a cube hierarchy.
javax.ws.rs.core.Response	status(Map<String,String> tasks)	Retrieve statuses of export tasks.

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

public static final org.slf4j.Logger LOGGER

DEFINITION_NAME

public static final String DEFINITION_NAME

See Also:

Constant Field Values

AS_OF_DATE

public static final String AS_OF_DATE

See Also:

Constant Field Values

ERROR_MESSAGE

public static final String ERROR_MESSAGE

See Also:

Constant Field Values

signOffService

protected ISignOffService signOffService

Constructor Detail

SignOffRestService

public SignOffRestService(ISignOffService signOffService)

Method Detail

initiate

public void initiate(@RequestBody
                     Map<String,String> parameters)

Initiate mandate from DTO

Specified by:

initiate in interface ISignOffRestService

Parameters:

parameters - sign-off process instance, must contains the definitionName and asOfDate entry

kpis

public javax.ws.rs.core.Response kpis(@RequestBody
                                      com.activeviam.signoff.core.model.dto.SignOffProcessInstanceExportDTO completion)

Fetch KPIs for

Specified by:

kpis in interface ISignOffRestService

Parameters:

completion - sign-off process instance

Returns:

Response

approve

public void approve(@RequestBody
                    Map<String,String> parameters)

Approve mandate from DTO

Specified by:

approve in interface ISignOffRestService

Parameters:

parameters - sign-off process instance, must contains the definitionName and asOfDate entry

export

public javax.ws.rs.core.Response export(@RequestBody
                                        com.activeviam.signoff.core.model.dto.SignOffProcessInstanceExportDTO instance)

Export data for mandate

Specified by:

export in interface ISignOffRestService

Parameters:

instance - sign-off process instance

Returns:

A map of export type to DEE task ID.

status

public javax.ws.rs.core.Response status(@RequestBody
                                        Map<String,String> tasks)

Retrieve statuses of export tasks.

Specified by:

status in interface ISignOffRestService

Parameters:

tasks - The tasks to retrieve statuses for.

Returns:

A status DTO object containing statuses for all tasks requested.

members

public javax.ws.rs.core.Response members(@RequestBody
                                         String hierarchy)

Retrieve available members for the first level of a cube hierarchy.

Specified by:

members in interface ISignOffRestService

Parameters:

hierarchy - The cube hierarchy.

Returns:

The available members in a Response object.