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

deleteAll

Deletes all of the administrative objects of a specified type.

See Also

delete, deleteList

SOAP Message

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

Element Descriptions 

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

Describes deletion of administrative objects. It contains these elements:

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

Contains one of these creatable types:

alert
altWord
clusterTree
identityPlugin
proxyLogin
schedule
searchAttr
skinBundle
source
sourceGroup
sourceType
storageArea
suggLink
<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 case-sensitive 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.

<controls xmlns="">

Describes an operation control. It contains these elements:

<controlName>
<controlValue>
<controlName>

Contains these control:

IGNORE_INVALID_STATE: Controls whether processing continues when an object cannot be deleted because it is in an invalid state. For clusterTree, identityPlugin, and schedule only.

<controlValue>

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

Example

This example deletes all schedules that match the string My%.

<deleteAll xmlns="http://search.oracle.com/Admin">
  <creatableType xmlns="">schedule</creatableType>
  <objectKeyPattern xmlns="">
    <adminKeyPairs>
      <keyName>name</keyName>
      <keyValue>My%</keyValue>
    </adminKeyPairs>
  </objectKeyPattern>
</deleteAll>

This response confirms that the schedule named My Mail was successfully deleted:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
    <ns2:deleteAllResponse xmlns:ns2="http://search.oracle.com/Admin">
      <statusList>
        <objectKey>
          <adminKeyPairs>
            <keyName>name</keyName>
            <keyValue>My Mail</keyValue>
          </adminKeyPairs>
        </objectKey>
        <objectType>schedule</objectType>
        <statusCode>DELETE_SUCCEEDED</statusCode>
      </statusList>
    </ns2:deleteAllResponse>
  </S:Body>
</S:Envelope>