com.mf.roundhouse.core.domain
Class ContentModule

java.lang.Object
  KennewickObject
      com.mf.roundhouse.core.domain.RoundhouseObject
          com.mf.roundhouse.core.domain.ContentModule

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CoreModule, PortletContainerModule

public abstract class ContentModule

extends RoundhouseObject

Abstract class implementing core behavior for all Roundhouse modules.

Author:

Jeffrey Payne

See Also:

Serialized Form

Field Summary

static java.lang.String

TERTIARY_MENU

Constructor Summary

ContentModule()
Construct a ContentModule.

ContentModule(ObjectIdentifier anId)
Construct a ContentModule object with the given id.

Method Summary

abstract void	activate() Performs necessary steps to activates the module to the Roundhouse system.
abstract java.util.Collection	generateDefaultLinks() Returns a collection of ConfigurableLinks that the implementing module wishes to conribute the the main menu.
abstract java.util.Collection	getAdminLinks() Should return a collection of ConfigurableLinks that the module would like added to the Core Module's tertiary menu and thus the system administration screen's tertiary menu.
abstract java.util.Collection	getDeclaredContentTypes() Returns a collection of ContentTypes declared by this module.
abstract ContentModuleDelegate	getDelegate() Return the ContentModuleDelgate object.
java.util.Collection	getFeedbackHooks() Override to return a collection of FeedbackHooks supported by this module.
abstract java.lang.String	getModuleDescription() Returns the description for this module.
abstract java.lang.String	getModuleId() Returns the ID for this module.
abstract java.lang.String	getModuleName() Returns the name of this module.
abstract Test	getModuleTestSuite()
abstract java.util.Collection	getPermissions() Returns a collection of permissions which this module provides.
abstract java.util.Collection	getPersonalizationLinks() Returns a collection of ConfigurableLinks that should be added to the tab strip when a user clicks the "MY ACCOUNT" or accountSettings link.
java.util.Collection	getSupportedLinks() Return a collection of supported links.
java.util.Collection	getTertiaryMenu() Answer the default tertiary menu.
java.util.Collection	getTertiaryMenu(java.lang.String context) Answer the tertiary menu for the given context.
abstract java.util.Collection	searchModule(java.lang.String searchString) Implementors should apply apply whatever logic necessary using the given search string and return a collection of SearchResult objects.
void	setSupportedLinks(java.util.Collection collection) Establish the collection of supported links.
void	setTertiaryMenu(java.util.Collection collection) Establish the default tertiary menu.

Methods inherited from class java.lang.Object

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

Field Detail

TERTIARY_MENU

public static final java.lang.String TERTIARY_MENU

See Also:

Constant Field Values

Constructor Detail

ContentModule

public ContentModule(ObjectIdentifier anId)
              throws java.lang.Exception

Construct a ContentModule object with the given id.

Parameters:

anId -

Throws:

java.lang.Exception

ContentModule

public ContentModule()

Construct a ContentModule.

Throws:

java.lang.Exception

Method Detail

getSupportedLinks

public java.util.Collection getSupportedLinks()
                                       throws java.lang.Exception

Return a collection of supported links. By default, the supported links is the same as the default links.

Returns:

Throws:

java.lang.Exception

getFeedbackHooks

public java.util.Collection getFeedbackHooks()

Override to return a collection of FeedbackHooks supported by this module.

Returns:

setSupportedLinks

public void setSupportedLinks(java.util.Collection collection)

Establish the collection of supported links.

Parameters:

collection -

generateDefaultLinks

public abstract java.util.Collection generateDefaultLinks()
                                                   throws java.lang.Exception

Returns a collection of ConfigurableLinks that the implementing module wishes to conribute the the main menu.

Returns:

Throws:

java.lang.Exception

getPermissions

public abstract java.util.Collection getPermissions()

Returns a collection of permissions which this module provides.

getModuleId

public abstract java.lang.String getModuleId()

Returns the ID for this module.

getModuleName

public abstract java.lang.String getModuleName()

Returns the name of this module.

getModuleDescription

public abstract java.lang.String getModuleDescription()

Returns the description for this module.

activate

public abstract void activate()
                       throws java.lang.Exception

Performs necessary steps to activates the module to the Roundhouse system. Called by Roundhouse during module activation.

Throws:

java.lang.Exception

searchModule

public abstract java.util.Collection searchModule(java.lang.String searchString)
                                           throws java.lang.Exception

Implementors should apply apply whatever logic necessary using the given search string and return a collection of SearchResult objects. Any data access based security filtering should be applied by the implementor.

Parameters:

searchString -

Returns:

Throws:

java.lang.Exception

getDelegate

public abstract ContentModuleDelegate getDelegate()
                                           throws java.lang.Exception

Return the ContentModuleDelgate object.

Throws:

java.lang.Exception

getAdminLinks

public abstract java.util.Collection getAdminLinks()
                                            throws java.lang.Exception

Should return a collection of ConfigurableLinks that the module would like added to the Core Module's tertiary menu and thus the system administration screen's tertiary menu.

Returns:

Throws:

java.lang.Exception

getPersonalizationLinks

public abstract java.util.Collection getPersonalizationLinks()
                                                      throws java.lang.Exception

Returns a collection of ConfigurableLinks that should be added to the tab strip when a user clicks the "MY ACCOUNT" or accountSettings link.

Returns:

Throws:

java.lang.Exception

getDeclaredContentTypes

public abstract java.util.Collection getDeclaredContentTypes()
                                                      throws java.lang.Exception

Returns a collection of ContentTypes declared by this module.

Returns:

Throws:

java.lang.Exception

getModuleTestSuite

public abstract Test getModuleTestSuite()

getTertiaryMenu

public java.util.Collection getTertiaryMenu()
                                     throws java.lang.Exception

Answer the default tertiary menu.

Returns:

Throws:

java.lang.Exception

setTertiaryMenu

public void setTertiaryMenu(java.util.Collection collection)

Establish the default tertiary menu.

getTertiaryMenu

public java.util.Collection getTertiaryMenu(java.lang.String context)
                                     throws java.lang.Exception

Answer the tertiary menu for the given context. If context is null or if the given context does not exist, return the default tertiary menu. A context allows a module to provide many different tertiary menus, each assigned to a unique context name.

Parameters:

context -

Returns:

Throws:

java.lang.Exception