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

getAllObjectKeys

Returns the object keys for a specified object type.

SOAP Message

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

Element Descriptions 

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

Contains these elements:

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

Contains a creatable object type. See Table 1-3, "Creatable Object Types".

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

Example

This example requests all suggested links with a keyword that begins with data:

<getAllObjectKeys xmlns="http://search.oracle.com/Admin">
  <creatableType xmlns="">suggLink</creatableType>
  <objectKeyPattern xmlns="">
    <adminKeyPairs>
      <keyName>keyword</keyName>
      <keyValue>data%</keyValue>
    </adminKeyPairs>
  </objectKeyPattern>
</getAllObjectKeys>

The service response provides the object keys for the suggested link with the keyword database:

<ns2:getAllObjectKeysResponse xmlns:ns2="http://search.oracle.com/Admin">
   <objectKeyList>
      <adminKeyPairs>
         <keyName>keyword</keyName>
         <keyValue>database</keyValue>
      </adminKeyPairs>
      <adminKeyPairs>
         <keyName>linkUrl</keyName>
         <keyValue>
          http://www.oracle.com/technology/products/database/oracle11g
         </keyValue>
      </adminKeyPairs>
   </objectKeyList>
</ns2:getAllObjectKeysResponse>