com.sap.workspaces.indexing

Class AbstractIndexItem

java.lang.Object
  com.sap.workspaces.indexing.AbstractIndexItem

public abstract class AbstractIndexItem
extends Object

Extend this class to represent the textual data of a workspace item for the purposes of indexing

Since:

1.1

Constructor Summary

AbstractIndexItem()

Method Summary

abstract AbstractIndexItem[]	getChildren() Currently not supported
abstract String	getDescription() Returns the item description
abstract ItemInfo	getItemInfo() Returns an ItemInfo object for this item
abstract String	getName() Returns the item name
abstract String[]	getTexts() Returns the item textual content in an array;
abstract String	getType() Returns the string representation of the item type defined by a custom implementation for the purposes of indexing return The item type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractIndexItem

public AbstractIndexItem()

Method Detail

getName

public abstract String getName()
                        throws WorkspacesRuntimeException

Returns the item name

Returns:

The item name

Throws:

WorkspacesRuntimeException

getDescription

public abstract String getDescription()
                               throws WorkspacesRuntimeException

Returns the item description

Returns:

The item description

Throws:

WorkspacesRuntimeException

getTexts

public abstract String[] getTexts()
                           throws WorkspacesRuntimeException

Returns the item textual content in an array;

Returns:

An array containing the textual content of the item

Throws:

WorkspacesRuntimeException

getChildren

public abstract AbstractIndexItem[] getChildren()
                                         throws WorkspacesRuntimeException

Currently not supported

Returns:

Null

Throws:

WorkspacesRuntimeException

getItemInfo

public abstract ItemInfo getItemInfo()

Returns an ItemInfo object for this item

Returns:

getType

public abstract String getType()

Returns the string representation of the item type defined by a custom implementation for the purposes of indexing return The item type