org.jwaf.action
Class UserAction

java.lang.Object
  |
  +--org.apache.struts.action.Action
        |
        +--org.jwaf.action.UserAction

Direct Known Subclasses:

AddBusinessObjectAction, DeleteBusinessObjectAction, UpdateBusinessObjectAction, ViewBusinessObjectAction, ViewBusinessObjectCollectionAction

public abstract class UserAction

extends org.apache.struts.action.Action

An abstract user action for servicing user activity related business logic. It extends Sturts Action

Field Summary

protected org.apache.struts.action.ActionForm	form
protected org.apache.struts.action.ActionMapping	mapping
protected javax.servlet.http.HttpServletRequest	request
protected javax.servlet.http.HttpServletResponse	response
protected javax.servlet.http.HttpSession	session

Fields inherited from class org.apache.struts.action.Action

DATA_SOURCE_KEY, defaultLocale, ERROR_KEY, EXCEPTION_KEY, FORM_BEANS_KEY, FORWARDS_KEY, LOCALE_KEY, MAPPING_KEY, MAPPINGS_KEY, MESSAGES_KEY, MULTIPART_KEY, servlet, SERVLET_KEY, TRANSACTION_TOKEN_KEY

Constructor Summary

UserAction()

Method Summary

org.apache.struts.action.ActionForward	getActionForward() Get the default action.
java.lang.String	getAttribute() Returns the attribute to be used for the business object
BusinessObject	getBusinessObject() Get the business object this action is related to.
java.lang.Integer	getIntegerKey() Get the id parameter as an Integer primary key
abstract void	perform() Perform the main business logic
org.apache.struts.action.ActionForward	perform(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Final abstraction of Stuts action.
void	setBusinessObject(BusinessObject businessObject) Sets the business object to the parameter.
void	setCollection(BusinessObjectCollection collection)
void	setCollectionVector(BusinessObjectCollection collection)
void	setExtraBusinessObject(java.lang.String attribute, BusinessObject businessObject) Sets extra business objects for the JSP to use as beans

Methods inherited from class org.apache.struts.action.Action

generateToken, getLocale, getResources, getServlet, isCancelled, isTokenValid, perform, perform, perform, resetToken, saveErrors, saveToken, setLocale, setServlet, toHex

Methods inherited from class java.lang.Object

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

Field Detail

mapping

protected org.apache.struts.action.ActionMapping mapping

form

protected org.apache.struts.action.ActionForm form

request

protected javax.servlet.http.HttpServletRequest request

response

protected javax.servlet.http.HttpServletResponse response

session

protected javax.servlet.http.HttpSession session

Constructor Detail

UserAction

public UserAction()

Method Detail

perform

public final org.apache.struts.action.ActionForward perform(org.apache.struts.action.ActionMapping mapping,
                                                            org.apache.struts.action.ActionForm form,
                                                            javax.servlet.http.HttpServletRequest request,
                                                            javax.servlet.http.HttpServletResponse response)

Final abstraction of Stuts action.

Overrides:

perform in class org.apache.struts.action.Action

Parameters:

mapping - Struts action mapping

form - Struts action form

request - Servlet request

response - Servlet response

Returns:

A Struts action forward

See Also:

perform method

perform

public abstract void perform()

Perform the main business logic

getBusinessObject

public BusinessObject getBusinessObject()

Get the business object this action is related to.

Returns:

Return an abstract business object.

setExtraBusinessObject

public void setExtraBusinessObject(java.lang.String attribute,
                                   BusinessObject businessObject)

Sets extra business objects for the JSP to use as beans

Parameters:

businessObject - A business object.

setBusinessObject

public void setBusinessObject(BusinessObject businessObject)

Sets the business object to the parameter.

Parameters:

businessObject - A business object.

getIntegerKey

public java.lang.Integer getIntegerKey()

Get the id parameter as an Integer primary key

Returns:

An Integer primary key

getActionForward

public org.apache.struts.action.ActionForward getActionForward()

Get the default action. Considers the operation.

Returns:

Struts action forward

getAttribute

public java.lang.String getAttribute()

Returns the attribute to be used for the business object

Returns:

A String with name of attribute to be used

setCollection

public void setCollection(BusinessObjectCollection collection)

setCollectionVector

public void setCollectionVector(BusinessObjectCollection collection)