Árvore de páginas

Versões comparadas

Chave

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

...

Nota
titleAtençã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, exceto no caso de possuir o identity configurado, neste caso a senha deverá ser passada normalmente sem a criptografia.

Quando utilizado Utilizado o  hash MD5 no e-mail com contendo os dados do usuário criado, é regra de negócio o campo senha irá vir ser apresentado em branco.

Métodos

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

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.

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


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.

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


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

 

Atributos de Retorno:

  • active 

  • adminUser 

  • maxPrivateSize

  • colleagueName 

  • companyId 

  • defaultLanguage 

  • dialectID 

  • emailHtml 

  • gedUser 

  • login

  • mail

  • colleagueId 

  • menuConfig

  • newsPublisher

  • rowId

  • usedSpace

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

 

Atributos de Retorno:

  • active 

  • adminUser 

  • maxPrivateSize

  • colleagueName 

  • companyId 

  • defaultLanguage 

  • dialectID 

  • emailHtml 

  • gedUser 

  • login

  • mail

  • colleagueId 

  • menuConfig

  • newsPublisher

  • rowId

  • usedSpace

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

 

Atributos de Retorno:

  • active 

  • adminUser 

  • maxPrivateSize

  • colleagueName 

  • companyId 

  • defaultLanguage 

  • dialectID 

  • emailHtml 

  • gedUser 

  • login

  • mail

  • colleagueId 

  • menuConfig

  • newsPublisher

  • rowId

  • usedSpace

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

 

Atributos de Retorno:

  • active 

  • adminUser 

  • maxPrivateSize

  • colleagueName 

  • companyId 

  • defaultLanguage 

  • dialectID 

  • emailHtml 

  • gedUser 

  • login

  • mail

  • colleagueId 

  • menuConfig

  • newsPublisher

  • rowId

  • usedSpace

  • volumeId

 

Estrutura de retorno com sucesso

xml

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.

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

 

Atributos de Retorno:

  • companyId 

  • groupDescription
  • groupId

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

 

Atributos de Retorno:

  • active 

  • adminUser 

  • maxPrivateSize

  • colleagueName 

  • companyId 

  • defaultLanguage 

  • dialectID 

  • emailHtml 

  • gedUser 

  • login

  • mail

  • colleagueId 

  • menuConfig

  • newsPublisher

  • rowId

  • usedSpace

getSummaryColleagues

Retorna todos os usuários ativos.

 

Método:

getSummaryColleagues(int companyId)

 

Parâmetros:

  • companyId: código da empresa.

 

Retorno: ColleagueDto[].

 

Atributos de Retorno:

  • active 

  • colleagueId

  • colleagueName

  • companyId

  • maxPrivateSize

  • rowId

  • usedSpace

removeColleague

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

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


activateColleague

Ativa um usuário.

 

Método:

activateColleague(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.

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


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.

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


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.

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


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.

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


Quadro 8: Métodos da ColleagueService.


...