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

Interface ISignOffRestService

  • All Known Implementing Classes:
    SignOffRestService
    public interface ISignOffRestService
    Interface for the RESTful service used for sign-off operations

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      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.

    • Method Detail

      • initiate

        @PUT
@Path("/initiate")
void initiate​(@RequestBody
              Map<String,​String> parameters)
        Initiate mandate from DTO
        Parameters:
        parameters - sign-off process instance, must contains the definitionName and asOfDate entry

      • kpis

        @POST
@Path("/kpis")
@Produces("application/json")
javax.ws.rs.core.Response kpis​(@RequestBody
                               com.activeviam.signoff.core.model.dto.SignOffProcessInstanceExportDTO completion)
        Fetch KPIs for
        Parameters:
        completion - sign-off process instance
        Returns:
        Response

      • approve

        @PUT
@Path("/approve")
void approve​(@RequestBody
             Map<String,​String> parameters)
        Approve mandate from DTO
        Parameters:
        parameters - sign-off process instance, must contains the definitionName and asOfDate entry

      • export

        @POST
@Path("/export")
@Produces("application/json")
javax.ws.rs.core.Response export​(@RequestBody
                                 com.activeviam.signoff.core.model.dto.SignOffProcessInstanceExportDTO instance)
        Export data for mandate
        Parameters:
        instance - sign-off process instance
        Returns:
        A map of export type to DEE task ID.

      • status

        @POST
@Path("/status")
@Produces("application/json")
javax.ws.rs.core.Response status​(@RequestBody
                                 Map<String,​String> tasks)
        Retrieve statuses of export tasks.
        Parameters:
        tasks - The tasks to retrieve statuses for.
        Returns:
        A status DTO object containing statuses for all tasks requested.

      • members

        @PUT
@Path("/members")
@Produces("application/json")
javax.ws.rs.core.Response members​(@RequestBody
                                  String hierarchy)
        Retrieve available members for the first level of a cube hierarchy.
        Parameters:
        hierarchy - The cube hierarchy.
        Returns:
        The available members in a Response object.