XML Description of State Properties

Both universal and creatable objects can have state properties. The getState, getStateList, and getAllStates commands return an XML document describing the current state of one or more objects.

The <search:state> element describes the current state of an object.

<search:state>
   <search:objectStates>
      <search:objectState>
         <search:objectState>
         <search:objectType>

<!-- For creatable objects -->
            <search:objectKey>
               <search:keyPairs>
                  <search:keyPair>
                     <search:name>
                     <search:value>

<!-- For all objects -->
         <search:stateProperties>
            <search:stateProperty>
               <search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:propertyValue>

Element Descriptions

<search:state>

Contains a <search:objectStates> element.

Attribute	Value
productVersion	Oracle SES product version
xmlns:search	Namespace for the Oracle SES Administration API

<search:objectStates>

Contains one or more <search:objectState> elements.

<search:objectState>

Describes the state properties of a particular object, using these child elements:

<search:objectType>
<search:objectKey>
<search:stateProperties>

<search:objectType>

Contains an object type with one or more state properties:

clustering
clusterTree
identityPlugin
index
indexOptimizer
resultList
schedule
skinBundle
spaceCalculator
task

<search:objectKey>

Contains the object key that identifies a specific instance of a creatable object type. It contains a <search:keyPairs> element.

<search:keyPairs>

Contains one or more <search:keyPair> elements.

<search:keyPair>

Contains these child elements:

<search:name>
<search:value>

<search:name>

Contains a key name for this object type.

<search:value>

Contains the key value for this object.

<search:stateProperties>

Contains one or more <search:stateProperty> elements.

<search:stateProperty>

Contains a <search:propertyName> element.

<search:propertyName>

Contains the name of a property.

<search:propertyValues>

Contains one or more <search:propertyValue> elements.

<search:propertyValue>

Contains a <search:value> element.

Attribute	Value
key	Provides additional context, such as the name of the data source associated with the property for a schedule that crawls multiple sources.

<search:value>

Contains the current value of the property.