|
Oracle Fusion Applications Search Java API Reference for Oracle Enterprise Crawl and Search Framework
11g Release 1 (11.1.1.6) E21908-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IndexableDocument
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 |
---|
static final java.lang.String DELETE
static final java.lang.String UPDATE
static final java.lang.String INSERT
Method Detail |
---|
void addAttachment(Attachment attachment)
attachment
- to be added to.java.util.List<Attachment> getAttachments()
java.lang.String getActionType()
void setActionType(java.lang.String actionType)
Its values can be:
actionType
- action to be performed on this documentvoid overrideAccessURL(java.lang.String accessURL)
accessURL
- the overriding URL for this document.java.lang.String getAccessURL(SearchContext ctx)
ctx
-
void setAttribueAcl(java.lang.String fieldName, java.lang.String[] acl)
fieldName
- to which the acl is set.acl
- list of values used as the acl for this document on this field.java.lang.String[] getAttributeAcl(java.lang.String fieldName)
fieldName
- to which the acl is returned.
java.lang.String[] getAcl(SearchContext ctx)
ctx
- SearchContext
|
Oracle Fusion Applications Search Java API Reference for Oracle Enterprise Crawl and Search Framework
11g Release 1 (11.1.1.6) E21908-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |