Utilize o método search para localizar entradas nos repositórios de perfil que correspondam ao critério de procura.
Finalidade
A SPI search procura o repositório de perfis para obter as entidades que correspondem à expressão de procura.
Uma lista de propriedades que são retornadas da procura é incluída em SearchControl, no gráfico de dados de entrada. PageControl e/ou SortControl, ou ambos, também podem ser incluídos no gráfico de dados de entrada.
SearchControl no gráfico de dados de entrada inclui a cadeia de expressão de procura. A classe de implementação da API de Repositório precisa analisar a cadeia de expressões de procura baseada em XPath.
Nota: Se um adaptador não oferecer suporte à classificação, SortControl será ignorado no objeto de dados de entrada.
O método retornará um gráfico de dados que inclui todas as entidades que correspondem à expressão de procura, se a função de paginação não for usada. Para a função de paginação, PageResponseControl também precisa ser incluído no gráfico de dados de saída. Se o número de entidades for maior que o tamanho da página, um cookie deverá ser retornado de PageResponseControl para que ele possa ser usado em chamadas subsequentes. Se o tamanho da página for definido como 0 em uma chamada subsequente para a procura de paginação, o chamador não irá querer o restante dos resultados da procura. O adaptador poderá executar uma limpeza de dados, como a limpeza do cache, se necessário.
Nota: O virtual member manager não utiliza a função de paginação de um datastore subjacente.
O uniqueName de uma entidade retornada é o uniqueName do virtual member manager, que nem sempre é o mesmo do data store.
O adaptador transfere o nome exclusivo do armazenamento de dados para o uniqueName do
gerenciador de membro virtual de acordo com as informações de configuração do adaptador.
Parâmetros
- root
- Especifica o objeto de dados raiz que contém os controles relacionados à procura.
Retorna
O objeto de dados raiz que contém as entidades que correspondem à expressão da procura.
Assinatura
DataObject search(DataObject root) lança
WIMException