TOTVS Fluig

Atalhos

Árvore de páginas

Versões comparadas

Versão antiga 24

changes.mady.by.user Leticia de Liz Engelke

Gravado em

comparado com

Nova versão 25

changes.mady.by.user Leticia de Liz Engelke

Gravado em

Chave

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

...

Expandir
titleNo quadro 6, é mostrado todos os métodos disponíveis na classe ColleagueGroupSevice.

-

 

getColleagueGroupsByColleagueId

Retorna os grupos que um usuário participa.

 

Método:

getColleagueGroupsByColleagueId(String username, String password, int companyId, String colleagueId)

 

Parâmetros:

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

 

Retorno: ColleagueGroupDto[].

 getColleagueGroupsByGroupId 

Retorna os usuários que participam de um grupo de usuários.

 

Método:

getColleagueGroupsByGroupId(String username, String password, int companyId, String groupId)

 

Parâmetros:

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

 

Retorno: ColleagueGroupDto[].
getAllColleagueGroups

Retorna todos os grupos que possuem usuários relacionados.

 

Método:

getAllColleagueGroups(String username, String password, int companyId)

 

Parâmetros:

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

 

Retorno: ColleagueGroupDto[].
getColleagueGroup

Retorna somente um grupo que determinado usuário participa.

 

Método:

getColleagueGroup(String username, String password, int companyId, String groupId, String colleagueId)

 

Parâmetros:

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

 

Retorno: ColleagueGroupDto[].
createColleagueGroup

Associa um usuário a um grupo.

 

Método:

createColleagueGroup(String username, String password, int companyId, ColleagueGroupDto[] grupo_colaborador)

 

Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa;
  • grupo_colaborador: grupo que estará associado a um usuário.

 

Retorno: String.
updateColleagueGroup

Altera a associação de um usuário a um grupo.

 

Método:

updateColleagueGroup(String username, String password, int companyId, ColleagueGroupDto[] grupo_colaborador)

 

Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • grupo_colaborador: grupo de usuários que será alterado.

 

Retorno: String.
deleteColleagueGroup

Exclui um usuário de um grupo.

 

Método:

deleteColleagueGroup(String username, String password, int companyId, String groupId, String colleagueId)

 

Parâmetros:

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

 

Retorno: String.

Quadro 6: Métodos da ColleagueGroupService.

...

No diretório de documentação do Fluig na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosColleagueGroupService é disponibilizada a classe ColleagueGroupServiceClient.java, esta exemplifica a utilização de todos os métodos da classe ColleagueGroupService.

 

...

ECMColleagueReplacementService

Webservice responsável Webservice responsável por realizar operações referentes a xxxxxxx usuários substitutos no Fluig. Pode ser utilizado para criar, alterar, excluir e pesquisar fichasusuários substitutos, entre outras funcionalidades.

Métodos

Expandir
titleNo quadro 57, é mostrado todos os métodos disponíveis na classe CardServiceColleagueReplacementService.

-

 

getColleagueReplacement

Retorna um substituto

xxxxx

Altera os campos de um formuláriousuário.

 

Método:

getColleagueReplacement(String username, String password, int companyId, String colleagueId, String replacementId)

 

Quadro 6

Parâmetros:

Métodos da xxxxx

Exemplo de utilização

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

 

Retorno: ColleagueReplacementDto.

 getReplacementsOfUser 

Retorna todos os substitutos de um usuário.

 

Método:

getReplacementsOfUser(String username, String password, int companyId, String colleagueId)

 

Parâmetros:

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

 

Retorno: ColleagueReplacementDto[].
getValidReplacedUsers

Retorna todos os usuário substituídos por um substituto válido.

 

Método:

getValidReplacedUsers(String username, String password, int companyId, String replacementId)

 

Parâmetros:

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

 

Retorno: ColleagueReplacementDto[].
getValidReplacement

Retorna um substituto válido de um usuário.

 

Método:

getValidReplacement(String username, String password, int companyId, String colleagueId, String replacementId)

 

Parâmetros:

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

 

Retorno: ColleagueReplacementDto.
getValidReplacementsOfUser

Retorna todos os substitutos válidos de um usuário.

 

Método:

getValidReplacementsOfUser(String username, String password, int companyId, String colleagueId)

 

Parâmetros:

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

 

Retorno: ColleagueReplacementDto[].
createColleagueReplacement

Cria um substituto.

 

Método:

createColleagueReplacement (String username, String password, int companyId, ColleagueReplacementDto crDto)

 

Parâmetros:

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

 

Retorno: String.
updateColleagueReplacement

Altera o cadastro de um substituto.

 

Método:

updateColleagueReplacement (String username, String password, int companyId, ColleagueReplacementDto crDto)

 

Parâmetros:

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

 

Retorno: String.
deleteColleagueReplacement

Exclui o cadastro de um substituto.

 

Método:

deleteColleagueReplacement(String username, String password, int companyId, String colleagueId, String replacementId)

 

Parâmetros:

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

 

Retorno: String.

Quadro 7: Métodos da ColleagueReplacementService

Exemplo de utilização

No diretório de documentação do Fluig na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosColleagueReplacementService é disponibilizada a classe ColleagueReplacementServiceClient.java, esta exemplifica a utilização de todos os métodos da classe ColleagueReplacementService.

ECMColleagueService

Webservice responsável por realizar operações referentes a usuários no Fluig. Pode ser utilizado para criar, alterar, excluir e pesquisar usuários, entre outras funcionalidades.

Atenção: Os métodos createColleague, createColleaguewithDependencies, updateColleague e updateColleaguewithDependencies, em um dos seus parâmetros, recebe uma lista de ColleagueDto, nos objetos destas listas  os valores para os campos de senha (password) devem ser criptografados com o algoritmo de hash MD5.  

Métodos

Expandir
titleNo quadro 8, é mostrado todos os métodos disponíveis na classe ColleagueService.

-

 

getColleagues

Retorna todos os usuários ativos.

 

Método:

getColleagues(String username, String password, int companyId)

 

Parâmetros:

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

 

Retorno: ColleagueDto[].

getColleague

Retorna um usuário.

 

Método:

getColleague(String username, String password, int companyId, String colleagueId)

 

Parâmetros:

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

 

Retorno: ColleagueDto[].

getGroups

Retorna os grupos que o usuário participa.

 

Método:

getGroups(String username, String password, int companyId, String colleagueId)

 

Parâmetros:

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

 

Retorno: GroupDto[].

createColleague

Cria um usuário.

 

Método:

createColleague(String username, String password, int companyId, ColleagueDto[] colleagues)

 

Parâmetros:

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

 

Retorno: String.

createColleaguewithDependencies

Cria um usuário com grupos e papéis.

 

Método:

createColleaguewithDependencies(String username, String password, int companyId, ColleagueDto[] colleagues, GroupDto[] grupos, WorkflowRoleDto[] papeis)

 

Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • colleagues: usuários.
  • grupos: grupos.
  • papeis: papéis.

 

Retorno: String.

updateColleague

Altera um usuário.

 

Método:

updateColleague(String username, String password, int companyId, ColleagueDto[] colleagues)

 

Parâmetros:

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

 

Retorno: String.

updateColleaguewithDependencies

Altera um usuário com grupos e papéis.

 

Método:

updateColleaguewithDependencies(String username, String password, int companyId, ColleagueDto[] colleagues, GroupDto[] grupos, WorkflowRoleDto[] papeis)

 

Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • colleagues: usuários.
  • grupos: grupos.
  • papeis: papéis.

 

Retorno: String.

removeColleague

Exclui um usuário.

 

Método:

removeColleague(String username, String password, int companyId, String colleagueId)

 

Parâmetros:

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

 

Retorno: String.

getSummaryColleagues

Retorna todos os usuários ativos.

 

Método:

getSummaryColleagues(int companyId)

 

Parâmetros:

  • companyId: código da empresa.

 

Retorno: ColleagueDto[].

validateColleagueLogin

Valida o acesso de um usuário no produto.

 

Método:

validateColleagueLogin(int companyId, String colleagueId, String password)

 

Parâmetros:

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

 

Retorno: String.

getColleaguesMail

Retorna um usuário utilizando um e-mail.

 

Método:

getColleaguesMail(String username, String password, int companyId, String mail)

 

Parâmetros:

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

 

Retorno: ColleagueDto[].

getSimpleColleague

Retorna o usuário.

 

Método:

getSimpleColleague(String username, String password)

 

Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.

 

Retorno: ColleagueDto.

Quadro 8: Métodos da ColleagueService.

Exemplo de utilização

No diretório de documentação do Fluig na pasta Documentos de Customização\Arquivos Adicionais\ExemplosColleagueService é disponibilizada a classe ColleagueServiceClient.java, esta exemplifica a utilização de todos os métodos da classe ColleagueService.

ECMXXXXService

Webservice responsável por realizar operações referentes a xxxxxxx no Fluig. Pode ser utilizado para criar, alterar, excluir e pesquisar fichas, entre outras funcionalidades.

Métodos

Expandir
titleNo quadro 5, é mostrado todos os métodos disponíveis na classe CardService.

-

xxxxx

Altera os campos de um formulário.

  

Quadro 6: Métodos da xxxxx

Exemplo de utilização

No diretório No diretório de documentação do Fluig na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosXXXX é disponibilizada a classe xxxxx.java, esta exemplifica a utilização de todos os métodos da classe xxxxxxx.