oracle.ecsf
Interface IndexableDocument

All Superinterfaces:

Document

public interface IndexableDocument
extends Document

An indexable document represents an instance of a searchable object that can be indexed by a search engine.

A search engine implementation should have its own implementation of this interface to represent its internal data structure and expose it per this interface.

The implementation is consumed by various components in ECSF.

Field Summary

static java.lang.String	DELETE
static java.lang.String	INSERT
static java.lang.String	UPDATE

Method Summary

void	addAttachment(Attachment attachment) Adds an attachment to this document.
java.lang.String	getAccessURL(SearchContext ctx) Returns Url to access EBS detail page.
java.lang.String[]	getAcl(SearchContext ctx) Returns a list of strings, the access list.
java.lang.String	getActionType() Returns the action type required for the document.
java.util.List<Attachment>	getAttachments() Returns a list of attachments this document contains.
java.lang.String[]	getAttributeAcl(java.lang.String fieldName) Returns a list of acl per field name.
void	overrideAccessURL(java.lang.String accessURL) Overrides access URL logic, and use the value assigned here.
void	setActionType(java.lang.String actionType) Sets the action type for the document.
void	setAttribueAcl(java.lang.String fieldName, java.lang.String[] acl) Sets acl to the field.

Methods inherited from interface oracle.ecsf.Document

addChildDoc, addField, addTags, clearTags, getAttributes, getChildDocs, getContent, getContentType, getDisplayURL, getDocumentDefinition, getFields, getFieldValue, getKeywords, getLanguage, getPrimaryKey, getSearchableObject, getTags, getTitle, removeChildDocs, setContent, setContentType, setDocumentDefinition, setFieldValue, setKeywords, setLanguage, setPrimaryKey, setTitle

Field Detail

DELETE

static final java.lang.String DELETE

See Also:

Constant Field Values

UPDATE

static final java.lang.String UPDATE

See Also:

Constant Field Values

INSERT

static final java.lang.String INSERT

See Also:

Constant Field Values

Method Detail

addAttachment

void addAttachment(Attachment attachment)

Adds an attachment to this document. This will be used by crawler to crawl data from lobs.

Parameters:

attachment - to be added to.

getAttachments

java.util.List<Attachment> getAttachments()

Returns a list of attachments this document contains.

Returns:

a list of attachments.

getActionType

java.lang.String getActionType()

Returns the action type required for the document.

Returns:

the action type for this document.

setActionType

void setActionType(java.lang.String actionType)

Sets the action type for the document.

Its values can be:

• IndexableDocument.DELETE
• IndexableDocument.UPDATE
• IndexableDocument.INSERT

Parameters:

actionType - action to be performed on this document

overrideAccessURL

void overrideAccessURL(java.lang.String accessURL)

Overrides access URL logic, and use the value assigned here.

Parameters:

accessURL - the overriding URL for this document.

getAccessURL

java.lang.String getAccessURL(SearchContext ctx)

Returns Url to access EBS detail page. This URL is formed based on the form function specified by developers along with parameters.

Parameters:

ctx -

Returns:

EBS url.

setAttribueAcl

void setAttribueAcl(java.lang.String fieldName,
                    java.lang.String[] acl)

Sets acl to the field.

Parameters:

fieldName - to which the acl is set.

acl - list of values used as the acl for this document on this field.

getAttributeAcl

java.lang.String[] getAttributeAcl(java.lang.String fieldName)

Returns a list of acl per field name.

Parameters:

fieldName - to which the acl is returned.

Returns:

acl values for the field.

getAcl

java.lang.String[] getAcl(SearchContext ctx)

Returns a list of strings, the access list. If no ACL for the document, it must return null.

Parameters:

ctx - SearchContext

Returns:

Access control list. Null if none.