...
O objetivo deste documento é descrever a utilização de Webservices, mostrar e explicar todos seus métodos, disponibilizar exemplos de classes que utilizam esses Webservices e mostrar exemplos de geração de stubs que são necessários para que os client’s possam se comunicar com o serviço.
Criar
...
StubsadvancedSearchDocumentsWithMetadata
Os stubs são necessários para que os client’s que utilizam os métodos dos Webservices possam se comunicar com o serviço.createSimpleCardIndexWithDatasetPersisteType
...
Cloak |
---|
visible | true |
---|
title | No quadro 21, é mostrado todos os métodos disponíveis na classe SearchDocumentService. |
---|
|
advancedSearchDocuments | Utiliza busca avançada. Método: advancedSearchDocuments(String user, String password, int companyId, String colleagueId, String content, boolean findAllDocumentTypes, boolean findFolders, boolean findDocuments, boolean findCardIndex, boolean findCards, boolean findExternalDocument, int documentParentId, Date startDate, Date finalDate) Parâmetros: - user: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- colleagueId: matrícula do usuário.
- content: conteúdo da busca.
- findAllDocumentTypes: indica se deve buscar todos os tipos de documentos.
- findFolders: indica se deve buscar pastas.
- findDocuments: indica se deve buscar documentos.
- findCardIndex: indica se deve buscar fichários.
- findCards: indica se deve buscar fichas.
- findExternalDocument: indica se deve buscar documentos externos.
- documentParentId: número do documento pai.
- startDate: data inicial.
- finalDate: data final.
Retorno: SearchResultDto[]. | advancedSearchDocumentsWithMetadata | Utiliza busca avançada através das opções de metadados e campos customizados. Método: advancedSearchDocuments(String user, String password, int companyId, String colleagueId, String content, SearchFields[] metadata, SearchFields[] customfields, boolean findAllDocumentTypes, boolean findFolders, boolean findDocuments, boolean findCardIndex, boolean findCards, boolean findExternalDocument, int documentParentId, Date startDate, Date finalDate) Parâmetros: - user: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- colleagueId: matrícula do usuário.
- content: conteúdo da busca.
- metadata: informações para busca a partir de metadados do arquivo, como publicador (usando o fieldName publisher), autor (author), descrição (description), descrição da versão/revisão (versionDescription), comentários (additionalComments), tags (tags), data de criação (createDate) e data da última alteração (lastUpdateDate).
- customfields: informações para busca a partir de metadados de campos customizados, informando o nome código do campo customizado como fieldName e valor a ser utilizado como filtro.
- findAllDocumentTypes: indica se deve buscar todos os tipos de documentos.
- findFolders: indica se deve buscar pastas.
- findDocuments: indica se deve buscar documentos.
- findCardIndex: indica se deve buscar fichários.
- findCards: indica se deve buscar fichas.
- findExternalDocument: indica se deve buscar documentos externos.
- documentParentId: número do documento pai.
- startDate: data inicial.
- finalDate: data final.
Retorno: SearchResultDto[]. | searchDocuments | Utiliza busca simples. Método: searchDocuments(String user, String password, int companyId, String colleagueId, String content) Parâmetros: - user: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- colleagueId: matrícula do usuário.
- content: conteúdo da busca.
Retorno: SearchResultDto[]. | searchFavoritesDocuments | Busca documentos favoritos. Metodo: searchFavoritesDocuments(String user, String Password, int companyId, String colleagueId, String content) Parametros: - user: login do usuário.
- password: senha do usuário.
- companyId: código da empresa.
- colleagueId: matrícula do usuário.
- contente: conteúdo a ser buscado
Retorno: SearchResultDto[] |
Quadro 21: Métodos da SearchDocumentService
|
...