Skip navigation links

Oracle Secure Enterprise Search Java API Reference
10g Release 1 (10.1.8)

B32260-01

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


S

SCElement - class oracle.search.query.webservice.client.SCElement.
SCElement encapsulates suggested content.
SCElement() - Constructor for class oracle.search.query.webservice.client.SCElement
 
SIMPLE - Static variable in interface oracle.search.sdk.crawler.DocumentAcl
id formats; note: must reference values in IdentityManager
STATUS_ACCESS_FORBIDDEN - Static variable in interface oracle.search.sdk.crawler.DocumentContainer
Access to this document is forbidden
STATUS_AUTH_REQUIRED - Static variable in interface oracle.search.sdk.crawler.DocumentContainer
Authorization required to access this document
STATUS_BAD_GATEWAY - Static variable in interface oracle.search.sdk.crawler.DocumentContainer
Bad gateway for accessing this document
STATUS_BAD_REQUEST - Static variable in interface oracle.search.sdk.crawler.DocumentContainer
Request to access this document is bad
STATUS_CANNOT_READ - Static variable in interface oracle.search.sdk.crawler.DocumentContainer
The document has no contents
STATUS_CONNECTION_REFUSED - Static variable in interface oracle.search.sdk.crawler.DocumentContainer
Connection refused when accessing this document
STATUS_CRAWL_ABORT_SHUTDOWN - Static variable in interface oracle.search.sdk.crawler.GeneralService
The crawler is shutting down due to fatal crawl error
STATUS_DOC_BOUNDARY_RULE_EXCLUDED - Static variable in interface oracle.search.sdk.crawler.DocumentContainer
The document was excluded based on boundary rules
STATUS_DOC_MIME_TYPE_EXCLUDED - Static variable in interface oracle.search.sdk.crawler.DocumentContainer
The document was excluded based on mime type
STATUS_DOC_SIZE_TOO_BIG - Static variable in interface oracle.search.sdk.crawler.DocumentContainer
The document was too big to handle
STATUS_DUPLICATE_DOC - Static variable in interface oracle.search.sdk.crawler.DocumentContainer
duplicate document which should be ignored
STATUS_EMPTY_DOC - Static variable in interface oracle.search.sdk.crawler.DocumentContainer
The document has no contents
STATUS_FETCH_ERROR - Static variable in interface oracle.search.sdk.crawler.DocumentContainer
The document cannot be retrieved
STATUS_FILTER_ERROR - Static variable in interface oracle.search.sdk.crawler.DocumentContainer
The document can not be filtered
STATUS_IO_EXCEPTION - Static variable in interface oracle.search.sdk.crawler.DocumentContainer
IO exception when processing this document
STATUS_LOGIN_FAILED - Static variable in interface oracle.search.sdk.crawler.DocumentContainer
Login failed for this document
STATUS_NORMAL_SHUTDOWN - Static variable in interface oracle.search.sdk.crawler.GeneralService
The crawler finished crawl and is in the process of shutting down
STATUS_NOTFOUND - Static variable in interface oracle.search.sdk.crawler.DocumentContainer
The document cannot be found
STATUS_OK_BUT_NO_INDEX - Static variable in interface oracle.search.sdk.crawler.DocumentContainer
The document is fine, but do not index it yet
STATUS_OK_CRAWLED - Static variable in interface oracle.search.sdk.crawler.DocumentContainer
The document was crawled ok
STATUS_OK_FOR_INDEX - Static variable in interface oracle.search.sdk.crawler.DocumentContainer
The document is ready to be indexed
STATUS_OUT_OF_MEMORY - Static variable in interface oracle.search.sdk.crawler.DocumentContainer
Out of memory error when processing this document
STATUS_PLUGIN_ABORT_SHUTDOWN - Static variable in interface oracle.search.sdk.crawler.GeneralService
The crawler is shutting down due to fatal plug-in error
STATUS_PROXY_REQUIRED - Static variable in interface oracle.search.sdk.crawler.DocumentContainer
Proxy required to access this document
STATUS_READ_TIMEOUT - Static variable in interface oracle.search.sdk.crawler.DocumentContainer
Read timeout on this document
STATUS_REQUEST_TIMEOUT - Static variable in interface oracle.search.sdk.crawler.DocumentContainer
Request to access this document time out
STATUS_RUNNING - Static variable in interface oracle.search.sdk.crawler.GeneralService
The crawler is running
STATUS_SERVER_ERROR - Static variable in interface oracle.search.sdk.crawler.DocumentContainer
The server has problem deliverying this dopcument
STATUS_STOPPED_BY_USER - Static variable in interface oracle.search.sdk.crawler.GeneralService
The crawler is shutting down due to user request
Schedule - class oracle.search.admin.ws.client.Schedule.
Represents a crawler schedule.
Schedule() - Constructor for class oracle.search.admin.ws.client.Schedule
 
ScheduleStatus - class oracle.search.admin.ws.client.ScheduleStatus.
Represents the current status of a crawler schedule.
ScheduleStatus() - Constructor for class oracle.search.admin.ws.client.ScheduleStatus
 
SearchAdminClient - class oracle.search.admin.ws.client.SearchAdminClient.
A client proxy class that can be used to access the Oracle Secure Enterprise Search admin web service.
SearchAdminClient() - Constructor for class oracle.search.admin.ws.client.SearchAdminClient
 
SessionContextElement - class oracle.search.query.webservice.client.SessionContextElement.
SessionContextElement encapsulates an element in the session context information.
SessionContextElement() - Constructor for class oracle.search.query.webservice.client.SessionContextElement
 
SessionContextElement(String, String) - Constructor for class oracle.search.query.webservice.client.SessionContextElement
 
Status - class oracle.search.query.webservice.client.Status.
Status encapsulates the status of a request.
Status() - Constructor for class oracle.search.query.webservice.client.Status
 
Status(String, String) - Constructor for class oracle.search.query.webservice.client.Status
 
SuggestedLink - class oracle.search.query.webservice.client.SuggestedLink.
SuggestedLink encapsulates suggested link information for a given query string.
SuggestedLink() - Constructor for class oracle.search.query.webservice.client.SuggestedLink
 
SuggestedLink(String, String) - Constructor for class oracle.search.query.webservice.client.SuggestedLink
 
setACLInfo(DocumentAcl) - Method in interface oracle.search.sdk.crawler.DocumentMetadata
Set the document ACL.
setAccessURL(String) - Method in interface oracle.search.sdk.crawler.DocumentMetadata
Set the access URL property
setAccessUrl(String) - Method in interface oracle.search.sdk.crawler.UrlCandidate
Set access url; null if no access url
setAffinity(String) - Method in interface oracle.search.sdk.crawler.DocumentMetadata
Set the document affinity value for duplicate detection
setAltKeywords(String) - Method in class oracle.search.query.webservice.client.OracleSearchResult
Sets the alternate keywords for the query.
setAttributeId(Integer) - Method in class oracle.search.query.webservice.client.Filter
Sets the ID of the attribute used in the predicate.
setAttributeType(String) - Method in class oracle.search.query.webservice.client.Filter
Sets the type of the attribute used in the predicate.
setAttributeValue(String) - Method in class oracle.search.query.webservice.client.Filter
Sets the value of the attribute used in the predicate.
setAttributes(String, BigDecimal[]) - Method in interface oracle.search.sdk.crawler.DocumentMetadata
Set(replace) a list of attribute values whose type is number
setAttributes(String, Date[]) - Method in interface oracle.search.sdk.crawler.DocumentMetadata
Set(replace) a list of attribute values whose type is java.util.Date Note that java.util.Date has time component
setAttributes(String, String[]) - Method in interface oracle.search.sdk.crawler.DocumentMetadata
Set(replace) a list of attribute values whose type is String
setAuthor(String) - Method in class oracle.search.query.webservice.client.ResultElement
Sets the author for the document.
setContent(Byte[]) - Method in class oracle.search.query.webservice.client.SCElement
Sets the suggested content for this provider.
setContentLength(Integer) - Method in class oracle.search.query.webservice.client.ResultElement
Sets the content length of the document.
setContentLength(int) - Method in interface oracle.search.sdk.crawler.DocumentMetadata
set the size of the document The size could be overwritten by the crawler when fetching the content
setContentType(String) - Method in interface oracle.search.sdk.crawler.DocumentMetadata
Set the content type of the document
setCrawlDepth(int) - Method in interface oracle.search.sdk.crawler.DocumentMetadata
Set the crawling depth of the document.
setCustomAttributes(CustomAttribute[]) - Method in class oracle.search.query.webservice.client.ResultElement
Sets custom (non-default) attributes of the document.
setDescription(String) - Method in class oracle.search.query.webservice.client.ResultElement
Sets the description for the document.
setDiscardFlag(boolean) - Method in interface oracle.search.sdk.crawler.UrlCandidate
Set the discard flag for whether to ignore the candidate url or not
setDisplayName(String) - Method in class oracle.search.query.webservice.client.Attribute
Sets the display name of the attribute.
setDisplayURL(String) - Method in interface oracle.search.sdk.crawler.DocumentMetadata
Set the display URL property
setDisplayUrl(String) - Method in interface oracle.search.sdk.crawler.UrlCandidate
Set display url; can not be null
setDisplayValue(String) - Method in class oracle.search.query.webservice.client.AttributeLOVElement
Sets the value of the attribute.
setDocCount(Integer) - Method in class oracle.search.query.webservice.client.Node
Sets the value indicating the number of documents under the node.
setDocID(Integer) - Method in class oracle.search.query.webservice.client.ResultElement
Sets the ID of the document.
setDocsReturned(Integer) - Method in class oracle.search.query.webservice.client.OracleSearchResult
Sets the number of search hits returned.
setDocument(Reader) - Method in interface oracle.search.sdk.crawler.DocumentContainer
Set the document to be processed.
setDocument(InputStream) - Method in interface oracle.search.sdk.crawler.DocumentContainer
Set a document using the InputStream.
setDocumentStatus(int) - Method in interface oracle.search.sdk.crawler.DocumentContainer
Set the status of the document.
setDupMarked(Boolean) - Method in class oracle.search.query.webservice.client.OracleSearchResult
Sets the Boolean value indicating if the duplicate documents are marked in the hit-list.
setDupRemoved(Boolean) - Method in class oracle.search.query.webservice.client.OracleSearchResult
Sets the Boolean value indicating if the duplicate documents are removed from the hit-list.
setEndpoint(String) - Method in class oracle.search.admin.ws.client.SearchAdminClient
Sets the web service endpoint URL for the proxy class.
setEstimatedHitCount(Integer) - Method in class oracle.search.query.webservice.client.OracleSearchResult
Sets the estimated hit count for the query.
setFedID(String) - Method in class oracle.search.query.webservice.client.ResultElement
Sets the ID of the federated instance to which the document belongs.
setFedId(String) - Method in class oracle.search.query.webservice.client.Node
Sets the federated instance ID of the infosource node.
setFullpath(String[]) - Method in class oracle.search.query.webservice.client.Node
Sets the names of the nodes in the full path to the infosource node.
setFullpathIds(String[]) - Method in class oracle.search.query.webservice.client.Node
Sets the IDs of the nodes in the full path to the infosource node.
setGroupDisplayName(String) - Method in class oracle.search.query.webservice.client.DataGroup
Sets the display name of the data group.
setGroupID(Integer) - Method in class oracle.search.query.webservice.client.DataGroup
Sets the ID of the data group.
setGroupName(String) - Method in class oracle.search.query.webservice.client.DataGroup
Sets the name of the data group.
setGroups(DataGroup[]) - Method in class oracle.search.query.webservice.client.ResultElement
Sets the data groups to which the document belongs.
setHasChildren(Boolean) - Method in class oracle.search.query.webservice.client.Node
Sets the Boolean value indicating if the node has children.
setHasDuplicate(Boolean) - Method in class oracle.search.query.webservice.client.ResultElement
Sets the boolean value indicating if the document has one or more duplicate documents in the hit-list.
setId(Integer) - Method in class oracle.search.query.webservice.client.Attribute
Sets the ID of the attribute.
setId(String) - Method in class oracle.search.query.webservice.client.Node
Sets the ID of the infosource node.
setInfoSourceID(String) - Method in class oracle.search.query.webservice.client.ResultElement
Sets the infosource ID ofthe document.
setInfoSourcePath(String) - Method in class oracle.search.query.webservice.client.ResultElement
Sets the infosource path of the document.
setIsDuplicate(Boolean) - Method in class oracle.search.query.webservice.client.ResultElement
Sets the boolean value indicating if the document is duplicate of another document in the hit-list.
setLanguage(String) - Method in class oracle.search.query.webservice.client.ResultElement
Sets the language of the document.
setLanguage(String) - Method in interface oracle.search.sdk.crawler.DocumentMetadata
Set the language of the document using ISO 639-1 language code; for example, 'en' for English, 'ja' for Japanese, and 'fr' for French
setLanguageDisplayName(String) - Method in class oracle.search.query.webservice.client.Language
Sets the display name of the language.
setLanguageName(String) - Method in class oracle.search.query.webservice.client.Language
Sets the name of the language.
setLastModified(Date) - Method in class oracle.search.query.webservice.client.ResultElement
Sets the last modified date for the document.
setLastModifiedDate(Date) - Method in interface oracle.search.sdk.crawler.DocumentMetadata
Set the last modification date of the document
setMaintainSession(boolean) - Method in class oracle.search.admin.ws.client.SearchAdminClient
Sets a flag to determine whether this Java proxy will maintain its session.
setMessage(String) - Method in class oracle.search.query.webservice.client.Status
Sets the status message for the request.
setMetadata(DocumentMetadata) - Method in interface oracle.search.sdk.crawler.DocumentContainer
Set the Document Metadata object.
setMimetype(String) - Method in class oracle.search.query.webservice.client.ResultElement
Sets the mime type for the document.
setName(String) - Method in class oracle.search.query.webservice.client.Attribute
Sets the name of the attribute.
setName(String) - Method in class oracle.search.query.webservice.client.CustomAttribute
Sets the name of the the custom attribute.
setName(String) - Method in class oracle.search.query.webservice.client.Node
Sets the name of the infosource node.
setName(String) - Method in class oracle.search.query.webservice.client.SCElement
Sets the provider name.
setName(String) - Method in class oracle.search.query.webservice.client.SessionContextElement
Sets the name of the session context element.
setOperator(String) - Method in class oracle.search.query.webservice.client.Filter
Sets the operator of the attribute used in the predicate.
setOwnerGuid(String) - Method in interface oracle.search.sdk.crawler.DocumentMetadata
Set the document owner in the form of Oracle OID global user id (orclguid)
setQuery(String) - Method in class oracle.search.query.webservice.client.OracleSearchResult
Sets query string.
setResultElements(ResultElement[]) - Method in class oracle.search.query.webservice.client.OracleSearchResult
Sets the hit-list for the query.
setReturnCount(Boolean) - Method in class oracle.search.query.webservice.client.OracleSearchResult
Sets the Boolean value indicating whether the estimated hit count is included in the result.
setScore(Integer) - Method in class oracle.search.query.webservice.client.ResultElement
Sets the relevance score for the document.
setSearchUser(String) - Method in class oracle.search.query.webservice.client.OracleSearchService
Sets the search user.
setSessionContext(SessionContextElement[]) - Method in class oracle.search.query.webservice.client.OracleSearchService
Sets the session context to be used for query-time filtering.
setSignature(Long) - Method in class oracle.search.query.webservice.client.ResultElement
Sets the signature of the document.
setSnippet(String) - Method in class oracle.search.query.webservice.client.ResultElement
Sets the keywords in context (KWIC) for the document for a given query.
setSoapURL(String) - Method in class oracle.search.query.webservice.client.OracleSearchService
Sets the URL for the web service endpoint.
setSourceHierarchy(String[]) - Method in interface oracle.search.sdk.crawler.DocumentMetadata
Set the path of the document in terms of information source organization.
setStartIndex(Integer) - Method in class oracle.search.query.webservice.client.OracleSearchResult
Sets the start index for the hit-list.
setStatus(String) - Method in class oracle.search.query.webservice.client.Status
Sets the status code for the request.
setSuggestedLinks(SuggestedLink[]) - Method in class oracle.search.query.webservice.client.OracleSearchResult
Sets suggested links for the query.
setTitle(String) - Method in class oracle.search.query.webservice.client.ResultElement
Sets the title for the document.
setTitle(String) - Method in class oracle.search.query.webservice.client.SuggestedLink
Sets the title of the suggested link.
setType(String) - Method in class oracle.search.query.webservice.client.Attribute
Sets the type of the attribute.
setUrl(String) - Method in class oracle.search.query.webservice.client.ResultElement
Sets the URL to access the document.
setUrl(String) - Method in class oracle.search.query.webservice.client.SuggestedLink
Sets the URL of the suggested link.
setValue(String) - Method in class oracle.search.query.webservice.client.AttributeLOVElement
Sets the value of the attribute.
setValue(String) - Method in class oracle.search.query.webservice.client.CustomAttribute
Sets the value of the the custom attribute.
setValue(String) - Method in class oracle.search.query.webservice.client.SessionContextElement
Sets the value of the session context element.
startSchedule(String) - Method in class oracle.search.admin.ws.client.SearchAdminClient
Starts the specified crawler schedule.
status - Variable in class oracle.search.admin.ws.client.ScheduleStatus
 
stopCrawling() - Method in interface oracle.search.sdk.crawler.CrawlerPlugin
Tell the plugin to stop crawling; use getCrawlerStatus() from GeneralService if the clean up depends on the crawler shutdown scenario.
stopQueueService() - Method in interface oracle.search.sdk.crawler.QueueService
Stopping the queue service operation; any pending getNextItem request will be replied with null result
stopSchedule(String) - Method in class oracle.search.admin.ws.client.SearchAdminClient
Stops the specified crawler schedule.
submitForProcessing(DocumentContainer) - Method in interface oracle.search.sdk.crawler.CrawlingThreadService
submit the document for processing.
submitUrl(String) - Method in class oracle.search.query.webservice.client.OracleSearchService
Submits a URL for Oracle SES to crawl and index.

Skip navigation links

Oracle Secure Enterprise Search Java API Reference
10g Release 1 (10.1.8)

B32260-01

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


Copyright © 2006, Oracle. All rights reserved.