Skip navigation links

oracle.search.admin.api.ws.client
Class ObjectKey

java.lang.Object
oracle.search.admin.api.ws.client.ObjectKey

public class ObjectKey

extends Object

Uniquely identifies a creatable object. One or more AdminKeyPair forms an ObjectKey, where each AdminKeyPair represents a different property of the object.

For example, a data source is uniquely identified by its name. The following creates an ObjectKey representing a data source named "MyWebSource".

   AdminKeyPair keyPair = new AdminKeyPair();
   keyPair.setKeyName( "name" ); // sources are identified by name
   keyPair.setValue  ( "MyWebSource"  ); // the actual source name
   ObjectKey sourceKey = new ObjectKey();
   sourceKey.getAdminKeyPairs().add( keyPair );
 

See AdminKeyPair for information on the key pairs required to form an ObjectKey for creatable object.

An ObjectKey is typically used to identify a single object to process in an administrative operation, such as create. However, they are also used to express key patterns for some administrative operations, such as deleteAll and exportAll. The key pattern determines the subset of objects to process in the operation. For example, you may only want to delete data sources with names that begin with "Web".

Object key patterns support the percent (%) and underscore (_) operators, where percent (%) matches one or more characters (or one or more bytes in a multi-byte language), and underscore (_) matches a single character (or a single byte in a multi-byte language). For example, to match all sources that begin with "Web":

   AdminKeyPair keyPair = new AdminKeyPair();
   keyPair.setKeyName( "name" );
   keyPair.setValue  ( "Web%"  );
   ObjectKey sourceKey = new ObjectKey();
   sourceKey.getAdminKeyPairs().add( keyPair );
 

To use the percent (%) and underscore (_) wildcard characters as literals in a key value, escape the character with two backslashes, such as "Web\\_source" to match only the object named "Web_source".

The following schema fragment specifies the expected SOAP XML for this class:

 <complexType name="adminKeyPair">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="keyName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="keyValue" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

See Also:

AdminKeyPair, AdminPortType

Constructor Summary

ObjectKey()

Method Summary

List	getAdminKeyPairs() Returns the list of key pairs that form the object key.
List	getProperties() Returns the list of administration properties.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ObjectKey

public ObjectKey()

Method Detail

getAdminKeyPairs

public List getAdminKeyPairs()

Returns the list of key pairs that form the object key. To add a new key pair:

   getAdminKeyPairs().add( newKeyPair );
 

Returns:

A non-null List of AdminKeyPair.

getProperties

public List getProperties()

Returns the list of administration properties. To add a new property:

   getProperties().add( newProperty );
 

NOTE: Not currently used.

Returns:

A non-null List of AdminProperty.

Skip navigation links