com.sap.workspaces.content

Class AbstractModule

java.lang.Object
  com.sap.workspaces.content.AbstractModule

public abstract class AbstractModule
extends Object

Extend this abstract class to represent a module instance.

Since:

1.1

Constructor Summary

AbstractModule()

Method Summary

abstract String	getContent(com.sapportals.portal.prt.component.IPortalComponentRequest request) Depending on the module's isolation mode, returns: if isolated, the URL of the module; if embedded, the HTML markup of the module content
abstract String	getContentForIndexing() Returns the textual content of the module for the purposes of indexing; can be an empty string if no content exist or is not available.
abstract String	getID() Returns the module ID
abstract String	getName(Locale locale) Returns the module's name

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractModule

public AbstractModule()

Method Detail

getID

public abstract String getID()

Returns the module ID

Returns:

The ID of the module

getName

public abstract String getName(Locale locale)

Returns the module's name

Parameters:

locale - the current user's locale

Returns:

The module name according to the specified locale

getContent

public abstract String getContent(com.sapportals.portal.prt.component.IPortalComponentRequest request)
                           throws WorkspacesRuntimeException

Depending on the module's isolation mode, returns: if isolated, the URL of the module; if embedded, the HTML markup of the module content

Parameters:

request - the portal request

Returns:

The module's content

Throws:

WorkspacesRuntimeException

getContentForIndexing

public abstract String getContentForIndexing()
                                      throws WorkspacesRuntimeException

Returns the textual content of the module for the purposes of indexing; can be an empty string if no content exist or is not available. Do not include the module name in the returned string

Returns:

The module content

Throws:

WorkspacesRuntimeException