Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Nota
titleObservação
Foi criado um facilitador para gerar todos os stubs, basta baixar o documento Cliente Web Service.zip. Basta descompactá-lo e executar o arquivo "fluig-ws.sh", informe o nome e porta do servidor. Após executar, será gerado o "fluig-ws-client.jar". Importe o .jar para acesso ao serviço. Aqui você encontra um exemplo prático de utilização em artefatos publicados no fluig.

 


Figura 1: Exemplo de criação de stub

...

Cloak
visibletrue
titleNo quadro 11, é mostrado todos os métodos disponíveis na classe DashBoardService.

findMyDocuments

Retorna os documentos do usuário que precisam ser aprovados.

 

Método:

findMyDocuments(String user, String password, int companyId, String colleagueId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • colleagueId: matrícula do usuário.

 

Retorno: DocumentDto[].

findMyDocumentsOnDemand

Retorna os documentos do usuário que precisam ser aprovados, paginados.

 

Método:

findMyDocumentsOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • colleagueId: matrícula do usuário.
  • limit: número de registros a serem retornados.
  • lastRowId: última linha retornada.

 

Retorno: DocumentDto[].

findDocumentsToApprove

Retorna os documentos que o usuário precisa aprovar.

 

Método:

findDocumentsToApprove(String user, String password, int companyId, String colleagueId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • colleagueId: matrícula do usuário.

 

Retorno: DocumentDto[].

findDocumentsToApproveOnDemand

Retorna os documentos que o usuário precisa aprovar, paginados.

 

Método:

findDocumentsToApproveOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • colleagueId: matrícula do usuário.
  • limit: número de registros a serem retornados.
  • lastRowId: última linha retornada.

 

Retorno: DocumentDto[].

findAgreementDocuments

Retorna os documentos do usuário que estão em consenso.

 

Método:

findAgreementDocuments(String user, String password, int companyId, String colleagueId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • colleagueId: matrícula do usuário.

 

Retorno: DocumentDto[].

findCheckoutDocuments

Retorna os documentos do usuário que estão em checkout.

 

Método:

findCheckoutDocuments(String user, String password, int companyId, String colleagueId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • colleagueId: matrícula do usuário.

 

Retorno: DocumentDto[].

findCancelledTasks

Retorna as tarefas atribuidas ao usuário que foram canceladas.

 

Método:

findCancelledTasks(String user, String password, int companyId, String colleagueId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • colleagueId: matrícula do usuário.

 

Retorno: WorkflowProcessDto[].

findCompletedTasks

Retorna as tarefas atribuidas ao usuário que foram finalizadas.

 

Método:

findCompletedTasks(String user, String password, int companyId, String colleagueId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • colleagueId: matrícula do usuário.

 

Retorno: WorkflowProcessDto[].

findConsensusTasks

Retorna as tarefas atribuidas ao usuário que estão em consenso.

 

Método:

findConsensusTasks(String user, String password, int companyId, String colleagueId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • colleagueId: matrícula do usuário.

 

Retorno: WorkflowProcessDto[].

findTransferredTasks

Retorna as tarefas atribuidas ao usuário que foram transferidas.

 

Método:

findTransferredTasks(String user, String password, int companyId, String colleagueId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • colleagueId: matrícula do usuário.

 

Retorno: WorkflowProcessDto[].

findWorkflowTasks

Retorna as tarefas do usuário que estão abertas.

 

Método:

findWorkflowTasks(String user, String password, int companyId, String colleagueId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • colleagueId: matrícula do usuário.

 

Atenção!ATENÇÃO

O colleagueId pode ser preenchido com Pool:Role:Id ou Pool:Group:Id substituindo o Id pelo código de um papel ou de um grupo, respectivamente, para retornar as solicitações referentes aos mesmosa eles.

 

 

Retorno: WorkflowProcessDto[].

findWorkflowTasksOnDemand

Retorna as tarefas do usuário que estão abertas, paginadas.

 

Método:

findWorkflowTasksOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • colleagueId: matrícula do usuário.
  • limit: número de registros a serem retornados.
  • lastRowId: última linha retornada.

 

Atenção!ATENÇÃO

O colleagueId pode ser preenchido com Pool:Role:Id ou Pool:Group:Id substituindo o Id pelo código de um papel ou de um grupo, respectivamente, para retornar as solicitações referentes aos mesmosa eles.

 

Retorno: WorkflowProcessDto[].

findMyRequests

Retorna as solicitações abertas que foram inicializadas pelo usuário.

 

Método:

findMyRequests(String user, String password, int companyId, String colleagueId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • colleagueId: matrícula do usuário.

 

Retorno: WorkflowProcessDto[].

findMyRequestsOnDemand

Retorna as solicitações abertas que foram inicializadas pelo usuário, paginadas.

 

Método:

findMyRequestsOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • colleagueId: matrícula do usuário.
  • limit: número de registros a serem retornados.
  • lastRowId: última linha retornada.

 

Retorno: WorkflowProcessDto[].

findMyManagerTasks

Retorna as tarefas gerenciadas pelo usuário.

 

Método:

findMyManagerTasks(String user, String password, int companyId, String colleagueId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • colleagueId: matrícula do usuário.

 

Retorno: WorkflowProcessDto[].

findExpiredWorkflowTasks

Retorna as tarefas do usuário que estão em atraso

 

Método: findExpiredWorkflowTasks(String user, String password, int companyId, String colleagueId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • colleagueId: matrícula do usuário.

 

Atenção!ATENÇÃO

O colleagueId pode ser preenchido com Pool:Role:Id ou Pool:Group:Id substituindo o Id pelo código de um papel ou de um grupo, respectivamente, para retornar as solicitações referentes aos mesmosa eles.

 

 

Retorno: WorkflowProcessDto[].

fillStatusTask

Retorna a quantidade de tarefas atrasadas, no prazo e sem prazo de um usuário.

 

Método:

fillStatusTask(String user, String password, int companyId, String colleagueId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • colleagueId: matrícula do usuário.

 

Atenção!ATENÇÃO

O colleagueId pode ser preenchido com Pool:Role:Id ou Pool:Group:Id substituindo o Id pelo código de um papel ou de um grupo, respectivamente, para retornar as solicitações referentes aos mesmosa eles.

 

 

Retorno: int[].

fillChronoTasks

Retorna a quantidade de tarefas com prazo de conclusão que foram atribuidas ao usuário e não foram finalizadas.

 

Método:

fillChronoTasks(String user, String password, int companyId, String colleagueId, int yearIni, int yearFin, int mounthIni, int mounthFin, int dayIni, int dayFin, int kindTask)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • colleagueId: matrícula do usuário.
  • yearIni: ano inicial.
  • yearFin: ano final.
  • mounthIni: mês inicial.
  • mounthFin: mês final.
  • dayIni: dia inicial.
  • dayFin: dia final.
  • kindTask: tipo da tarefa.

 

Atenção!ATENÇÃO

O colleagueId pode ser preenchido com Pool:Role:Id ou Pool:Group:Id substituindo o Id pelo código de um papel ou de um grupo, respectivamente, para retornar as solicitações referentes aos mesmosa eles.

 

 

Retorno: int[].

fillTypeTasks

Retorna os tipos de tarefas que o usuário possui.

 

Método:

fillTypeTasks(String user, String password, int companyId, String colleagueId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • colleagueId: matrícula do usuário.

 

Retorno: TaskVODto[].

fillTypeTasksOfReplacement

Retorna os tipos de tarefas que o usuário substituto possui.

 

Método:

fillTypeTasksOfReplacement(String user, String password, int companyId, String colleagueId, String replacementId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • colleagueId: matrícula do usuário.
  • replacementId: matrícula do usuário substituto.

 

Retorno: TaskVODto[].

getOpenTasksByColleagueGroups

Retorna as tarefas atribuídas a um grupo que o usuário participa.

 

Método:

getOpenTasksByColleagueGroups(String user, String password, int companyId, String colleagueId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • colleagueId: matrícula do usuário.

 

Retorno: WorkflowTaskDto[].

getOpenTasksByColleagueGroupsOnDemand

Retorna as tarefas atribuídas a um grupo que o usuário participa, paginadas.

 

Método:

getOpenTasksByColleagueGroupsOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • colleagueId: matrícula do usuário.
  • limit: número de registros a serem retornados.
  • lastRowId: última linha retornada.

 

Retorno: WorkflowTaskDto[].

getOpenTasksByColleagueRoles

Retorna as tarefas atribuídas a um papel que o usuário participa.

 

Método:

getOpenTasksByColleagueRoles(String user, String password, int companyId, String colleagueId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • colleagueId: matrícula do usuário.

 

Retorno: WorkflowTaskDto[].

getOpenTasksByColleagueRolesOnDemand

Retorna as tarefas atribuidas a um papel workflow que o usuário participa, paginadas.

 

Método:

getOpenTasksByColleagueRolesOnDemand(String user, String password, int companyId, String colleagueId, int limit, int lastRowId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • colleagueId: matrícula do usuário.
  • limit: número de registros a serem retornados.
  • lastRowId: última linha retornada.

 

Retorno: WorkflowTaskDto[].

getSummaryRequests

Retorna os contadores de pendências da Home.

 

Método:

getSummaryRequests(int companyId, String user, String password, String colleagueId)

 

Parâmetros:

  • companyId: código da empresa.
  • user: login do usuário.
  • password: senha do usuário.
  • colleagueId: matrícula do usuário.

 

Atenção!ATENÇÃO

O colleagueId pode ser preenchido com Pool:Role:Id ou Pool:Group:Id substituindo o Id pelo código de um papel ou de um grupo, respectivamente, para retornar as solicitações referentes aos mesmosa eles.

 

 

Retorno: HomeRequestSummaryDto[].

getUrlEcm

Retorna a url do servidor.

 

Método:

getUrlEcm(long companyId)

 

Parâmetros:

  • companyId: código da empresa.

Retorno: String.

Quadro 11: Métodos da DashBoardService


...

Cloak
visibletrue
titleNo quadro 24, é mostrado todos os métodos disponíveis na classe WorkflowRoleService.

createWorkflowRole

Cria um papel no Fluig.

 

Método:

createWorkflowRole(String username, String password, int companyId, workflowRoleDto role)

 

Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • role: papel que será criado.

 

Retorno: String.

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


deleteWorkflowRole

Exclui um papel do Fluig.

 

Método:

deleteWorkflowRole(String username, String password, int companyId, String roleId)

 

Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • roleId: código do papel a ser excluído.

 

Retorno: String.

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


getWorkflowRole

Retorna um papel cadastrado no Fluig.

 

Método:

getWorkflowRole(String username, String password, int companyId, String roleId)

 

Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • roleId: código do papel.

 

Retorno: WorkflowRoleDto.

 

Atributos de Retorno:

  • companyId
  • roleDescription
  • roleId

getWorkflowRoles

Retorna todos os papéis cadastrados no Fluig.

 

Método:

getWorkflowRoles(String username, String password, int companyId)

 

Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.

 

Retorno: WorkflowRoleDto[].

 

Atributos de Retorno:

  • companyId
  • roleDescription
  • roleId

updateWorkflowRole

Atualiza um papel no Fluig.

 

Método:

updateWorkflowRole(String username, String password, int companyId, workflowRoleDto role)

 

Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • role: papel que será criado.

 

Retorno: String.

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


Quadro 25: Métodos da WorkflowRoleService


 


O colleagueId pode ser preenchido com Pool:Role:Id ou Pool:Group:Id substituindo o Id pelo código de um papel ou de um grupo respectivamente para retornar as solicitações referentes aos mesmos.