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

updateAll

Updates all objects of a given type that are described in the XML.

See Also

update

SOAP Message

<updateAll xmlns="http://search.oracle.com/Admin">
   <creatableType>
   <objectXML xmlns="">
   <decryptionKey xmlns="">
   <credentials xmlns="">
      <password>
      <userName>
   <controls xmlns="">
      <controlName>
      <controlValue>
   <locale xmlns="">

Element Descriptions 

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

Describes creation of an administrative object. It contains these elements:

<creatableType>
<objectKey>
<objectXML>
<decryptionKey>
<credentials>
<attachments>
<controls>
<locale>
<creatableType>

Contains one of these types:

alert
altWord
clusterTree
proxyLogin
schedule
searchAttr
source
sourceGroup
sourceType
suggLink
<objectXML xmlns="">

Contains an XML document that describes the object. See Chapter 2, "Administration Object Types."

Use escape codes for these symbols in the embedded XML:

Symbol Escape Code
< &lt;
> &gt;
" &quot;

<decryptionKey xmlns="">

Contains a decryption key for proxyLogin and source objects.

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

<controls xmlns="">

Specifies an operation control. It contains these elements:

<controlName>
<controlValue>
<controlName>

UPDATE_METHOD: Controls the method used to update the properties of an object.

NOT_FOUND_METHOD: Controls the action to take when an object does not exist.

IGNORE_INVALID_STATE: Controls whether processing continues when an object cannot be overwritten because it is in an invalid state. For clusterTree, schedule, and storageArea objects. This option is used only when UPDATE_METHOD is OVERWRITE.

<controlValue>

For UPDATE_METHOD:

  • overwrite: Replaces the existing property values with the new values.

  • add: Adds new properties and overwrites existing properties, but does not delete existing properties that are omitted from the XML document. For clusterTree, schedule, searchAttr, source, sourceGroup, sourceType, and storageArea.

  • remove: Removes existing properties. For clusterTree, resultList, schedule, searchAttr, source, sourceGroup, sourceType, and storageArea.

For NOT_FOUND_METHOD:

  • create: Creates a new object from the XML description and continue processing.

  • error: Processing stops with an error. (Default)

  • ignore: Ignore the new description and continue processing.

For IGNORE_INVALID_STATE:

  • true: Continue processing with the next object.

  • false: Stop processing with an error and roll back all changes. (Default)

<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

Notes

After updating a skin bundle, restart the middle tier:

ORACLE_HOME/bin/searchctl restart

Example

This example updates all of the altWord objects described in the <objectXML> element. The content of this element is not shown.

<updateAll xmlns="http://search.oracle.com/Admin">
   <creatableType xmlns="">altWord</creatableType>
   <objectXML xmlns="">
          
     <!-- XML object descriptions appear here-->
          
   </objectXML>
   <controls xmlns="">
      <controlName>UPDATE_METHOD</controlName>
      <controlValue>OVERWRITE</controlValue>
   </controls>
   <controls xmlns="">
      <controlName>NOT_FOUND_METHOD</controlName>
      <controlValue>CREATE</controlValue>
   </controls>
</updateAll>

The service response shows that two alternate keywords were updated and one was created.

<ns2:updateAllResponse xmlns:ns2="http://search.oracle.com/Admin">
   <statusList>
      <objectKey>
         <adminKeyPairs>
            <keyName>keyword</keyName>
            <keyValue>oses</keyValue>
         </adminKeyPairs>
         <adminKeyPairs>
            <keyName>altKeyword</keyName>
            <keyValue>Oracle Secure Enterprise Search</keyValue>
         </adminKeyPairs>
      </objectKey>
      <objectType>altWord</objectType>
      <statusCode>UPDATE_SUCCEEDED</statusCode>
   </statusList>
   <statusList>
      <objectKey>
         <adminKeyPairs>
            <keyName>keyword</keyName>
            <keyValue>rac</keyValue>
         </adminKeyPairs>
         <adminKeyPairs>
            <keyName>altKeyword</keyName>
            <keyValue>Real Application Clusters</keyValue>
         </adminKeyPairs>
      </objectKey>
      <objectType>altWord</objectType>
      <statusCode>NOT_FOUND_CREATED</statusCode>
   </statusList>
   <statusList>
      <objectKey>
         <adminKeyPairs>
            <keyName>keyword</keyName>
            <keyValue>text</keyValue>
         </adminKeyPairs>
         <adminKeyPairs>
            <keyName>altKeyword</keyName>
            <keyValue>Oracle Text</keyValue>
         </adminKeyPairs>
      </objectKey>
      <objectType>altWord</objectType>
      <statusCode>UPDATE_SUCCEEDED</statusCode>
   </statusList>
</ns2:updateAllResponse>