Utilice el método search (buscar) para buscar entradas en los depósitos de
perfil que coinciden con los criterios de búsqueda.
Finalidad
La SPI search (búsqueda) busca en el depósito del perfil
para obtener las entidades que coinciden con la expresión de búsqueda.
En el
SearchControl del gráfico de datos de entrada se incluye una
lista de propiedades que se devuelven de la búsqueda. En el gráfico de datos de entrada
también se puede añadir un PageControl y/o SortControl. El SearchControl del gráfico de datos de
entrada incluye la cadena de expresión de búsqueda. La clase de implementación de la API de
depósito debe analizar la cadena de expresión de búsqueda basada en XPath.
Nota: Si un
adaptador no da soporte a la clasificación, se omite el SortControl del objeto de datos
de entrada.
El método devuelve un gráfico de datos que incluye todas las
entidades que coinciden con la expresión de búsqueda, en caso de que no se utilice la
función de paginación. Para la función de paginación, también se tiene que incluir un
método PageResponseControl en el gráfico de datos de salida. Si el número de entidades es
mayor que el tamaño de página, se ha de devolver una cookie desde PageResponseControl
para que se pueda utilizar en llamadas posteriores. Si el tamaño de página se establece
en 0 en una llamada posterior de búsqueda de paginación, significa que el llamante no
desea el resto de los resultados de la búsqueda. El adaptador puede realizar una limpieza
de datos, como por ejemplo, vaciar la memoria caché, si es necesario.
Nota: Virtual member
manager no utiliza la función de paginación de un almacén de datos subyacente.
El
uniqueName de una entidad devuelta es el uniqueName de virtual member manager, lo cual
no siempre es lo mismo que el nombre exclusivo del almacén de datos. El adaptador
transfiere el nombre exclusivo del almacén de datos al uniqueName de virtual member
manager, de acuerdo con la información de configuración del adaptador.
Parámetros
- root
- Especifica el objeto de datos raíz que contiene los controles relacionados con la
búsqueda.
Retorno
El objeto de datos raíz que contiene las entidades que
coinciden con la expresión de búsqueda.
Firma
DataObject search(DataObject root) emite
WIMException