Object Types

The Administration API enables you to perform a variety of operations on the administrative objects. These objects fall into two basic categories: universal and creatable.

Universal Objects

Oracle SES has one instance of each universal object out of the box. You can change the default settings, but you cannot create a new instance or delete the existing one. In the Administration GUI, you can edit the settings of universal objects on the Global Settings pages.

Table 1-2 describes the universal object types.

Table 1-2 Universal Objects

Object Type Description

clustering

Clustering configuration

crawlerSettings

Crawler configuration

index

Indexing parameters

indexOptimizer

Index optimization

partitionConfig

Partition configuration

queryConfig

Query configuration

resultList

Search result list configuration

spaceCalculator

Space calculator


Creatable Types

Oracle SES may have multiple instances of a creatable type out of the box, or it may have none. You can create new instances and, for most types, modify existing ones. In the Administration GUI, you can create and edit most of these objects on the Home and Search pages.

An object key uniquely identifies a particular instance of a creatable type. The key can be a single value, such as the name of a source, or a composite value, such as the jar file name and class of an identity plug-in. If an object key contains spaces, then all references must be enclosed in quotes in the command-line interface:

--NAME=this_DataSource
--NAME="This Data Source"

Table 1-3 describes the creatable objects.

Table 1-3 Creatable Object Types

Object Type Description

alert

Alert

altWord

Alternate words

clusterTree

Cluster trees

identityPlugin

Identity plug-ins

proxyLogin

Proxy log-ins

schedule

Schedules

searchAttr

Search attributes

skinBundle

Skin bundle

source

Sources

sourceGroup

Source groups

sourceType

Source types

storageArea

Storage areas

suggLink

Suggested links

task

Task

thesaurus

Thesaurus