TOTVS Fluig

Atalhos

Árvore de páginas

Versões comparadas

Versão antiga 2

changes.mady.by.user Usuário desconhecido (jessica.mariana)

Gravado em

comparado com

Nova versão 3

changes.mady.by.user Luiz Henrique Konishi Taira

Gravado em

Chave

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

...

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

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

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

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


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

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

getSummaryColleagues

Retorna todos os usuários ativos.


Método:

getSummaryColleagues(int companyId)


Parâmetros:

  • companyId: código da empresa.


Retorno: ColleagueDto[].

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

Esse método altera um usuário com grupos e papéis, permite adicionar os papéis a um usuário.


Método:

updateColleaguewithDependencies(String username, String password, int companyId, ColleagueDto[] colleagues, [] 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


getRoles

Retorna os papéis associados ao usuário


Método:

getRoles(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: WorkflowRoleDto[].

Quadro 8: Métodos da ColleagueService.


...

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

createDataService

Cria um serviço externo.


Método:

createDataService(int companyId, String user, String password, DataServiceDto[] dataServiceDto)


Parâmetros:

  • companyId: código da empresa.
  • user: login do usuário.
  • password: senha do usuário.
  • dataServiceDto: serviço externo que será criado.


Retorno: String.

deleteDataService 

Remove um serviço externo.


Método:

deleteDataService(int companyId, String user, String password, String dataServiceName)


Parâmetros:

  • companyId: código da empresa.
  • user: login do usuário.
  • password: senha do usuário.
  • dataServiceName: nome do serviço externo que será removido.

Retorno: void.

getAllServices

Retorna todos os serviços externos cadastrados.


Método:

getAllServices(int companyId, String user, String password)


Parâmetros:

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


Retorno: dataServiceDto[].

loadDataService

Retorna um serviço externo.


Método:

loadDataService(int companyId, String user, String password, String dataServiceName)


Parâmetros:

  • companyId: código da empresa.
  • user: login do usuário.
  • password: senha do usuário.
  • dataServiceName: nome do serviço externo.


Retorno: dataServiceDto.

updateDataService

Atualiza um serviço externo.


Método:

updateDataService(int companyId, String user, String password, DataServiceDto[] dataServiceDto)


Parâmetros:

  • companyId: código da empresa.
  • user: login do usuário.
  • password: senha do usuário.
  • dataServiceDto: serviço externo que será atualizado.


Retorno: void.

createDataServiceAuthenticated

Cria um serviço externo com autenticação


Método:

createDataServiceAuthenticated(int companyId, String user, String password, DataServiceDto[] dataServiceDto, OauthDTO oauthDTO)


Parâmetros:

  • companyId: código da empresa.
  • user: login do usuário.
  • password: senha do usuário.
  • dataServiceDto: serviço externo que será criado.
  • oauthDTO:  objeto com as configurações para a autenticação no serviço.


Retorno: String.

updateDataServiceAuthenticated

Atualiza um serviço externo com autenticação


Método:

updateDataServiceAuthenticatedcreateDataService(int companyId, String user, String password, DataServiceDto[] dataServiceDto, OauthDTO oauthDTO)


Parâmetros:

  • companyId: código da empresa.
  • user: login do usuário.
  • password: senha do usuário.
  • dataServiceDto: serviço externo que será atualizado.
  • oauthDTO:  objeto com as configurações para a autenticação no serviço.


Retorno: void.

Quadro 12: Métodos da DataServiceService.


...