|
Oracle Secure Enterprise Search Java API Reference 11g Release 2 (11.2.1.0.0) E17597-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.search.admin.api.ws.client.AdminKeyPair
public class AdminKeyPair
A name and value pair that identifies a property in a creatable object. One or more AdminKeyPair
form an ObjectKey
to uniquely identify a creatable object.
The table below summarizes the valid key names and key values. For more information, see the Oracle Secure Enterprise Search Administration API Guide.
Creatable Type | Object Key Names | Description |
alert | name | The name of the Alert. It corresponds to search:config/search:alerts/search:alert/search:name in the object XML. |
altWord | altKeyword, keyword | The altKeyword is a word or phrase that is suggested when a user enters the keyword. It corresponds to search:config/search:altWords/search:altWord/search:altKeyword in the object XML.The keyword is a search word or phrase. It corresponds to search:config/search:altWords/search:altWord/search:keyword in the object XML. |
clusterTree | name | The name of the Cluster Tree. In the object XML, it corresponds to either search:config/search:clusterTrees/search:metadataClusterTree/search:name for Metadata Cluster Trees or search:config/search:clusterTrees/search:topicClusterTree/search:name for Topic Cluster Trees. |
docServiceInstance | name | The name of the document service instance. It corresponds to search:config/search:docServiceInstances/search:docServiceInstance/search:name in the object XML. |
docServiceManager | jarFilePath, managerClassName | The jarFilePath contains the qualified name of the jar file containg the plug-in classes. It corresponds to search:config/search:identityPlugins/search:identityPlugin/search:jarFilePath in the object XML.The managerClassName contains the manager class name of the plug-in. It corresponds to search:config/search:identityPlugins/search:identityPlugin/search:managerClassName in the object XML. |
docServicePipeline | name | The name of the document service pipeline. It corresponds to search:config/search:docServicePipelines/search:docServicePipeline/search:name in the object XML. |
identityPlugin | jarFilePath, managerClassName | The jarFilePath contains the qualified name of the jar file containg the plug-in classes. It corresponds to search:config/search:identityPlugins/search:identityPlugin/search:jarFilePath in the object XML.The managerClassName contains the manager class name of the plug-in. It corresponds to search:config/search:identityPlugins/search:identityPlugin/search:managerClassName in the object XML. |
indexProfile | name | The name of the index profile. It corresponds to search:config/search:indexProfiles/search:indexProfile/search:name in the object XML. |
lexer | name | The name of the lexer. It corresponds to search:config/search:lexers/search:lexer/search:name in the object XML. |
proxyLogin | name | The name of the Proxy Login. It corresponds to search:config/search:proxyLogins/search:proxyLogin/search:name in the object XML. |
schedule | name | The name of the Schedule. It corresponds to search:config/search:schedules/search:schedule/search:name in the object XML. |
searchAttr | name | The name of the Search Attribute. It corresponds to search:config/search:searchAttrs/search:searchAttr/search:name in the object XML. |
skinBundle | name | The name of the Skin Bundle. It corresponds to search:config/search:skinBundles/search:skinBundle/search:name in the object XML. |
source | name | The name of the Data Source. The XML element it corresponds to is one of search:config/search:sources/search:federatedSource/search:name , search:config/search:sources/search:fileSource/search:name , search:config/search:sources/search:userDefinedSource/search:name , or search:config/search:sources/search:webSource/search:name |
sourceGroup | name | The name of the Source Group. It corresponds to search:config/search:sourceGroups/search:sourceGroup/search:name in the object XML. |
sourceType | name | The name of the Source Type. It corresponds to search:config/search:sourceTypes/search:sourceType/search:name in the object XML. |
storageArea | name | The name of the Storage Area. It corresponds to search:config/search:storageAreas/search:storageArea/search:name in the object XML. |
suggLink | keyword, linkUrl | The keyword is a word or phrase that identifies which queries will contain the suggested link. It corresponds to search:config/search:suggLinks/search:suggLink/search:keyword in the object XML.The linkUrl is a link to the suggested page. It corresponds to search:config/search:suggLinks/search:suggLink/search:linkUrl in the object XML. |
task | name | The name of the Task. It corresponds to search:config/search:tasks/search:task/search:name in the object XML. |
thesaurus | name | The name of the Thesaurus. It must be set to DEFAULT. The name corresponds to the search:config/search:thesauruses/search:thesaurus/search:name in the object XML. |
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>
ObjectKey
Constructor Summary | |
---|---|
AdminKeyPair() |
Method Summary | |
---|---|
String |
getKeyName() Returns the key name. |
String |
getKeyValue() Returns the key value. |
void |
setKeyName(String value) Sets the key name. |
void |
setKeyValue(String value) Sets the key value. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AdminKeyPair()
Method Detail |
---|
public String getKeyName()
public void setKeyName(String value)
value
- The key name.public String getKeyValue()
public void setKeyValue(String value)
value
- The key value.
|
Oracle Secure Enterprise Search Java API Reference 11g Release 2 (11.2.1.0.0) E17597-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |