org.dlese.dpc.services.dcs.action.form

Class RecommenderForm

java.lang.Object

org.apache.struts.action.ActionForm

org.dlese.dpc.services.dcs.action.form.RecommenderForm

All Implemented Interfaces:

java.io.Serializable

public class RecommenderForm
extends org.apache.struts.action.ActionForm
implements java.io.Serializable

A ActionForm bean that holds data for DDS web services and has access to vocab info.

Author:

John Weatherley

See Also:

DDSServicesAction, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	RecommenderForm.DateLabelPair

Field Summary

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

multipartRequestHandler, servlet

Constructor Summary

Constructors

Constructor and Description
RecommenderForm() Constructor for the RepositoryForm object

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAuthorizedFor() Gets the role name for which this user is authorized
java.lang.String	getCollection()
protected static java.lang.String	getDs() Return a string for the current time and date, sutiable for display in log files and output to standout:
java.util.List	getErrorList()
java.lang.String	getErrorMsg() Gets the errorMsg attribute of the RecommenderForm object
java.lang.String	getId()
java.lang.String	getLocalizedRecordXml() Gets the localizedRecordXml attribute of the RecommenderForm object
int	getN() Gets the n attribute of the RecommenderForm object
int	getNumResults() Gets the number of matching results.
java.lang.String	getRecordFormat() Gets the recordFormat attribute of the RecommenderForm object
java.lang.String	getRecordXml() Gets the recordXml attribute of the RecommenderForm object
ResultDocList	getResults() Gets the results attribute of the RecommenderForm object
int	getS() Gets the s attribute of the RecommenderForm object
java.lang.String[]	getStatuses()
java.util.List	getStatusLabels()
java.util.List	getUtcDates() A list of UTC dates in the past in the following order: one minute, one hour, one day, one week, one month, one year.
java.lang.String	getXmlFormat()
java.util.List	getXmlFormats()
protected void	prtln(java.lang.String s) Output a line of text to standard out, with datestamp, if debug is set to true.
protected void	prtlnErr(java.lang.String s) Output a line of text to error out, with datestamp.
void	setAuthorizedFor(java.lang.String val) Sets the role name for which this user is authorized
void	setCollection(java.lang.String collection)
static void	setDebug(boolean isDebugOuput) Sets the debug attribute
void	setErrorList(java.util.List errorList)
void	setErrorMsg(java.lang.String errorMsg) Sets the errorMsg attribute of the RecommenderForm object
void	setId(java.lang.String id)
void	setN(int val) Sets the n attribute of the RecommenderForm object
void	setRecordFormat(java.lang.String val) Sets the recordFormat attribute of the RecommenderForm object
void	setRecordXml(java.lang.String val) Sets the recordXml attribute of the RecommenderForm object
void	setResults(ResultDocList results) Sets the results attribute of the RecommenderForm object
void	setS(int val) Sets the s attribute of the RecommenderForm object
void	setStatuses(java.lang.String[] statusValues)
void	setStatusLabels(java.util.List labels)
void	setXmlFormat(java.lang.String xmlFormat)
void	setXmlFormats(java.util.List var)

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

RecommenderForm

public RecommenderForm()

Constructor for the RepositoryForm object

Method Detail

getId

public java.lang.String getId()

setId

public void setId(java.lang.String id)

getCollection

public java.lang.String getCollection()

setCollection

public void setCollection(java.lang.String collection)

getXmlFormat

public java.lang.String getXmlFormat()

setXmlFormat

public void setXmlFormat(java.lang.String xmlFormat)

getStatuses

public java.lang.String[] getStatuses()

setStatuses

public void setStatuses(java.lang.String[] statusValues)

getStatusLabels

public java.util.List getStatusLabels()

setStatusLabels

public void setStatusLabels(java.util.List labels)

setErrorList

public void setErrorList(java.util.List errorList)

getErrorList

public java.util.List getErrorList()

getXmlFormats

public java.util.List getXmlFormats()

setXmlFormats

public void setXmlFormats(java.util.List var)

getLocalizedRecordXml

public java.lang.String getLocalizedRecordXml()

Gets the localizedRecordXml attribute of the RecommenderForm object

Returns:

The localizedRecordXml value

getRecordXml

public java.lang.String getRecordXml()

Gets the recordXml attribute of the RecommenderForm object

Returns:

The recordXml value

setRecordXml

public void setRecordXml(java.lang.String val)

Sets the recordXml attribute of the RecommenderForm object

Parameters:

val - The new recordXml value

setRecordFormat

public void setRecordFormat(java.lang.String val)

Sets the recordFormat attribute of the RecommenderForm object

Parameters:

val - The new recordFormat value

getRecordFormat

public java.lang.String getRecordFormat()

Gets the recordFormat attribute of the RecommenderForm object

Returns:

The recordFormat value

getS

public int getS()

Gets the s attribute of the RecommenderForm object

Returns:

The s value

setS

public void setS(int val)

Sets the s attribute of the RecommenderForm object

Parameters:

val - The new s value

getN

public int getN()

Gets the n attribute of the RecommenderForm object

Returns:

The n value

setN

public void setN(int val)

Sets the n attribute of the RecommenderForm object

Parameters:

val - The new n value

getAuthorizedFor

public java.lang.String getAuthorizedFor()

Gets the role name for which this user is authorized

Returns:

The authorizedFor value

setAuthorizedFor

public void setAuthorizedFor(java.lang.String val)

Sets the role name for which this user is authorized

Parameters:

val - The new authorizedFor value

setErrorMsg

public void setErrorMsg(java.lang.String errorMsg)

Sets the errorMsg attribute of the RecommenderForm object

Parameters:

errorMsg - The new errorMsg value

getErrorMsg

public java.lang.String getErrorMsg()

Gets the errorMsg attribute of the RecommenderForm object

Returns:

The errorMsg value

getResults

public ResultDocList getResults()

Gets the results attribute of the RecommenderForm object

Returns:

The results value

setResults

public void setResults(ResultDocList results)

Sets the results attribute of the RecommenderForm object

Parameters:

results - The new results value

getNumResults

public int getNumResults()

Gets the number of matching results.

Returns:

The numResults value

getUtcDates

public java.util.List getUtcDates()

A list of UTC dates in the past in the following order: one minute, one hour, one day, one week, one month, one year.

Returns:

A list of UTC dates in the past.

getDs

protected static final java.lang.String getDs()

Return a string for the current time and date, sutiable for display in log files and output to standout:

Returns:

The dateStamp value

prtlnErr

protected final void prtlnErr(java.lang.String s)

Output a line of text to error out, with datestamp.

Parameters:

s - The text that will be output to error out.

prtln

protected final void prtln(java.lang.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.

setDebug

public static void setDebug(boolean isDebugOuput)

Sets the debug attribute

Parameters:

isDebugOuput - The new debug value