Skip navigation links

Oracle Secure Enterprise Search Java API Reference
11g Release 2 (11.2.1.0.0)

E17597-02

A C D E F G I L N O P R S T U W


G

getAccessURL() - Method in interface oracle.search.sdk.query.DocumentInfo
Returns the access URL of the document.
getAdmin() - Method in class oracle.search.admin.api.ws.client.AdminService
Returns the AdminPortType for this service.
getAdminKeyPairs() - Method in class oracle.search.admin.api.ws.client.ObjectKey
Returns the list of key pairs that form the object key.
getAllAttributes(String) - Method in class oracle.search.query.webservice.client.OracleSearchService
Returns all the search attributes available in Oracle SES.
getAllObjectKeys(String, ObjectKey, Credentials, List, String) - Method in interface oracle.search.admin.api.ws.client.AdminPortType
Returns the object keys for all existing objects with a specified type.
getAllStates(String, List, ObjectKey, Credentials, List, String) - Method in interface oracle.search.admin.api.ws.client.AdminPortType
Returns the state of all administrative objects with a specified type.
getAltKeywords() - Method in class oracle.search.query.webservice.client.OracleSearchResult
Returns the alternate keywords for the query.
getAPIVersion(Credentials, List, String) - Method in interface oracle.search.admin.api.ws.client.AdminPortType
Returns the version number of the Administration API.
getAttachments() - Method in class oracle.search.admin.api.ws.client.ObjectOutput
Returns the list of attachments for the objects contained in the object XML.
getAttributeId() - Method in class oracle.search.query.webservice.client.Filter
Returns the ID of the attribute used in the predicate.
getAttributeLOV(Attribute, String) - Method in class oracle.search.query.webservice.client.OracleSearchService
Returns a list of value (LOV) for a given search attribute.
getAttributeName() - Method in class oracle.search.query.webservice.client.ClusterAttribute
Returns the attribute name used for clustering.
getAttributeName() - Method in class oracle.search.query.webservice.client.SortAttribute
Returns the attribute name used for sorting.
getAttributes(String, DataGroup[], String) - Method in class oracle.search.query.webservice.client.OracleSearchService
Returns the list of search attributes that are applied to given source groups.
getAttributeType() - Method in class oracle.search.query.webservice.client.ClusterAttribute
Returns the attribute type of the clustering attribute.
getAttributeType() - Method in class oracle.search.query.webservice.client.Filter
Returns the type of the attribute used in the predicate.
getAttributeValue() - Method in class oracle.search.query.webservice.client.Filter
Returns the value of the attribute used in the predicate.
getAuthor() - Method in class oracle.search.query.webservice.client.ResultElement
Returns the author of the document.
getCachedPage(String, Integer, String) - Method in class oracle.search.query.webservice.client.OracleSearchService
Returns cached HTML version of a document.
getCauseClassName() - Method in class oracle.search.admin.api.ws.client.AdminAPIRuntimeFault
Returns the Java class name of the cause exception.
getCauseClassName() - Method in class oracle.search.admin.api.ws.client.CreatableAdminObjectFault
Returns the Java class name of the cause exception.
getCauseClassName() - Method in class oracle.search.admin.api.ws.client.DependentObjectFault
Returns the Java class name of the cause exception.
getCauseClassName() - Method in class oracle.search.admin.api.ws.client.InvalidInputFault
Returns the Java class name of the cause exception.
getCauseClassName() - Method in class oracle.search.admin.api.ws.client.InvalidStateFault
Returns the Java class name of the cause exception.
getCauseMessage() - Method in class oracle.search.admin.api.ws.client.AdminAPIRuntimeFault
Returns the message of the cause exception.
getCauseMessage() - Method in class oracle.search.admin.api.ws.client.CreatableAdminObjectFault
Returns the message of the cause exception.
getCauseMessage() - Method in class oracle.search.admin.api.ws.client.DependentObjectFault
Returns the message of the cause exception.
getCauseMessage() - Method in class oracle.search.admin.api.ws.client.InvalidInputFault
Returns the message of the cause exception.
getCauseMessage() - Method in class oracle.search.admin.api.ws.client.InvalidStateFault
Returns the message of the cause exception.
getCauseStackTrace() - Method in class oracle.search.admin.api.ws.client.AdminAPIRuntimeFault
Returns a String representation of the stack trace of the cause exception.
getCauseStackTrace() - Method in class oracle.search.admin.api.ws.client.CreatableAdminObjectFault
Returns a String representation of the stack trace of the cause exception.
getCauseStackTrace() - Method in class oracle.search.admin.api.ws.client.DependentObjectFault
Returns a String representation of the stack trace of the cause exception.
getCauseStackTrace() - Method in class oracle.search.admin.api.ws.client.InvalidInputFault
Returns a String representation of the stack trace of the cause exception.
getCauseStackTrace() - Method in class oracle.search.admin.api.ws.client.InvalidStateFault
Returns a String representation of the stack trace of the cause exception.
getChildrenDisplayNames() - Method in class oracle.search.query.webservice.client.FacetNode
 
getChildrenDocCounts() - Method in class oracle.search.query.webservice.client.FacetNode
 
getChildrenNames() - Method in class oracle.search.query.webservice.client.FacetNode
 
getClusterAttributes() - Method in class oracle.search.query.webservice.client.ClusterConfig
Return the attribute list used for clustering
getClusterFormat() - Method in class oracle.search.query.webservice.client.ClusterConfig
Returns the format of the cluster.
getClusterName() - Method in class oracle.search.query.webservice.client.ClusterConfig
Returns the name of the cluster.
getClusterString() - Method in class oracle.search.query.webservice.client.ClusterTree
Returns the cluster tree string.
getClusterTrees() - Method in class oracle.search.query.webservice.client.OracleFacetResultContainer
 
getClusterTrees() - Method in class oracle.search.query.webservice.client.OracleResultContainer
Gets the clustering result.
getClusterType() - Method in class oracle.search.query.webservice.client.ClusterConfig
Returns the type of the cluster.
getConfigProperties() - Method in class oracle.search.query.webservice.client.ClusterConfig
Returns the config properties used for clustering.
getConfigValue(String) - Method in class oracle.search.query.webservice.client.ClusterConfig
Returns the configuration value of the specified parameter.
getContent() - Method in class oracle.search.query.webservice.client.SCElement
Returns the suggested content for this provider.
getContentLength() - Method in class oracle.search.query.webservice.client.ResultElement
Returns the content length of the document.
getContentLength() - Method in interface oracle.search.sdk.query.DocumentInfo
Returns the length of the contents of the document.
getControlName() - Method in class oracle.search.admin.api.ws.client.OperationControl
Returns the control name.
getControlValue() - Method in class oracle.search.admin.api.ws.client.OperationControl
Returns the control value.
getCustomAttributes() - Method in class oracle.search.query.webservice.client.ResultElement
Returns the non-default attributes of the document requested in the search methods.
getDataGroups(String) - Method in class oracle.search.query.webservice.client.OracleSearchService
Returns an array of all the source groups defined in Oracle SES.
getDataHandler() - Method in class oracle.search.admin.api.ws.client.Attachment
Returns the attachment content.
getDefaultValue() - Method in class oracle.search.sdk.common.ParameterInfo
Returns the default value of the parameter
getDescription() - Method in class oracle.search.query.webservice.client.ResultElement
Returns the description of the document.
getDescription() - Method in class oracle.search.sdk.common.ParameterInfo
Returns the description of the parameter
getDisplayName() - Method in class oracle.search.query.webservice.client.Attribute
Returns the display name of the attribute.
getDisplayName() - Method in class oracle.search.query.webservice.client.FacetNode
 
getDisplayURL() - Method in interface oracle.search.sdk.query.DocumentInfo
Returns the display URL of the document.
getDisplayValue() - Method in class oracle.search.query.webservice.client.AttributeLOVElement
Returns the display value of the attribute.
getDocCount() - Method in class oracle.search.query.webservice.client.FacetNode
 
getDocCount() - Method in class oracle.search.query.webservice.client.Node
Returns the number of documents under the node.
getDocID() - Method in class oracle.search.query.webservice.client.ResultElement
Returns the ID of the document.
getDocsReturned() - Method in class oracle.search.query.webservice.client.OracleSearchResult
Returns the number of search hits returned.
getDupMarked() - Method in class oracle.search.query.webservice.client.OracleSearchResult
Returns the Boolean value indicating if the duplicate documents are marked in the hit list.
getDupRemoved() - Method in class oracle.search.query.webservice.client.OracleSearchResult
Returns the Boolean value indicating if the duplicate documents are removed from the hit list.
getErrorCode() - Method in class oracle.search.admin.api.ws.client.AdminAPIRuntimeFault
Returns the error code.
getErrorCode() - Method in class oracle.search.admin.api.ws.client.CreatableAdminObjectFault
Returns the error code.
getErrorCode() - Method in class oracle.search.admin.api.ws.client.DependentObjectFault
Returns the error code.
getErrorCode() - Method in class oracle.search.admin.api.ws.client.InvalidInputFault
Returns the error code.
getErrorCode() - Method in class oracle.search.admin.api.ws.client.InvalidStateFault
Returns the error code.
getEstimatedHitCount() - Method in class oracle.search.query.webservice.client.OracleSearchResult
Returns the estimated hit count for the query.
getFacetNodes() - Method in class oracle.search.query.webservice.client.OracleFacetResultContainer
 
getFacetNodes(String[], Boolean, Integer, Integer, String, String, String) - Method in class oracle.search.query.webservice.client.OracleSearchService
Get facet nodes.
getFaultInfo() - Method in exception oracle.search.admin.api.ws.client.AdminAPIRuntimeFault_Exception
Returns the associated Fault.
getFaultInfo() - Method in exception oracle.search.admin.api.ws.client.CreatableAdminObjectFault_Exception
Returns the associated Fault.
getFaultInfo() - Method in exception oracle.search.admin.api.ws.client.DependentObjectFault_Exception
Returns the associated Fault.
getFaultInfo() - Method in exception oracle.search.admin.api.ws.client.InvalidInputFault_Exception
Returns the associated Fault.
getFaultInfo() - Method in exception oracle.search.admin.api.ws.client.InvalidStateFault_Exception
Returns the associated Fault.
getFedId() - Method in class oracle.search.query.webservice.client.Node
Returns the ID of the federated instance.
getFedID() - Method in class oracle.search.query.webservice.client.ResultElement
Returns the ID of the federated instance to which the document belongs.
getFullpath() - Method in class oracle.search.query.webservice.client.Node
Returns an array of names of the nodes in the full path of the infosource node.
getFullPath() - Method in interface oracle.search.sdk.query.FolderInfo
Gets the full path for this folder, including the source group as the root element.
getFullpathIds() - Method in class oracle.search.query.webservice.client.Node
Returns an array of infosource node IDs in the full path to the node.
getGroupDisplayName() - Method in class oracle.search.query.webservice.client.DataGroup
Returns the display name of the data group.
getGroupID() - Method in class oracle.search.query.webservice.client.DataGroup
Returns the ID of the data group.
getGroupingAttribute() - Method in class oracle.search.query.webservice.client.GroupAttribute
Returns the attribute used for grouping.
getGroupingOption() - Method in class oracle.search.query.webservice.client.GroupAttribute
Returns the grouping option.
getGroupingResults() - Method in class oracle.search.query.webservice.client.OracleFacetResultContainer
 
getGroupingResults() - Method in class oracle.search.query.webservice.client.OracleResultContainer
Gets the grouping result.
getGroupMembers() - Method in class oracle.search.query.webservice.client.GroupingResult
Return the members of this group.
getGroupName() - Method in class oracle.search.query.webservice.client.DataGroup
Returns the name of the data group.
getGroupName() - Method in class oracle.search.query.webservice.client.GroupingResult
Returns the name of this group.
getGroups() - Method in class oracle.search.query.webservice.client.ResultElement
Returns the data groups to which the document belongs.
getHasChildren() - Method in class oracle.search.query.webservice.client.FacetNode
 
getHasChildren() - Method in class oracle.search.query.webservice.client.Node
Returns a Boolean value indicating if the node has children.
getHasDuplicate() - Method in class oracle.search.query.webservice.client.ResultElement
Returns a Boolean value indicating if the document has one or more duplicate documents in the hit-list.
getHierarchyDelimiter() - Method in class oracle.search.query.webservice.client.ClusterAttribute
Returns the hierarchy delimiter.
getHitCounts(String[], DataGroup[], String, String, String, Filter[], Boolean, String) - Method in class oracle.search.query.webservice.client.OracleSearchService
Return hit counts for a batch of SES queries.
getHttpRequest() - Method in interface oracle.search.sdk.query.RequestInfo
Gets the HTTP servlet request handle.
getId() - Method in class oracle.search.query.webservice.client.Attribute
Returns the ID of the attribute.
getId() - Method in class oracle.search.query.webservice.client.Node
Returns the ID of the infosource node.
getInfoSourceAncestorNodes(String, String) - Method in class oracle.search.query.webservice.client.OracleSearchService
Returns an array of all the infosource nodes (ancestor nodes) in the full path from the root node to a given infosource node.
getInfoSourceID() - Method in class oracle.search.query.webservice.client.ResultElement
Returns the infosource ID of the document.
getInfoSourceNode(String, String, String) - Method in class oracle.search.query.webservice.client.OracleSearchService
Returns an infosource node for a given node ID.
getInfoSourceNodes(String, String, String) - Method in class oracle.search.query.webservice.client.OracleSearchService
Returns all the children nodes of an infosource node.
getInfoSourcePath() - Method in class oracle.search.query.webservice.client.ResultElement
Returns the infosource path of the document.
getInLinks(Integer, Integer, String) - Method in class oracle.search.query.webservice.client.OracleSearchService
Returns an array of incoming links for a given document.
getIsAscending() - Method in class oracle.search.query.webservice.client.SortAttribute
Returns the sorting order.
getIsDuplicate() - Method in class oracle.search.query.webservice.client.ResultElement
Returns a Boolean value indicating if the document is a duplicate document of another document in the hit-list.
getIsHierarchy() - Method in class oracle.search.query.webservice.client.ClusterAttribute
Is the attribute value a list of hierarchy?
getIsTokenized() - Method in class oracle.search.query.webservice.client.ClusterAttribute
Should the attribute value be tokenized?
getKeyName() - Method in class oracle.search.admin.api.ws.client.AdminKeyPair
Returns the key name.
getKeyValue() - Method in class oracle.search.admin.api.ws.client.AdminKeyPair
Returns the key value.
getLanguage() - Method in class oracle.search.query.webservice.client.ResultElement
Returns the language of the document.
getLanguageDisplayName() - Method in class oracle.search.query.webservice.client.Language
Returns the display name of the language.
getLanguageName() - Method in class oracle.search.query.webservice.client.Language
Returns the name of the language.
getLanguages(String) - Method in class oracle.search.query.webservice.client.OracleSearchService
Returns all the languages supported by Oracle SES.
getLastModified() - Method in class oracle.search.query.webservice.client.ResultElement
Returns the last modified date of the document.
getLastModifiedDate() - Method in interface oracle.search.sdk.query.DocumentInfo
Returns the date of last modification of the document.
getLogLevel() - Method in interface oracle.search.sdk.common.Logger
Returns the current logging level.
getMessage() - Method in class oracle.search.admin.api.ws.client.AdminAPIRuntimeFault
Returns the error message.
getMessage() - Method in class oracle.search.admin.api.ws.client.CreatableAdminObjectFault
Returns the error message.
getMessage() - Method in class oracle.search.admin.api.ws.client.DependentObjectFault
Returns the error message.
getMessage() - Method in class oracle.search.admin.api.ws.client.InvalidInputFault
Returns the error message.
getMessage() - Method in class oracle.search.admin.api.ws.client.InvalidStateFault
Returns the error message.
getMessage() - Method in class oracle.search.query.webservice.client.Status
Returns the status message for the request.
getMimetype() - Method in class oracle.search.query.webservice.client.ResultElement
Returns the MIME type of the document.
getName() - Method in class oracle.search.query.webservice.client.Attribute
Returns the name of the attribute.
getName() - Method in class oracle.search.query.webservice.client.CustomAttribute
Returns the name of the the custom attribute.
getName() - Method in class oracle.search.query.webservice.client.FacetNode
 
getName() - Method in class oracle.search.query.webservice.client.Node
Returns number of documents under the infosource node.
getName() - Method in class oracle.search.query.webservice.client.Property
Gets the name of the property.
getName() - Method in class oracle.search.query.webservice.client.SCElement
Returns the provider name for this suggested content element.
getName() - Method in class oracle.search.query.webservice.client.SessionContextElement
Returns the name of the session context element.
getName() - Method in class oracle.search.sdk.common.ParameterInfo
Returns the name of the parameter
getName() - Method in interface oracle.search.sdk.query.FolderInfo
Gets the folder name.
getObjectKey() - Method in class oracle.search.admin.api.ws.client.Status
Returns the object key of the associated object.
getObjectType() - Method in class oracle.search.admin.api.ws.client.Status
Returns the object type of the associated object.
getObjectXML() - Method in class oracle.search.admin.api.ws.client.ObjectOutput
Returns the object XML describing the configuration or state of one or more objects.
getOperator() - Method in class oracle.search.query.webservice.client.Filter
Returns the operator of the attribute used in the predicate.
getOptionParameter() - Method in class oracle.search.query.webservice.client.GroupAttribute
Returns the grouping option parameter.
getOutLinks(Integer, Integer, String) - Method in class oracle.search.query.webservice.client.OracleSearchService
Returns an array of outgoing links for a given document.
getParameterValue(String) - Method in interface oracle.search.sdk.common.ParameterValues
Returns a parameter value
getPassword() - Method in class oracle.search.admin.api.ws.client.Credentials
Returns the administrator password.
getPath() - Method in class oracle.search.query.webservice.client.FacetNode
 
getProperties() - Method in class oracle.search.admin.api.ws.client.Attachment
Returns the list of administration properties.
getProperties() - Method in class oracle.search.admin.api.ws.client.Credentials
Returns the list of administration properties.
getProperties() - Method in class oracle.search.admin.api.ws.client.ObjectKey
Returns the list of administration properties.
getProperties() - Method in class oracle.search.admin.api.ws.client.ObjectOutput
Returns the list of administration properties.
getProperties() - Method in class oracle.search.admin.api.ws.client.Status
Returns the list of administration properties.
getProperties() - Method in class oracle.search.query.webservice.client.FacetNode
 
getPropertyName() - Method in class oracle.search.admin.api.ws.client.AdminProperty
Returns the property name.
getPropertyValue() - Method in class oracle.search.admin.api.ws.client.AdminProperty
Returns the property value.
getQuery() - Method in class oracle.search.query.webservice.client.OracleSearchResult
Returns the query string.
getResourceName() - Method in class oracle.search.admin.api.ws.client.Attachment
Returns the resource name.
getResourcePath() - Method in class oracle.search.admin.api.ws.client.Attachment
Returns the resource path.
getResultElements() - Method in class oracle.search.query.webservice.client.OracleSearchResult
Returns the hit list for the query.
getReturnCount() - Method in class oracle.search.query.webservice.client.OracleSearchResult
Returns a Boolean value indicating whether the estimated hit count is included in the result.
getScore() - Method in class oracle.search.query.webservice.client.ResultElement
Returns the relevance score of the document.
getSearchPort() - Method in class oracle.search.query.webservice.client.OracleSearchService
 
getSearchResult() - Method in class oracle.search.query.webservice.client.OracleFacetResultContainer
 
getSearchResult() - Method in class oracle.search.query.webservice.client.OracleResultContainer
Gets the search result.
getSessionContext() - Method in interface oracle.search.sdk.query.RequestInfo
Gets the session context Map object.
getSignature() - Method in class oracle.search.query.webservice.client.ResultElement
Returns the signature of the document.
getSnippet() - Method in class oracle.search.query.webservice.client.ResultElement
Returns keywords in context (KWIC) of the document for the given query.
getSoapURL() - Method in class oracle.search.query.webservice.client.OracleSearchService
Gets the URL for the Web service endpoint.
getSortOption() - Method in class oracle.search.query.webservice.client.SortAttribute
Returns the sorting option.
getStartIndex() - Method in class oracle.search.query.webservice.client.OracleSearchResult
Returns the start index for the hit list.
getState(String, ObjectKey, List, Credentials, List, String) - Method in interface oracle.search.admin.api.ws.client.AdminPortType
Returns the state of an administrative object.
getStateList(String, List, List, Credentials, List, String) - Method in interface oracle.search.admin.api.ws.client.AdminPortType
Returns the state of a list of administrative objects with a specified type.
getStatus() - Method in class oracle.search.query.webservice.client.Status
Returns the status code for the request.
getStatusCode() - Method in class oracle.search.admin.api.ws.client.Status
Returns the status code for the associated object.
getSuggestedContent(String, String) - Method in class oracle.search.query.webservice.client.OracleSearchService
Invokes Oracle SES Suggested Content search only to get the suggested content for the query
getSuggestedLinks() - Method in class oracle.search.query.webservice.client.OracleSearchResult
Returns suggested links for the query.
getTitle() - Method in class oracle.search.query.webservice.client.ResultElement
Returns the title of the document.
getTitle() - Method in class oracle.search.query.webservice.client.SuggestedLink
Returns the title of the suggested link.
getTitle() - Method in interface oracle.search.sdk.query.DocumentInfo
Returns the title of the document.
getTokenizationDelimiter() - Method in class oracle.search.query.webservice.client.ClusterAttribute
Returns the tokenization delimiter.
getTreeName() - Method in class oracle.search.query.webservice.client.ClusterTree
Return the name of this tree
getType() - Method in class oracle.search.query.webservice.client.Attribute
Returns the type of the attribute.
getUrl() - Method in class oracle.search.query.webservice.client.ResultElement
Returns the URL to access the document.
getUrl() - Method in class oracle.search.query.webservice.client.SuggestedLink
Returns the URL of the suggested link.
getUserName() - Method in class oracle.search.admin.api.ws.client.Credentials
Returns the administrator user name.
getUserStats(String[], String[], String) - Method in class oracle.search.query.webservice.client.OracleSearchService
Return user statistics corresponding to the data groups specified
getValue() - Method in class oracle.search.query.webservice.client.AttributeLOVElement
Returns the value of the attribute.
getValue() - Method in class oracle.search.query.webservice.client.CustomAttribute
Returns the value of the the custom attribute.
getValue() - Method in class oracle.search.query.webservice.client.Property
Gets the value of the property.
getValue() - Method in class oracle.search.query.webservice.client.SessionContextElement
Returns the value of the session context element.
GroupAttribute - Class in oracle.search.query.webservice.client
GroupAttribute represents the grouping settings of a document attribute.
GroupAttribute(SortAttribute, String, String) - Constructor for class oracle.search.query.webservice.client.GroupAttribute
 
GroupingResult - Class in oracle.search.query.webservice.client
GroupingResult represents a group in the result of a grouping operation.
GroupingResult() - Constructor for class oracle.search.query.webservice.client.GroupingResult
 

Skip navigation links

Oracle Secure Enterprise Search Java API Reference
11g Release 2 (11.2.1.0.0)

E17597-02

A C D E F G I L N O P R S T U W


Copyright © 2006, 2011, Oracle and/or its affiliates. All rights reserved.