---

getState

Returns the current state of an object as an XML document.

See Also

getAllStates, getStateList

SOAP Message

<getState xmlns="http://search.oracle.com/Admin">
   <objectType xmlns="">
   <objectKey xmlns="">
      <adminKeyPairs>
         <keyName>
         <keyValue>
   <stateProperties xmlns="">
   <credentials xmlns="">
      <password>
      <userName>
   <locale xmlns="">

Element Descriptions 

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

Contains these elements:

<objectType>
<objectKey>
<stateProperties>
<credentials>
<locale>

<objectType xmlns="">

Contains one of these object types:

identityPlugin
index
indexOptimizer
partitionConfig
schedule

<objectKey xmlns="">

Describes the object key for a creatable object. 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 Web Site Schedule.

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

<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 current state of the index:

<getState xmlns="http://search.oracle.com/Admin">
   <objectType xmlns="">index</objectType>  
</getState>
   

The service response shows that the index has an estimated fragmentation of 1.5%.

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

<?xml version="1.0" encoding="UTF-8"?>
<search:state productVersion="11.2.1.0.0" xmlns:search="http://xmlns.oracle.com/search">
   <search:objectStates>
      <search:objectState>
         <search:objectType>index</search:objectType>
         <search:stateProperties>
            <search:stateProperty>
               <search:propertyName>estimatedFragmentation</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:value>1.5</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
         </search:stateProperties>
      </search:objectState>
   </search:objectStates>
</search:state>

      </objectXML>
   </objectStateXML>
</ns2:getStateResponse>