Árvore de páginas

Versões comparadas

Chave

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

...

Expandir
titleMétodos

No quadro 21, é mostrado todos os métodos disponíveis na classe CardIndexService.

 

 

createSimpleCardIndex

Criação simples de um formulário.

 

Método:

createSimpleCardIndex (String user, String password, int companyId, int parentDocumentId, String publisherId, String documentDescription, String cardDescription, AttachmentArray attachments, CardEventDtoArray customEvents)

 

Parâmetros:

  • user: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • parentDocumentId: numero do formulário.
  • publisherId: código do autor
  • documentDescription: descrição
  • cardDescription: nome
  • descriptionField: descrição
  • attachments: arquivo anexo
  • customEvents: eventos

 

Retorno: WebServiceMessageArray [].

createSimpleCardIndexWithDataset

Criação simples de um formulário com datasets.

 

Método:

createSimpleCardIndexWithDataset (String user, String password, int companyId, int parentDocumentId, String publisherId, String documentDescription, String cardDescription, String datasetName, AttachmentArray attachments, CardEventDtoArray customEvents)

 

Parâmetros:

  • user: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • parentDocumentId: numero do formulário.
  • publisherId: código do autor
  • documentDescription: descrição
  • cardDescription: nome
  • descriptionField: descrição
  • dataset: nome do dataset
  • attachments: arquivo anexo
  • customEvents: eventos

 

Retorno: WebServiceMessageArray [].

createSimpleCardIndexWithDatasetPersisteType

Criação simples de um formulário com datasets determinando o tipo da persistência (Ficha ou Lista).

 

createSimpleCardIndexWithDatasetPersisteType (String user, String password, int companyId, int parentDocumentId, String publisherId, String documentDescription, String cardDescription, String datasetName, AttachmentArray attachments, CardEventDtoArray customEvents, Integer persistenceType)

 

Parâmetros:

  • user: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • parentDocumentId: numero do formulário.
  • publisherId: código do autor
  • documentDescription: descrição
  • cardDescription: nome
  • descriptionField: descrição
  • dataset: nome do dataset
  • attachments: arquivo anexo
  • customEvents: eventos
  • persistenceType: tipo da persistência que será utilizada.

 

Retorno: WebServiceMessageArray [].

getActiveCardIndex

Retorna o formulário ativo.

 

Método:

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

 

Parâmetros:

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

 

Retorno: DocumentDtoArray [].

getAttachmentsList

Retorna a lista de anexos do formulário.

 

Método:

getAttachmentsList (String user, String password, int companyId, int documentId)

 

Parâmetros:

  • user: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • documentId: numero do formulário.

 

Retorno: StringArray [].

getCardIndexContent

Retorna o conteúdo de um formulário.

 

Método:

getCardIndexContent (String user, String password, int companyId, int documentId, String colleagueId, int version, String nomeArquivo)

 

Parâmetros:

  • user: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • documentId: numero do formulário.
  • colleagueId : matrícula do colaborador para a verificação de permissão nos formulário.
  •  version: número da versão do formulário.
  • nomeArquivo: nome do arquivo anexo

 

Retorno: byte[].

getCardIndexesWithoutApprover

Retorna os fichários sem aprovadores que o colaborador tenha permissão.

 

Método:

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

 

Parâmetros:

  • user: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • colleagueId : matrícula do colaborador para a verificação de permissão nos fichários.

 

Retorno: DocumentDto[].

getCustomizationEvents

Retorna os eventos do formulário.

 

Método:

getCustomizationEvents (String user, String password, int companyId, int documentId)

 

Parâmetros:

  • user: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • documentId: numero do formulário.

 

Retorno: CardEventDtoArray [].

getFormFields

Retorna os campos do formulário.

 

Método:

getFormFields(String user, String password, int companyId, int documentId)

 

Parâmetros:

  • user: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • documentId: numero do formulário.

 

Retorno: String[].

updateSimpleCardIndex

Atualização simples do formulário.

 

Método:

updateSimpleCardIndex (String user, String password, int companyId, int documentId, String publisherId, String cardDescription, String descriptionField, AttachmentArray attachments, CardEventDtoArray customEvents)

 

Parâmetros:

  • user: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • documentId: numero do formulário.
  • publisherId: código do autor
  • cardDescription: nome
  • descriptionField: descrição
  • attachments: arquivo anexo
  • customEvents: eventos

 

Retorno: WebServiceMessageArray [].

updateSimpleCardIndexWithDataset

Atualização simples do formulário com datasets.

 

Método:

updateSimpleCardIndexWithDataset (String user, String password, int companyId, int documentId, String publisherId, String cardDescription, String descriptionField, String datasetName, AttachmentArray attachments, CardEventDtoArray customEvents)

 

Parâmetros:

  • user: login do colaborador;
  • password: senha do colaborador;
  • companyId: código da empresa;
  • documentId: numero do formulário.
  • publisherId: código do autor
  • cardDescription: nome
  • descriptionField: descrição
  • datasetName: nome do dataset
  • attachments: arquivo anexo
  • customEvents: eventos

 

Retorno: WebServiceMessageArray [].

Quadro 21: Métodos da CardIndexService

 

 

Exemplo de utilização

No diretório de documentação do Fluig na pasta Documentos de Customização\Arquivos Adicionais\Exemplos Webservices\ExemplosCardIndexService é disponibilizada a classe CardIndexServiceClient.java, esta exemplifica a utilização de todos os métodos da classe CardIndexService.

...


ECMCardService

Webservices responsável por realizar operações referentes a fichas no ECM. Pode ser utilizado para criar, alterar, excluir e pesquisar fichas, entre outras funcionalidades.

Métodos

...

Expandir
titleMétodos

No quadro 12, é mostrado todos os métodos disponíveis na classe CardService.

 

updateCardData

Altera os campos de uma ficha.

 

Método:

updateCardData(int companyId, String user, String password, int cardId, CardFieldDto[] cardData)

 

Parâmetros:

  • companyId: código da empresa;
  • user: login do colaborador;
  • password: senha do colaborador;
  • cardId: número da ficha;
  • cardData: campos da ficha que serão alterados.

 

Retorno: WebServiceMessage[].

create

Cria uma ficha.

 

Método:

create(int companyId, String user, String password, CardDto[] carddtos)

 

Parâmetros:

  • companyId: código da empresa;
  • user: login do colaborador;
  • password: senha do colaborador;
  • carddtos: ficha que será criada.

 

Retorno: WebServiceMessage[].

deleteCard

Exclui uma ficha e envia para a lixeira.

 

Método:

deleteCard(int companyId, String user, String password, int cardId)

 

Parâmetros:

  • companyId: código da empresa;
  • user: login do colaborador;
  • password: senha do colaborador;
  • cardId: número da ficha.

 

Retorno: WebServiceMessage[].

updateCard

Altera os metadados de uma ficha.

 

Método:

updateCard(int companyId, String user, String password, CardDto[] cardDtos, Attachment[] attachs, DocumentSecurityConfigDto[] docsecurity, ApproverDto[] docapprovers, RelatedDocumentDto[] reldocs)

 

Parâmetros:

  • companyId: código da empresa;
  • user: login do colaborador;
  • password: senha do colaborador;
  • cardDtos: ficha que será alterada;
  • attachs: anexos da ficha;
  • docsecurity: segurança da ficha;
  • docapprovers: aprovadores da ficha;
  • reldocs: documentos relacionados da ficha.

 

Retorno: WebServiceMessage[].

getCardVersion

Retorna a versão de uma ficha.

 

Método:

getCardVersion(int companyId, String user, String password, int nrDocumentId, int version, String colleagueId)

 

Método:

Parâmetros:

  • companyId: código da empresa;
  • user: login do colaborador;
  • password: senha do colaborador;
  • nrDocumentId: número da ficha;
  • version: versão da ficha;
  • colleagueId: matrícula do colaborador.

 

Retorno: CardDto[].

Quadro 12: Métodos da CardService