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

stop

Stops an administrative object.

SOAP Message

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

Element Descriptions 

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

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

<objectType>
<objectKey>
<objectXML>
<credentials>
<locale>
<objectType xmlns="">

Contains this object type:

schedule
<objectKey xmlns="">

Describes the object key for the 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 "Website Schedule".

<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 stops the Oracle Doc Library schedule:

<stop xmlns="http://search.oracle.com/Admin">
   <objectType xmlns="">schedule</objectType>
   <objectKey xmlns=""> 
      <adminKeyPairs>
         <keyName>name</keyName>
         <keyValue>Oracle Doc Library</keyValue>
      </adminKeyPairs>
   </objectKey>
  </credentials>
</stop>

This is the service response for a successful operation:

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