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

deleteList

Deletes a list of administrative objects of a specified type.

See Also

delete, deleteAll

SOAP Message

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

Element Descriptions 

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

Describes the deletion of one or more objects. It contains these elements:

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

Contains one of these creatable types:

alert
altWord
clusterTree
identityPlugin
proxyLogin
schedule
searchAttr
skinBundle
source
sourceGroup
sourceType
storageArea
suggLink
<objectKeys xmlns="">

Describes the key for an object. One or more <objectKeys> elements compose the list of objects to delete. 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.

<controls xmlns="">

Describes an operation control. It contains these elements:

<controlName>
<controlValue>
<controlName>

IGNORE_NOT_FOUND: Controls the resulting action when an object in the list does not exist.

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

<controlValue>

For IGNORE_NOT_FOUND:

  • true: The object is skipped and processing continues.

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

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 a list of three proxy log-ins:

<deleteList xmlns="http://search.oracle.com/Admin">
  <creatableType xmlns="">proxyLogin</creatableType>
   <objectKeys>
    <adminKeyPairs>
      <keyName>name</keyName>
      <keyValue>this_proxy</keyValue>
    </adminKeyPairs>
   </objectKeys>
  <objectKeys xmlns="">
    <adminKeyPairs>
      <keyName>name</keyName>
      <keyValue>some_proxy</keyValue>
    </adminKeyPairs>
   </objectKeys>
   <objectKeys>
    <adminKeyPairs>
      <keyName>name</keyName>
      <keyValue>that_proxy</keyValue>
    </adminKeyPairs>
  </objectKeys>
   <controls xmlns="">
    <controlName>IGNORE_NOT_FOUND</controlName>
    <controlValue>true</controlValue>
  </controls> 
</deleteList>

The service response indicates that this_proxy and that_proxy were deleted successfully. Processing continued after some_proxy was not found.

<ns2:deleteListResponse xmlns:ns2="http://search.oracle.com/Admin">
  <statusList>
    <objectKey>
      <adminKeyPairs>
        <keyName>name</keyName>
        <keyValue>this_proxy</keyValue>
      </adminKeyPairs>
    </objectKey>
    <objectType>proxyLogin</objectType>
    <statusCode>DELETE_SUCCEEDED</statusCode>
  </statusList>
  <statusList>
    <objectKey>
      <adminKeyPairs>
        <keyName>name</keyName>
        <keyValue>some_proxy</keyValue>
      </adminKeyPairs>
    </objectKey>
    <objectType>proxyLogin</objectType>
    <statusCode>NOT_FOUND_IGNORED</statusCode>
  </statusList>
  <statusList>
    <objectKey>
      <adminKeyPairs>
        <keyName>name</keyName>
        <keyValue>that_proxy</keyValue>
      </adminKeyPairs>
    </objectKey>
    <objectType>proxyLogin</objectType>
    <statusCode>DELETE_SUCCEEDED</statusCode>
  </statusList>
</ns2:deleteListResponse>