Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

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.

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


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.

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


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[].

 

Atributos de Retorno:

  • colleagueId

  • companyId

  • groupId

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[].

 

Atributos de Retorno:

  • colleagueId

  • companyId

  • groupId

 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[].

 

Atributos de Retorno:

  • colleagueId

  • companyId

  • groupId

 

 

Quadro 6: Métodos da ColleagueGroupService.


...