Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.jboss.portal.search
Interface FederatedIndexer

All Known Implementing Classes:
  AbstractFederatedIndexer, DummyFederatedSearch, LuceneFederatedIndexer

    public interface FederatedIndexer

Version:
  $Revision: 8784 $
Author:
  Thomas Heute

Method Summary
`void` | `createIndex()` The create method should index the required components
`void` | `destroyIndex()` Method called when this federated search is not used anymore.
`org.jboss.portal.common.i18n.LocalizedString` | `getDisplayName()` Get a localized name for this federated search
`java.lang.String` | `getId()` Get the ID for this federated search
`Info` | `getInfo()` Info should return information on the current status if the federated search

Method Detail

### getId

    java.lang.String getId()

  Get the ID for this federated search

  Returns:
    String representing this particular federated search

### getDisplayName

    org.jboss.portal.common.i18n.LocalizedString getDisplayName()

  Get a localized name for this federated search

  Returns:
    String

### destroyIndex

    void destroyIndex()
                      throws IndexingException

  Method called when this federated search is not used anymore. This could be the place to destroy any index

  Throws:
    `IndexingException`

### createIndex

    void createIndex()
                     throws IndexingException

  The create method should index the required components

  Throws:
    `IndexingException`

### getInfo

    Info getInfo()

  Info should return information on the current status if the federated search

  Returns:

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD