Datenobjekt "SearchControl"

Mit "SearchControl" werden die Suchkriterien angegeben.

Die Struktur des Datenobjekts "SearchControl" hat folgende Bestandteile:
countLimit
Gibt die maximale Anzahl von Suchergebnissen an, die durch die Suchoperation zurückgegeben werden sollen. Wenn die tatsächliche Anzahl der Suchergebnisse die mit "countLimit" festgelegte Anzahl übersteigt, wird das Merkmal "hasMoreResults" im Steuerelement "SearchResponse" auf "true" gesetzt.
Anmerkung: Das Merkmal "countLimit" kann nicht für "SearchControl" festgelegt werden, wenn "PageControl" ebenfalls verwendet wird. Sie sind sich gegenseitig ausschließend.
expression
Gibt den Suchausdruck im Format XPath an.
properties
Gibt die Merkmale der Entitäten an, die zurückgegeben werden und den Suchkriterien entsprechen sollen. Beispiel: Sie möchten die Attribute "sn" (Familienname) und "givenName" (Vorname) für eine bestimmte Person im Vertrieb abrufen.
returnSubType
Gibt an, ob die Subtypen der im Ausdruck angegebenen Entitäten zurückgegeben werden sollen. Die Standardeinstellung ist "true".
searchBases
Gibt die verwendeten Suchbasen an, um die Suche auf die in der Liste angegebenen Suchbasen zu beschränken.
searchLimit
Gibt die maximale Anzahl von Suchergebnissen an, die durch die Suchoperation zurückgegeben werden sollen. Wenn die Anzahl der Suchergebnisse den jeweils kleineren Wert entweder des Suchlimits ("searchLimit"), das in "SearchControl" angegeben wurde, oder der maximalen Anzahl der Suchergebnisse ("maxSearchResults") übersteigt, die in der Datei "wimconfig.xml" angegeben wurde, wird die Ausnahmebedingung "MaxResultsExceededException" ausgelöst. Wenn "searchLimit" definiert ist, wird "countLimit" ignoriert. Wenn "countLimit" definiert ist, muss "searchLimit" auf 0 gesetzt werden.
timeLimit
Wenn das Profil-Repository "timeLimit" unterstützt, gibt dieser Parameter die maximale Suchdauer in Millisekunden an.

XML-Schemadefinition

Nachfolgend finden Sie die XML-Schemadefinition für das Datenobjekt "SearchControl":
<xsd:complexType name="SearchControl">
    <xsd:complexContent>
	 	 <xsd:extension base="PropertyControl">
	     <xsd:sequence>
		  		  <xsd:element name="searchBases" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/>
	     </xsd:sequence>
	     	     <xsd:attribute name="countLimit" type="xsd:int" />
	     	     <xsd:attribute name="searchLimit" type="xsd:int" />
	     	     <xsd:attribute name="timeLimit" type="xsd:int" default="0"/>
	     	     <xsd:attribute name="expression" type="xsd:string"/>
	     	     <xsd:attribute name="returnSubType" type="xsd:boolean" default="true"/>
	 </xsd:extension>
    </xsd:complexContent>
	</xsd:complexType>

Beispieldatenobjekt

Untenstehend finden Sie ein Beispiel für das Datenobjekt "SearchControl" in der API "search". Es stellt eine Anforderung aller Personen mit dem Nachnamen (sn - surname) "Doe" dar. Außerdem gibt es an, die Merkmale "uid" und "sn" zurückzugeben, falls diese vorhanden sind.
<wim:controls xsi:type="wim:SearchControl" countLimit="1"
            expression="@xsi:type='PersonAccount' and sn='Doe'">
    <wim:properties>uid</wim:properties>
    <wim:properties>sn</wim:properties>
    <wim:searchBases>o=Sales,cn=users,dc=yourco,dc=com</wim:searchBases>
</wim:controls>


Rechtliche Hinweise | Feedback