Árvore de páginas

Versões comparadas

Chave

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

...

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

createFolder

Cria uma pasta.

 

Método:

createFolder(String user, String password, int companyId, DocumentDto[] docdtos, DocumentSecurityConfigDto[] docsecurity, ApproverDto[] docapprovers )

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • docdtos: pasta que será criada.
  • docsecurity: segurança da pasta.
  • docapprovers: aprovadores da pasta.

 

Retorno: WebServiceMessage[].

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


createFolderWithApprovementLevels

Cria uma pasta com nível de aprovação.

 

Método:

createFolderWithApprovementLevels(String user, String password, int companyId, DocumentDto[] docdtos, DocumentSecurityConfigDto[] docsecurity, ApproverWithLevelDto[] docapprovers, ApprovalLevelDto[] levels)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • docdtos: pasta que será criada.
  • docsecurity: segurança da pasta.
  • docapprovers: aprovadores em níveis.
  • levels: níveis de aprovação da pasta.

 

Retorno: WebServiceMessage[].

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


createSimpleFolder

Cria uma pasta simples.

 

Método:

createSimpleFolder(String user, String password, int companyId, int parentDocumentId, String publisherId, String documentDescription)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • parentDocumentId: número do documento pai.
  • publisherId: matrícula do usuário publicador.
  • documentDescription: descrição da pasta.

 

Retorno: WebServiceMessage[].

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


deleteDocument

Exclui uma pasta e envia para a lixeira.

 

Método:

deleteDocument(String user, String password, int companyId, int documentId, String colleagueId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • documentId: número da pasta.
  • colleagueId: matrícula do usuário.

 

Retorno: WebServiceMessage[].

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


destroyDocument

Exclui uma pasta da lixeira.

 

Método:

destroyDocument(String user, String password, int companyId, int documentId, String colleagueId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • documentId: número da pasta.
  • colleagueId: matrícula do usuário.

 

Retorno: WebServiceMessage[].

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


findRecycledDocuments

Retorna todos os documentos da lixeira de um usuário.

 

Método:

findRecycledDocuments(String user, String password, int companyId, String colleagueId)

 

Parâmetros:

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

 

Retorno: DocumentDto[].

getApprovers

Retorna os aprovadores de uma pasta.

 

Método:

getApprovers(String user, String password, int companyId, int nrDocumentId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • nrDocumentId: número da pasta.

 

Retorno: ApproverWithLevelDto[].

getChildren

Retorna todos os documentos de uma pasta.

 

Método:

getChildren(String user, String password, int companyId, int documentId, String colleagueId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • documentId: número da pasta.
  • colleagueId: matrícula do usuário.

 

Retorno: DocumentDto[].

getFolder

Retorna uma pasta.

 

Método:

getFolder(String user, String password, int companyId, int nrDocumentId, String colleagueId )

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • nrDocumentId: número da pasta.
  • colleagueId: matrícula do usuário origem.

 

Retorno: DocumentDto[].

getPrivateChildren

Retorna todos os documentos de uma pasta particular.

 

Método:

getPrivateChildren(String user, String password, int companyId, int parentDocumentId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • documentId: número da pasta.

 

Retorno: DocumentDto[].

 

getRootFolders

Retorna as pastas root que um usuário tem acesso, exceto a pasta particular.

 

Método:

getRootFolders(String user, String password, int companyId, String colleagueId)

 

Parâmetros:

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

 

Retorno: DocumentDto[].

getSecurity

Retorna a segurança de uma pasta.

 

Método:

getSecurity(String user, String password, int companyId, int nrDocumentId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • nrDocumentId: número da pasta.

 

Retorno: DocumentSecurityConfigDto[].

getSubFolders

Retorna todas as subpastas e arquivos de um pasta.

 

Método:

getSubFolders(String user, String password, int companyId, int documentId, String colleagueId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • documentId: número da pasta.
  • colleagueId: matrícula do usuário.

 

Retorno: DocumentDto[].

getSubFoldersOnDemand

Retorna todas as subpastas e arquivos de um pasta, paginados.

 

Método:

getSubFoldersOnDemand(int companyId, String user, String password, int documentId, boolean privatefolder, String[] documenttypes, int limit , int lastRowId, String colleagueId)

 

Parâmetros:

  • companyId: código da empresa.
  • user: login do usuário.
  • password: senha do usuário.
  • documentId: número da pasta.
  • privatefolder: identifica se é uma pasta particular.
  • documenttypes: tipos de documentos das pastas.
  • limit: número de registros a serem retornados.
  • lastRowId: última linha retornada.
  • colleagueId: matrícula do usuário.

 

Retorno: DocumentDto[].

getSubFoldersPermission

Retorna todas as subspastas em que o usuário tenha a permissão informada.

 

Método:

getSubFoldersPermission(String user, String password, int companyId, int documentId, String colleagueId, int permission)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • documentId: número da pasta particular.
  • colleagueId: matrícula do usuário.
  • permission: permissão sobre a pasta.

 

Retorno: DocumentDto[].

getSubPrivateFolders

Retorna todas as subpastas de uma pasta particular.

 

Método:

getSubPrivateFolders(String colleagueId, String password, int companyId, int documentId)

 

Parâmetros:

  • colleagueId: matrícula do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • documentId: número da pasta particular.

 

Retorno: DocumentDto[].

getUserPermissions

Retorna a permissão de um usuário sobre uma pasta.

 

Método:

getUserPermissions(int companyId, String user, int nrDocumentId, int version)

 

Parâmetros:

  • companyId: código da empresa.
  • user: matrícula do usuário.
  • nrDocumentId: número da pasta.
  • version: versão da pasta.

 

Retorno: Integer.

restoreDocument

Restaura uma pasta da lixeira.

 

Método:

restoreDocument(String user, String password, int companyId, int documentId, String colleagueId)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • documentId: número da pasta.
  • colleagueId: matrícula do usuário.

 

Retorno: WebServiceMessage[].

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


updateFolder

Altera uma pasta.

 

Método:

updateFolder(String user, String password, int companyId, DocumentDto[] docdtos, DocumentSecurityConfigDto[] docsecurity, ApproverDto[] docapprovers)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • docdtos: pasta que será alterada.
  • docsecurity: segurança da pasta.
  • docapprovers: aprovadores da pasta.

 

Retorno: WebServiceMessage[].

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


updateFolderWithApprovementLevels

Altera uma pasta com nível de aprovação.

 

Método:

updateFolderWithApprovementLevels(String user, String password, int companyId, DocumentDto[] docdtos, DocumentSecurityConfigDto[] docsecurity, ApproverWithLevelDto[] docapprovers, ApprovalLevelDto[] levels)

 

Parâmetros:

  • user: login do usuário.
  • password: senha do usuário.
  • companyId: código da empresa.
  • docdtos: pasta que será alterada.
  • docsecurity: segurança da pasta.
  • docapprovers: aprovadores em níveis.
  • levels: níveis de aprovação da pasta.

 

Retorno: WebServiceMessage[].

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


updateSimpleFolder

Altera de forma simples uma pasta.

 

Método:

updateSimpleFolder(String user, String Password, int companyId, DocumentDto[] docdtos)

 

Parâmetros:

  • user: login do usuário
  • password: senha do usuário
  • companyId: código da empresa
  • docdtos: pasta que será alterada.

 

Retorno: WebServiceMessage[].

 

Estrutura de retorno com sucesso


Estrutura de retorno com erro


Quadro 16: Métodos da FolderService


...