org.pajes.db.entity
Class MaintenanceDisplayElement

java.lang.Object
  org.pajes.db.entity.MaintenanceDisplayElement

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

Lister, Viewer

public abstract class MaintenanceDisplayElement

extends java.lang.Object

implements java.lang.Cloneable

Abstract super-class of all classes that create a Paje to display an Entity object.

All sub-classes MUST have a no-parameter constructor.

Constructor Summary

MaintenanceDisplayElement()

Method Summary

java.lang.Object	clone() Creates and returns a copy of this object.
protected Manager	getManager() Returns the Manager.
protected javax.servlet.http.HttpServletRequest	getRequest() Returns the HttpServletRequest.
protected javax.servlet.ServletContext	getServletContext() Returns the ServletContext.
protected void	init() MaintenanceDisplayElement sub-class initialisation.
void	init(Manager manager, javax.servlet.ServletContext context) Initialises the MaintenanceDisplayElement.
boolean	isInitialised() Determines if the init(Manager, ServletContext) method has completed or not.
void	setRequest(javax.servlet.http.HttpServletRequest request) Sets the HttpServletRequest.

Methods inherited from class java.lang.Object

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

Constructor Detail

MaintenanceDisplayElement

public MaintenanceDisplayElement()

Method Detail

isInitialised

public boolean isInitialised()

Determines if the init(Manager, ServletContext) method has completed or not.

Returns:

true if this instance has been initialised.

setRequest

public void setRequest(javax.servlet.http.HttpServletRequest request)
                throws EntityNotFoundException,
                       java.io.IOException,
                       java.sql.SQLException

Sets the HttpServletRequest.

Parameters:

request - the request object.

Throws:

EntityNotFoundException - if the Entity to be edited does not exist.

java.io.IOException - if an IO exception occurs.

java.sql.SQLException - if an error occurs retrieving the Entity objects.

clone

public java.lang.Object clone()

Creates and returns a copy of this object.

Returns:

a shallow copy of this object.

init

public void init(Manager manager,
                 javax.servlet.ServletContext context)
          throws java.io.IOException

Initialises the MaintenanceDisplayElement.

Sub-classes should not over-ride this method. Instead, sub-classes should over-ride the init() method, which is called automatically by this method. If this method is over-rdden, the sub-class MUST call super.init(manager, context) to correctly iniitalise the viewer.

Parameters:

manager - the Manager.

context - the ServletContext.

Throws:

java.io.IOException - if an IO exception occurs.

getManager

protected Manager getManager()

Returns the Manager.

Returns:

the Manager.

getRequest

protected javax.servlet.http.HttpServletRequest getRequest()

Returns the HttpServletRequest.

Returns:

the HttpServletRequest.

getServletContext

protected javax.servlet.ServletContext getServletContext()

Returns the ServletContext.

Returns:

the ServletContext.

init

protected void init()
             throws java.io.IOException

MaintenanceDisplayElement sub-class initialisation.

Sub-classes should over-ride this method to iniitalise the element. The default implementation does nothing.

Throws:

java.io.IOException - if an IO exception occurs.