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

getStateList

Returns the current state of a list of objects of the same type.

See Also

getAllStates, getState

SOAP Message

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

Element Descriptions 

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

Contains these elements:

<creatableType>
<objectKeys>
<stateProperties>
<credentials>
<locale>
<creatableType>

Contains one of these creatable types:

clusterTree
identityPlugin
schedule
skinBundle
<objectKeys>

Describes the key for an object. One or more <objectKeys> elements compose the list of objects. This element 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 the value that uniquely describes the object, such as Website Schedule.

<stateProperties>

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".

<credentials>

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 next crawl time for the Oracle Doc Library and SQL Script Library schedules:

<getStateList xmlns="http://search.oracle.com/Admin">
  <creatableType xmlns="">schedule</creatableType>
  <stateProperties xmlns="">nextCrawl</stateProperties>
  <objectKeys xmlns="">
    <adminKeyPairs>
      <keyName>name</keyName>
      <keyValue>Oracle Doc Library</keyValue>
    </adminKeyPairs>
  </objectKeys>
  <objectKeys xmlns="">
    <adminKeyPairs>
      <keyName>name</keyName>
      <keyValue>SQL Script Library</keyValue>
    </adminKeyPairs>
  </objectKeys>
  <credentials xmlns="">
    <password>password</password>
    <userName>eqsys</userName>
  </credentials>
</getStateList>

The service response provides the next scheduled crawl times:

<ns2:getStateListResponse 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>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:objectState>
         <search:objectType>schedule</search:objectType>
         <search:objectKey>
            <search:keyPairs>
               <search:keyPair>
                  <search:name>name</search:name>
                  <search:value>SQL Script Library</search:value>
               </search:keyPair>
            </search:keyPairs>
         </search:objectKey>
         <search:stateProperties>
            <search:stateProperty>
               <search:propertyName>nextCrawl</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:value>Wed, 07 Oct 2009 06:00:00 GMT</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
         </search:stateProperties>
      </search:objectState>
   </search:objectStates>
</search:state>

      </objectXML>
   </objectStateXML>
</ns2:getStateListResponse>