org.dlese.dpc.schemedit.action

Class CreateRecordAction

java.lang.Object

org.apache.struts.action.Action

org.dlese.dpc.schemedit.action.DCSAction

org.dlese.dpc.schemedit.action.CreateRecordAction

Direct Known Subclasses:

CreateADNRecordAction

public abstract class CreateRecordAction
extends DCSAction

A Struts Action controlling interaction during creation of metadata records for frameworks that require an initial data-entry screen before entering the metadata editor. For example, in the ADN framework, a url must first be checked for uniqueness before a record is created.

Author:

Jonathan Ostwald

Field Summary

Fields inherited from class org.dlese.dpc.schemedit.action.DCSAction

accessManager, collectionRegistry, dcsDataManager, frameworkRegistry, ndrServiceEnabled, repositoryManager, repositoryService, requiredRole, sessionRegistry, userManager

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

defaultLocale, servlet

Constructor Summary

Constructors

Constructor and Description
CreateRecordAction()

Method Summary

Modifier and Type	Method and Description
org.apache.struts.action.ActionForward	execute(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Processes the specified HTTP request and creates the corresponding HTTP response by forwarding to a JSP that will create it.
protected abstract org.apache.struts.action.ActionForward	getConfirmForward(org.apache.struts.action.ActionMapping mapping, CreateADNRecordForm carForm, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Gets the confirmForward attribute of the CreateRecordAction object
protected abstract org.apache.struts.action.ActionForward	getCreateForward(org.apache.struts.action.ActionMapping mapping) Gets the createForward attribute of the CreateRecordAction object
protected abstract java.lang.String	getXmlFormat() Gets the xmlFormat attribute of the CreateRecordAction object
protected org.apache.struts.action.ActionForward	handleSubmit(CreateADNRecordForm carForm, MetaDataFramework framework, org.apache.struts.action.ActionMapping mapping, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) NOT YET DOCUMENTED
protected abstract org.dom4j.Document	makeRecordDoc(CreateADNRecordForm carForm, MetaDataFramework framework, org.apache.struts.action.ActionMapping mapping, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Create an empty collection metadata document and populate from ActionForm (carForm).
static void	setDebug(boolean isDebugOutput) Sets the debug attribute of the CreateRecordAction class
protected abstract org.apache.struts.action.ActionErrors	validateForm(javax.servlet.http.HttpServletRequest request, CreateADNRecordForm carForm, MetaDataFramework framework) Validate the input from user.

Methods inherited from class org.dlese.dpc.schemedit.action.DCSAction

getMetaDataFramework, getRequiredContextAttributeValue, getSessionBean, getSessionUser, getSessionUser, getSessionUserName, initializeFromContext

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

addErrors, addMessages, execute, generateToken, getDataSource, getDataSource, getErrors, getLocale, getMessages, getResources, getResources, getServlet, isCancelled, isTokenValid, isTokenValid, resetToken, saveErrors, saveErrors, saveErrors, saveMessages, saveMessages, saveToken, setLocale, setServlet

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateRecordAction

public CreateRecordAction()

Method Detail

getXmlFormat

protected abstract java.lang.String getXmlFormat()

Gets the xmlFormat attribute of the CreateRecordAction object

Returns:

The xmlFormat value

getCreateForward

protected abstract org.apache.struts.action.ActionForward getCreateForward(org.apache.struts.action.ActionMapping mapping)

Gets the createForward attribute of the CreateRecordAction object

Parameters:

mapping - NOT YET DOCUMENTED

Returns:

The createForward value

getConfirmForward

protected abstract org.apache.struts.action.ActionForward getConfirmForward(org.apache.struts.action.ActionMapping mapping,
                                                                            CreateADNRecordForm carForm,
                                                                            javax.servlet.http.HttpServletRequest request,
                                                                            javax.servlet.http.HttpServletResponse response)

Gets the confirmForward attribute of the CreateRecordAction object

Parameters:

mapping - NOT YET DOCUMENTED

carForm - NOT YET DOCUMENTED

request - NOT YET DOCUMENTED

response - NOT YET DOCUMENTED

Returns:

The confirmForward value

execute

public org.apache.struts.action.ActionForward execute(org.apache.struts.action.ActionMapping mapping,
                                                      org.apache.struts.action.ActionForm form,
                                                      javax.servlet.http.HttpServletRequest request,
                                                      javax.servlet.http.HttpServletResponse response)
                                               throws java.io.IOException,
                                                      javax.servlet.ServletException

Processes the specified HTTP request and creates the corresponding HTTP response by forwarding to a JSP that will create it. Returns an ActionForward instance that maps to a Struts forwarding name, which must be configured in struts-config.xml to forward to the JSP page that will handle the request.

Overrides:

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

Parameters:

mapping - The ActionMapping used to select this instance

request - The HTTP request we are processing

response - The HTTP response we are creating

form - The ActionForm for the given page

Returns:

The ActionForward instance describing where and how control should be forwarded

Throws:

java.io.IOException - if an input/output error occurs

javax.servlet.ServletException - if a servlet exception occurs

handleSubmit

protected org.apache.struts.action.ActionForward handleSubmit(CreateADNRecordForm carForm,
                                                              MetaDataFramework framework,
                                                              org.apache.struts.action.ActionMapping mapping,
                                                              javax.servlet.http.HttpServletRequest request,
                                                              javax.servlet.http.HttpServletResponse response)

NOT YET DOCUMENTED

Parameters:

carForm - NOT YET DOCUMENTED

framework - NOT YET DOCUMENTED

mapping - NOT YET DOCUMENTED

request - NOT YET DOCUMENTED

response - NOT YET DOCUMENTED

Returns:

NOT YET DOCUMENTED

makeRecordDoc

protected abstract org.dom4j.Document makeRecordDoc(CreateADNRecordForm carForm,
                                                    MetaDataFramework framework,
                                                    org.apache.struts.action.ActionMapping mapping,
                                                    javax.servlet.http.HttpServletRequest request,
                                                    javax.servlet.http.HttpServletResponse response)
                                             throws java.lang.Exception

Create an empty collection metadata document and populate from ActionForm (carForm). Passes any error information back as an ActionError -used, for example, when a webservice response contains an error that we want to propagate back up to the user.

Parameters:

carForm - the ActionForm

framework - the MetaDataFramework of the record being created

Returns:

Description of the Return Value

Throws:

java.lang.Exception - Description of the Exception

validateForm

protected abstract org.apache.struts.action.ActionErrors validateForm(javax.servlet.http.HttpServletRequest request,
                                                                      CreateADNRecordForm carForm,
                                                                      MetaDataFramework framework)

Validate the input from user. Put changed or default values into carForm. After this method returns carForm (rather than request) is used to process user input.

Parameters:

request - the Request

carForm - the ActionForm

framework - the MetaDataFramework of the record being created

Returns:

Description of the Return Value

setDebug

public static void setDebug(boolean isDebugOutput)

Sets the debug attribute of the CreateRecordAction class

Parameters:

isDebugOutput - The new debug value