com.arsdigita.search.intermedia
Interface SearchIndexHelpCustomize

All Known Subinterfaces:

SearchIndexHelpCustomize

Deprecated. see the com.arsdigita.search package

public interface SearchIndexHelpCustomize

This class is now deprecated, use the generic search API in the com.arsdigita.search package instead.

Field Summary

static String	RAW Deprecated.
static String	versionId Deprecated.
static String	XML Deprecated.

Method Summary

String[]

searchIndexHelpFields() Deprecated. Method searchIndexHelpFields returns a String array which specifies the customization of the fields to be indexed using the SearchIndexHelp.

Field Detail

versionId

public static final String versionId

Deprecated.

See Also:

Constant Field Values

RAW

public static final String RAW

Deprecated.

See Also:

Constant Field Values

XML

public static final String XML

Deprecated.

See Also:

Constant Field Values

Method Detail

searchIndexHelpFields

public String[] searchIndexHelpFields()

Deprecated.

Method searchIndexHelpFields returns a String array which specifies the customization of the fields to be indexed using the SearchIndexHelp. (SearchIndexHelp methods are used to index the content if the string "Use_SearchIndexHelp" is returned by either the getSearchXMLContent or getSearchRawContent methods).

For example, if a DomainObject contains four fields: title, author, start_date, and description; and the "title" and "author" fields are to be indexed using XML, "description" is to be indexed as raw content, and "start_date" should not be indexed; then the String array returned would be the following:

    String[] indexFields = {
       "title" + XML,
       "author" + XML,
       "description + RAW
    }

Any field not in the string (such as "start_date" in the above example) is not indexed.

See Also:

SearchIndexHelp, Searchable, SearchableObserver, SearchableACSObject