org.wandora.application.modulesserver

Interface ModulesWebApp

All Superinterfaces:

Module

All Known Implementing Classes:

AbstractTopicWebApp, AbstractWebApp, FNGAPIWebApp, GraphMLWebApp, IIIFWebApp, JTMWebApp, RDFWebApp, SameAsService, ScreenCastWebApp, ViewTopicWebApp, WaianaService, XTMWebApp

public interface ModulesWebApp
extends Module

An interface for modules that are web apps. A web app here means that the module is usable in a meaningful way from a normal web browser. The web app should have a name and usually also a start page of some kind. In addition, it may also have a page for each topic, however this isn't always the case.

Author:

olli

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAppName() Returns the name of the web app.
java.lang.String	getAppStartPage() Returns the URL for the start page of the web app.
java.lang.String	getAppTopicPage(java.lang.String si) Returns the URL representing the topic with the given subject identifier.

Methods inherited from interface org.wandora.modules.Module

getDependencies, init, isInitialized, isRunning, start, stop

Method Detail

getAppName

java.lang.String getAppName()

Returns the name of the web app.

Returns:

The name of the web app.

getAppStartPage

java.lang.String getAppStartPage()

Returns the URL for the start page of the web app. If the web app doesn't have a meaningful start page, return null instead.

Returns:

The start page of the web app.

getAppTopicPage

java.lang.String getAppTopicPage(java.lang.String si)

Returns the URL representing the topic with the given subject identifier. If there is no meaningful page for the topic, return null. This should not be dependent on whether the topic exists or not, the returned page should be the URL if the topic is assumed to exist.

Parameters:

si - The subject identifier of the topic.

Returns:

The URL of the page representing the topic.