Skip navigation links

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

G

GROUP - Static variable in interface oracle.search.sdk.crawler.DocumentAcl

GUID - Static variable in interface oracle.search.sdk.crawler.DocumentAcl

GeneralService - interface oracle.search.sdk.crawler.GeneralService.

GeneralService is an interface used by a crawler plugin to perform miscellaneous service

getACLInfo() - Method in interface oracle.search.sdk.crawler.DocumentMetadata

Get the ACL associated with the document

getAccessURL() - Method in interface oracle.search.sdk.crawler.DocumentMetadata

Get the value of an access URL document property

getAccessUrl() - Method in interface oracle.search.sdk.crawler.UrlCandidate

Get access url

getAllAttributes(String) - Method in class oracle.search.query.webservice.client.OracleSearchService

Returns all the search attributes available in Oracle SES.

getAltKeywords() - Method in class oracle.search.query.webservice.client.OracleSearchResult

Returns the alternate keywords for the query.

getAssignedSources() - Method in class oracle.search.admin.ws.client.Schedule

Returns an array of the names of the sources assigned to this crawler schedule.

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.

getAttributeLov(int) - Method in interface oracle.search.sdk.crawler.LovInfo

Get the list of values for a specified attribute

getAttributeName(int) - Method in interface oracle.search.sdk.crawler.DocumentMetadata

Get the name of the specified attribute

getAttributeName(int) - Method in interface oracle.search.sdk.crawler.LovInfo

Get the name of the specified attribute

getAttributeType() - Method in class oracle.search.query.webservice.client.Filter

Returns the type of the attribute used in the predicate.

getAttributeType(int) - Method in interface oracle.search.sdk.crawler.DocumentMetadata

Get the data type of the specified attribute

getAttributeType(int) - Method in interface oracle.search.sdk.crawler.LovInfo

Get the data type of the specified attribute

getAttributeValue() - Method in class oracle.search.query.webservice.client.Filter

Returns the value of the attribute used in the predicate.

getAttributeValues(int) - Method in interface oracle.search.sdk.crawler.DocumentMetadata

Get the list of values for a specified attribute

getAttributeValues(String) - Method in interface oracle.search.sdk.crawler.DocumentMetadata

Get the list of values for a specified attribute

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.

getAuthor() - Method in class oracle.search.query.webservice.client.ResultElement

Returns the athor of the document.

getBaseAPIVersion() - Method in interface oracle.search.sdk.crawler.CrawlerPluginManager

Get the version string of the plugin API - this method should always return CrawlerPluginManager.VERSION

getCachedPage(String, Integer, String) - Method in class oracle.search.query.webservice.client.OracleSearchService

Returns cached HTML version of a document.

getCandidateUrl() - Method in interface oracle.search.sdk.crawler.UrlCandidate

Get target url string for rewrite checking

getContent() - Method in class oracle.search.query.webservice.client.SCElement

Returns the suggested content for this provider.

getContentLength() - Method in interface oracle.search.query.qta.DocumentInfo

Returns the length of the contents of the document.

getContentLength() - Method in class oracle.search.query.webservice.client.ResultElement

Returns the content length of the document.

getContentLength() - Method in interface oracle.search.sdk.crawler.DocumentMetadata

return the actual document content size in bytes It may not be the exact same number as the plugin set

getContentType() - Method in interface oracle.search.sdk.crawler.DocumentMetadata

Get the document content type

getCrawlDepth() - Method in interface oracle.search.sdk.crawler.DocumentMetadata

Get the crawling depth of the document.

getCrawlerPlugin(CrawlingThreadService) - Method in interface oracle.search.sdk.crawler.CrawlerPluginManager

provide a CrawlerPlugin instance.

getCrawlerStatus() - Method in interface oracle.search.sdk.crawler.GeneralService

Get the current crawler status.

getCurrentStatus() - Method in class oracle.search.admin.ws.client.Schedule

Returns the current status of this schedule.

getCurrentUserName(RequestInfo) - Method in interface oracle.search.query.qta.QueryTimeFilter

Returns the user name of the current user from the request information object.

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.

getDataSourceService() - Method in interface oracle.search.sdk.crawler.GeneralService

Get the datasource service object

getDefaultAccessPolicy() - Method in interface oracle.search.sdk.crawler.CrawlerPluginManager

Get the default access policy of the plugin

getDefaultValue() - Method in class oracle.search.sdk.common.ParameterInfo

Returns the default value of the parameter

getDefaultValue() - Method in class oracle.search.sdk.crawler.ParameterInfo

Get 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

getDescription() - Method in class oracle.search.sdk.crawler.ParameterInfo

Get the description of the parameter

getDisplayName() - Method in class oracle.search.query.webservice.client.Attribute

Returns the display name of the attribute.

getDisplayNames(int, int) - Method in interface oracle.search.sdk.crawler.LovInfo

Get the list of display names for a specified attribute

getDisplayURL() - Method in interface oracle.search.sdk.crawler.DocumentMetadata

Get the value of an URL data property.

getDisplayUrl() - Method in interface oracle.search.sdk.crawler.UrlCandidate

Get display url

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.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.

getDocumentAttributes(String) - Method in interface oracle.search.sdk.crawler.DataSourceService

Retrieve the attribute data of an existing document.

getDocumentReader() - Method in interface oracle.search.sdk.crawler.DocumentContainer

Get the reader for the data that was set in the documentContainer.

getDocumentStatus() - Method in interface oracle.search.sdk.crawler.DocumentContainer

Get the status of the document (DocumentContainer.STATUS*)

getDocumentStream() - Method in interface oracle.search.sdk.crawler.DocumentContainer

Get the stream for the data that was set in the documentContainer.

getDupMarked() - Method in class oracle.search.query.webservice.client.OracleSearchResult

Returns the Boolean value indicating if the duplicate documents are marked in the hist-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.

getEndpoint() - Method in class oracle.search.admin.ws.client.SearchAdminClient

Returns the current web service endpoint URL for the proxy class.

getErrorLog() - Method in class oracle.search.admin.ws.client.ScheduleStatus

Returns the contents of the error log for the crawler.

getErrorString() - Method in class oracle.search.sdk.crawler.PluginException

returns the error message

getErrorString(int, String) - Method in class oracle.search.sdk.crawler.PluginException

returns the error message based on the error code

getEstimatedHitCount() - Method in class oracle.search.query.webservice.client.OracleSearchResult

Returns the estimated hit count for the query.

getEstimatedIndexFragmentation() - Method in class oracle.search.admin.ws.client.SearchAdminClient

Returns the estimated index fragmentation level, as an integer percentage.

getFedID() - Method in class oracle.search.query.webservice.client.ResultElement

Returns the ID of the federated instance to which the document belongs.

getFedId() - Method in class oracle.search.query.webservice.client.Node

Returns the ID of the federated instance.

getFullPath() - Method in interface oracle.search.query.qta.FolderInfo

Gets the full path for this folder, including the source group as the root element.

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.

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.

getGroupName() - Method in class oracle.search.query.webservice.client.DataGroup

Returns the name of the data 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.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.

getHttpRequest() - Method in interface oracle.search.query.qta.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.

getInLinks(Integer, Integer, String) - Method in class oracle.search.query.webservice.client.OracleSearchService

Returns an array of incoming links for a given document.

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.

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.

getLangCode(int, int) - Method in interface oracle.search.sdk.crawler.LovInfo

Get the language-country code string for a display name

getLanguage() - Method in class oracle.search.query.webservice.client.ResultElement

Returns the language of the document.

getLanguage() - Method in interface oracle.search.sdk.crawler.DocumentMetadata

Get the ISO 639-1 language code 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.

getLastCrawled() - Method in class oracle.search.admin.ws.client.ScheduleStatus

Returns the date and time of the last crawl

getLastDocumentStatus() - Method in interface oracle.search.sdk.crawler.DocumentMetadata

Get the document status of the previous crawl

getLastModified() - Method in interface oracle.search.query.qta.DocumentInfo

Returns the date of last modification of the document.

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.crawler.DocumentMetadata

Get the last modification date of the document

getLogLevel() - Method in interface oracle.search.sdk.common.Logger

Returns the current logging level.

getLoggingService() - Method in interface oracle.search.sdk.crawler.GeneralService

get the Logger object

getMaintainSession() - Method in class oracle.search.admin.ws.client.SearchAdminClient

Returns whether the session is currently being maintained.

getMessage() - Method in class oracle.search.query.webservice.client.Status

Returns the status message for the request.

getMetadata() - Method in interface oracle.search.sdk.crawler.DocumentContainer

Get the metadata object associated with this document container

getMimetype() - Method in class oracle.search.query.webservice.client.ResultElement

Returns the mime type of the document.

getName() - Method in class oracle.search.admin.ws.client.Schedule

Returns the name of this schedule.

getName() - Method in interface oracle.search.query.qta.FolderInfo

Gets the folder name.

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.Node

Returns number of documents under the infosource node.

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 class oracle.search.sdk.crawler.ParameterInfo

Get the name of the parameter

getNextCrawl() - Method in class oracle.search.admin.ws.client.ScheduleStatus

Returns the date and time of the next scheduled crawl.

getNextItem() - Method in interface oracle.search.sdk.crawler.QueueService

get the next URL from the queue.

getNumAttrValues() - Method in interface oracle.search.sdk.crawler.DocumentMetadata

Get number of attribute values

getNumAttrValues() - Method in interface oracle.search.sdk.crawler.LovInfo

Get number of attribute values

getNumAttributes() - Method in interface oracle.search.sdk.crawler.DocumentMetadata

Get number of attributes

getNumAttributes() - Method in interface oracle.search.sdk.crawler.LovInfo

Get number of attributes

getNumDisplayNames(int, int) - Method in interface oracle.search.sdk.crawler.LovInfo

Get number of display names of an attribute for a language

getNumLanguages(int) - Method in interface oracle.search.sdk.crawler.LovInfo

Get number of languages used for the display name of an attribute

getOperator() - Method in class oracle.search.query.webservice.client.Filter

Returns the operator of the attribute used in the predicate.

getOutLinks(Integer, Integer, String) - Method in class oracle.search.query.webservice.client.OracleSearchService

Returns an array of outgoing links for a given document.

getOwnerGuid() - Method in interface oracle.search.sdk.crawler.DocumentMetadata

Get the owner id of the document in the form of global user id (GUID)

getParameterValue(String) - Method in interface oracle.search.sdk.common.ParameterValues

Returns a parameter value

getPluginDescription() - Method in interface oracle.search.sdk.crawler.CrawlerPluginManager

Get the description of the plugin

getPluginName() - Method in interface oracle.search.sdk.crawler.CrawlerPluginManager

Get the name of the plugin

getPluginParameters() - Method in interface oracle.search.sdk.crawler.CrawlerPluginManager

Get the parameters of the plugin

getPluginVersion() - Method in interface oracle.search.sdk.crawler.CrawlerPluginManager

Get the version string of the plugin

getQuery() - Method in class oracle.search.query.webservice.client.OracleSearchResult

Returns the query string.

getQueueService() - Method in interface oracle.search.sdk.crawler.GeneralService

Get the queue service object

getQueueSize() - Method in interface oracle.search.sdk.crawler.QueueService

get the size of the queue

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.

getScheduleStatus(String, String) - Method in class oracle.search.admin.ws.client.SearchAdminClient

Returns the current status of a crawler schedule.

getSchedules(String) - Method in class oracle.search.admin.ws.client.SearchAdminClient

Returns information for all crawler schedules.

getScore() - Method in class oracle.search.query.webservice.client.ResultElement

Returns the relevance score of the document.

getSessionContext() - Method in interface oracle.search.query.qta.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.

getSourceHierarchy() - Method in interface oracle.search.sdk.crawler.DocumentMetadata

Get the source hierarchy of the document

getStartIndex() - Method in class oracle.search.query.webservice.client.OracleSearchResult

Returns the start index for the hit-list.

getStatus() - Method in class oracle.search.admin.ws.client.ScheduleStatus

Returns the crawler status.

getStatus() - Method in class oracle.search.query.webservice.client.Status

Returns the status code for the request.

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 interface oracle.search.query.qta.DocumentInfo

Returns the title of the document.

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.

getTranslatedStatus() - Method in class oracle.search.admin.ws.client.ScheduleStatus

Returns the crawler status, translated according to the value of the locale parameter provided to the Web service operation.

getType() - Method in class oracle.search.query.webservice.client.Attribute

Returns the type of the attribute.

getURL() - Method in interface oracle.search.query.qta.DocumentInfo

Returns the display URL of the document.

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.

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.SessionContextElement

Returns the value of the session context element.

Skip navigation links