org.xngr
Interface Service

All Known Subinterfaces:

DirectoryService, DocumentService, FileService, NodeService, URIService

public interface Service

The representation of a service in the system. Services implementations should extend this class and implement the relevant methods for this class. This interface is not intended to be implemented directly.

Version:

$Revision: 51 $, $Date: 2009-03-24 22:37:03 +0000 (Tue, 24 Mar 2009) $

Author:

Edwin Dankert

Method Summary

boolean	close() Closes the service, this method is called by the 'browser application' when the user wants to exit the application.
java.lang.String	getDescription() The description is normally used to provide more information for the service or the nature of the service, this information is generally not readily available but will appear after a user-action, like moving the mouse over a representation of the document, for instance as a tool-tip
javax.swing.Icon	getIcon() The icon is used to visually identify the service.
java.lang.String	getIdentifier()
java.lang.String	getName() The name is normally used to identify the service.

Method Detail

getIdentifier

java.lang.String getIdentifier()

Returns:

a unique identifier for the service.

getIcon

javax.swing.Icon getIcon()

The icon is used to visually identify the service.

Returns:

the icon for the service.

getName

java.lang.String getName()

The name is normally used to identify the service.

Returns:

a name for the service.

getDescription

java.lang.String getDescription()

The description is normally used to provide more information for the service or the nature of the service, this information is generally not readily available but will appear after a user-action, like moving the mouse over a representation of the document, for instance as a tool-tip

Returns:

the description for the service.

close

boolean close()

Closes the service, this method is called by the 'browser application' when the user wants to exit the application. This can be used to save any data still 'un'saved and to close all open frames.

Returns:

false when the 'browser application' should stop its exit process, because this service cannot be closed yet. Note: The browser, in some cases, might not be able to stop the exit process!