org.dlese.dpc.suggest.action.form
Class SuggestResourceForm

java.lang.Object
  org.apache.struts.action.ActionForm
      org.dlese.dpc.suggest.action.form.SuggestForm
          org.dlese.dpc.suggest.action.form.SuggestResourceForm

All Implemented Interfaces:

Serializable

public class SuggestResourceForm
extends SuggestForm

ActionForm bean for handling requests that access a SuggestionRecord the QA DataBase and Records.

Version:

$Id: SuggestResourceForm.java,v 1.3 2009/03/20 23:34:00 jweather Exp $

Author:

ostwald

See Also:

Serialized Form

Field Summary

protected ValidatorResults

validatorResults NOT YET DOCUMENTED

Fields inherited from class org.dlese.dpc.suggest.action.form.SuggestForm

coppa, popup, schemaHelper, vocab

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

multipartRequestHandler, servlet

Constructor Summary

SuggestResourceForm()
Constructor

Method Summary

void	clear() resets the bean's key attributes
String	getDescription() Gets the description attribute of the SuggestResourceForm object
DupSim	getDupRecord() Gets the dupRecord attribute of the SuggestResourceForm object
String	getDupRecordId() Gets the dupRecordId attribute of the SuggestResourceForm object
String	getEmailPrimary() Gets the emailPrimary attribute of the SuggestResourceForm object
String[]	getGradeRangeChoices() Grabs the collection keys from the DPC keys schema.
String[]	getGradeRangeChoicesSystemKeys() Gets the gradeRangeChoicesSystemKeys attribute of the SuggestResourceForm object
org.apache.struts.util.LabelValueBean[]	getGradeRangeOptions() Create a LabelValueBean array holding the gradeRangeChoices and Labels
String[]	getGradeRanges() Gets the gradeRanges attribute of the SuggestResourceForm object
String	getGradeRangesDisplay() Gets a displayable version of the selected gradeRanges
String[]	getGradeRangesKeys() Gets the gradeRangesKeys attribute of the SuggestResourceForm object
String	getInstName() Gets the instName attribute of the SuggestResourceForm object
String	getNameFirst() Gets the nameFirst attribute of the SuggestResourceForm object
String	getNameLast() Gets the nameLast attribute of the SuggestResourceForm object
boolean	getPreserveGradeRanges() Gets the preserveGradeRanges attribute of the SuggestResourceForm object
String	getTitle() Gets the title attribute of the SuggestResourceForm object
String	getUrl() Gets the url attribute of the SuggestResourceForm object
ValidatorResults	getValidatorResults() Gets the validatorResults attribute of the SuggestForm object
protected void	prtln(String s) Output a line of text to standard out, with datestamp, if debug is set to true.
void	reset(org.apache.struts.action.ActionMapping mapping, HttpServletRequest request) We need this method to allow gradeRange to be zero'd out as a multibox.
static void	setDebug(boolean db) Sets the debug attribute of the SuggestResourceForm object
void	setDescription(String val) Sets the description attribute of the SuggestResourceForm object
void	setEmailPrimary(String val) Sets the emailPrimary attribute of the SuggestResourceForm object
void	setGradeRanges(String[] vals) Sets the gradeRanges attribute of the SuggestResourceForm object
void	setInstName(String val) Sets the instName attribute of the SuggestResourceForm object
void	setNameFirst(String val) Sets the nameFirst attribute of the SuggestResourceForm object
void	setNameLast(String val) Sets the nameLast attribute of the SuggestResourceForm object
void	setPreserveGradeRanges(boolean val) Sets the preserveGradeRanges attribute of the SuggestResourceForm object
void	setTitle(String val) Sets the title attribute of the SuggestResourceForm object
void	setUrl(String val) Sets the url attribute of the SuggestResourceForm object
void	setValidatorResults(ValidatorResults results) Sets the validatorResults attribute of the SuggestForm object
String	toString() Print selected fields of this object for debugging purposes

Methods inherited from class org.dlese.dpc.suggest.action.form.SuggestForm

getCoppa, getPopup, setCoppa, setPopup, setSchemaHelper, setVocab

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

getMultipartRequestHandler, getServlet, getServletWrapper, reset, setMultipartRequestHandler, setServlet, validate, validate

Methods inherited from class java.lang.Object

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

Field Detail

validatorResults

protected ValidatorResults validatorResults

NOT YET DOCUMENTED

Constructor Detail

SuggestResourceForm

public SuggestResourceForm()

Constructor

Method Detail

reset

public void reset(org.apache.struts.action.ActionMapping mapping,
                  HttpServletRequest request)

We need this method to allow gradeRange to be zero'd out as a multibox. But we also need the preserveGradeRanges to protect from a reset to support the edit/display/re-edit cycle. preserveGradeRanges is set in SuggestResourceAction.

Overrides:

reset in class SuggestForm

Parameters:

mapping - Description of the Parameter

request - Description of the Parameter

clear

public void clear()

resets the bean's key attributes

Overrides:

clear in class SuggestForm

getValidatorResults

public ValidatorResults getValidatorResults()

Gets the validatorResults attribute of the SuggestForm object

Returns:

The validatorResults value

setValidatorResults

public void setValidatorResults(ValidatorResults results)

Sets the validatorResults attribute of the SuggestForm object

Parameters:

results - The new validatorResults value

getDupRecord

public DupSim getDupRecord()

Gets the dupRecord attribute of the SuggestResourceForm object

Returns:

The dupRecord value

getDupRecordId

public String getDupRecordId()

Gets the dupRecordId attribute of the SuggestResourceForm object

Returns:

The dupRecordId value

getTitle

public String getTitle()

Gets the title attribute of the SuggestResourceForm object

Returns:

The title value

setTitle

public void setTitle(String val)

Sets the title attribute of the SuggestResourceForm object

Parameters:

val - The new title value

getUrl

public String getUrl()

Gets the url attribute of the SuggestResourceForm object

Returns:

The url value

setUrl

public void setUrl(String val)

Sets the url attribute of the SuggestResourceForm object

Parameters:

val - The new url value

getDescription

public String getDescription()

Gets the description attribute of the SuggestResourceForm object

Returns:

The description value

setDescription

public void setDescription(String val)

Sets the description attribute of the SuggestResourceForm object

Parameters:

val - The new description value

setPreserveGradeRanges

public void setPreserveGradeRanges(boolean val)

Sets the preserveGradeRanges attribute of the SuggestResourceForm object

Parameters:

val - The new preserveGradeRanges value

getPreserveGradeRanges

public boolean getPreserveGradeRanges()

Gets the preserveGradeRanges attribute of the SuggestResourceForm object

Returns:

The preserveGradeRanges value

getGradeRangesDisplay

public String getGradeRangesDisplay()
                             throws Exception

Gets a displayable version of the selected gradeRanges

Returns:

The gradeRangesDisplay value

Throws:

Exception - Description of the Exception

getGradeRanges

public String[] getGradeRanges()

Gets the gradeRanges attribute of the SuggestResourceForm object

Returns:

The gradeRanges value

getGradeRangesKeys

public String[] getGradeRangesKeys()

Gets the gradeRangesKeys attribute of the SuggestResourceForm object

Returns:

The gradeRangesKeys value

setGradeRanges

public void setGradeRanges(String[] vals)

Sets the gradeRanges attribute of the SuggestResourceForm object

Parameters:

vals - The new gradeRanges value

getNameFirst

public String getNameFirst()

Gets the nameFirst attribute of the SuggestResourceForm object

Returns:

The nameFirst value

setNameFirst

public void setNameFirst(String val)

Sets the nameFirst attribute of the SuggestResourceForm object

Parameters:

val - The new nameFirst value

getNameLast

public String getNameLast()

Gets the nameLast attribute of the SuggestResourceForm object

Returns:

The nameLast value

setNameLast

public void setNameLast(String val)

Sets the nameLast attribute of the SuggestResourceForm object

Parameters:

val - The new nameLast value

getEmailPrimary

public String getEmailPrimary()

Gets the emailPrimary attribute of the SuggestResourceForm object

Returns:

The emailPrimary value

setEmailPrimary

public void setEmailPrimary(String val)

Sets the emailPrimary attribute of the SuggestResourceForm object

Parameters:

val - The new emailPrimary value

getInstName

public String getInstName()

Gets the instName attribute of the SuggestResourceForm object

Returns:

The instName value

setInstName

public void setInstName(String val)

Sets the instName attribute of the SuggestResourceForm object

Parameters:

val - The new instName value

getGradeRangeOptions

public org.apache.struts.util.LabelValueBean[] getGradeRangeOptions()

Create a LabelValueBean array holding the gradeRangeChoices and Labels

Returns:

The gradeRangeOptions value

getGradeRangeChoices

public String[] getGradeRangeChoices()

Grabs the collection keys from the DPC keys schema. Why couldn't we simply specify the DataType spec and have the values by retrieved automatically?

Returns:

A list of valid colleciton keys.

getGradeRangeChoicesSystemKeys

public String[] getGradeRangeChoicesSystemKeys()

Gets the gradeRangeChoicesSystemKeys attribute of the SuggestResourceForm object

Returns:

The gradeRangeChoicesSystemKeys value

toString

public String toString()

Print selected fields of this object for debugging purposes

Overrides:

toString in class Object

Returns:

String

setDebug

public static void setDebug(boolean db)

Sets the debug attribute of the SuggestResourceForm object

Parameters:

db - The new debug value

prtln

protected final void prtln(String s)

Output a line of text to standard out, with datestamp, if debug is set to true.

Parameters:

s - The String that will be output.