Skip Headers
Oracle® Secure Enterprise Search Administration API Guide
11g Release 1 (11.1.2.0.0)

E14133-02
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

getAllStates

Returns the current state of all objects of a specified type as an XML document.

See Also

getState, getStateList

SOAP Message

<getAllStates xmlns="http://search.oracle.com/Admin">
   <creatableType xmlns="">
   <stateProperties xmlns="">
   <objectKeyPattern xmlns="">
      <adminKeyPairs>
         <keyName>
         <keyValue>
   <credentials xmlns="">
      <password>
      <userName>
   <locale xmlns="">

Element Descriptions 

<getAllStates xmlns="http://search.oracle.com/Admin">

Contains these elements:

<creatableType>
<stateProperties>
<objectKeyPattern>
<credentials>
<locale>
<creatableType xmlns="">

Contains one of these creatable types:

clusterTree
identityPlugin
schedule
skinBundle
<stateProperties xmlns="">

Contains a state property of the object. The response is limited to the properties listed in the <stateProperties> elements. By default, the response contains the current state of all properties. See Table 1-4, "Administrative Objects With State Properties".

<objectKeyPattern xmlns="">

An object key that matches the objects to process. It contains one or more <adminKeyPairs> elements.

<adminKeyPairs>

Contains these elements:

<keyName>
<keyValue>
<keyName>

Contains the case-sensitive key name of the object type, such as name.

<keyValue>

Contains a value that matches the object key of one or more objects. It can include wildcard characters:

  • A percent sign (%) matches zero or more characters. In a multibyte character set, it matches zero or more bytes.

  • An underscore (_) matches exactly one character. In a multibyte character set, it matches one byte.

<credentials xmlns="">

Provides the credentials for the Oracle SES administrator. Credentials are required only when the session is stateless. See "Providing Credentials".

This element contains these child elements:

<password>
<userName>
<password>

Contains the password for <userName>.

<userName>

Contains the user name of the Oracle SES administrator.

<locale xmlns="">

Sets the language for error messages. See Table 2-2, "Product Languages" for a list of valid codes.

If you omit this element or enter an invalid code, then Oracle SES uses the default locale of the system where it is running.

SOAP Faults

AdminAPIRuntimeFault
CreatableAdminObjectFault
DependentObjectFault
InvalidInputFault
InvalidStateFault

Example

This example requests the status and next crawl time for schedules with a name beginning with Ora. Any error messages are returned in Spanish.

<getAllStates xmlns="http://search.oracle.com/Admin">
   <creatableType xmlns="">schedule</creatableType>
   <stateProperties xmlns="">status</stateProperties>
   <stateProperties xmlns="">nextCrawl</stateProperties>
   <objectKeyPattern xmlns="">
      <adminKeyPairs>
         <keyName>name</keyName>
         <keyValue>Ora%</keyValue>
      </adminKeyPairs>
   </objectKeyPattern>
   <locale xmlns="">es</locale>
</getAllStates>

The service response describes a schedule named Oracle Doc Library. Its status is SCHEDULED, and the next crawl is Thu, 15 Oct 2009 08:00:00 GMT.

<ns2:getAllStatesResponse xmlns:ns2="http://search.oracle.com/Admin">
      <objectStateXML>
         <objectXML>

<?xml version="1.0" encoding="UTF-8"?>
<search:state productVersion="11.1.2.0.0" xmlns:search="http://xmlns.oracle.com/search">
   <search:objectStates>
      <search:objectState>
         <search:objectType>schedule</search:objectType>
         <search:objectKey>
            <search:keyPairs>
               <search:keyPair>
                  <search:name>name</search:name>
                  <search:value>Oracle Doc Library</search:value>
               </search:keyPair>
            </search:keyPairs>
         </search:objectKey>
         <search:stateProperties>
            <search:stateProperty>
               <search:propertyName>status</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:value>SCHEDULED</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
            <search:stateProperty>
               <search:propertyName>nextCrawl</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:value>Thu, 15 Oct 2009 08:00:00 GMT</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
         </search:stateProperties>
      </search:objectState>
   </search:objectStates>
</search:state>

      </objectXML>
   </objectStateXML>
</ns2:getAllStatesResponse>