Versions Compared

Key

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

...

Expand
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.

getColleagueWithMap

Retorna uma mensagem informando se o usuário foi criado corretamente.

 

Método:

getColleagueWithMap(String colleagueXML, String username, String password)

 

Parâmetros:

  • username: login do usuário.
  • password: senha do usuário.
  • colleagueXML: lista normalizada de documentos.

 

Retorno: String.

getColleagueByLogin 

Retorna o usuário a partir do login.

Método:

getColleagueByLogin(String username, String password)

 

Parâmetros:

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

 

Retorno: ColleagueDto.

Quadro 8: Métodos da ColleagueService.

...