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

java.lang.Object
  org.apache.struts.action.ActionForm
      org.dlese.dpc.dds.action.form.VocabForm
          org.dlese.dpc.services.dcs.action.form.DCSServicesForm

All Implemented Interfaces:

Serializable

public class DCSServicesForm
extends VocabForm
implements Serializable

An ActionForm bean that holds data for DCS web services.

See Also:

DCSServicesAction, Serialized Form

Nested Class Summary

class

DCSServicesForm.DateLabelPair NOT YET DOCUMENTED

Field Summary

Fields inherited from class org.dlese.dpc.dds.action.form.VocabForm

audience, field, language, metaFormat, value, vocab

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

multipartRequestHandler, servlet

Constructor Summary

DCSServicesForm()
Constructor for the RepositoryForm object

Method Summary

String	getAuthorizedFor() Gets the role name for which this user is authorized
String	getCollection() Gets the collection attribute of the DCSServicesForm object
String[]	getCollections()
protected static String	getDs() Return a string for the current time and date, sutiable for display in log files and output to standout:
List	getErrorList() Gets the errorList attribute of the DCSServicesForm object
String	getErrorMsg() Gets the errorMsg attribute of the DCSServicesForm object
String	getExportDir() Gets the exportDir attribute of the DCSServicesForm object
String	getId() Gets the id attribute of the DCSServicesForm object
String	getLocalizedRecordXml() Gets the localizedRecordXml attribute of the DCSServicesForm object
int	getN() Gets the n attribute of the DCSServicesForm object
int	getNumResults() Gets the number of matching results.
String	getRecordFormat() Gets the recordFormat attribute of the DCSServicesForm object
String	getRecordXml() Gets the recordXml attribute of the DCSServicesForm object
ResultDocList	getResults() Gets the results attribute of the DCSServicesForm object
int	getS() Gets the s attribute of the DCSServicesForm object
String	getStatusEntry()
String[]	getStatuses() Gets the statuses attribute of the DCSServicesForm object
List	getStatusLabels() Gets the statusLabels attribute of the DCSServicesForm object
String	getUrl()
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.
String	getXmlFormat() Gets the xmlFormat attribute of the DCSServicesForm object
List	getXmlFormats() Gets the xmlFormats attribute of the DCSServicesForm object
protected void	prtln(String s) Output a line of text to standard out, with datestamp, if debug is set to true.
protected void	prtlnErr(String s) Output a line of text to error out, with datestamp.
void	setAuthorizedFor(String val) Sets the role name for which this user is authorized
void	setCollection(String collection) Sets the collection attribute of the DCSServicesForm object
void	setCollections(String[] collections)
static void	setDebug(boolean isDebugOuput) Sets the debug attribute
void	setErrorList(List errorList) Sets the errorList attribute of the DCSServicesForm object
void	setErrorMsg(String errorMsg) Sets the errorMsg attribute of the DCSServicesForm object
void	setExportDir(String dir) Sets the exportDir attribute of the DCSServicesForm object
void	setId(String id) Sets the id attribute of the DCSServicesForm object
void	setN(int val) Sets the n attribute of the DCSServicesForm object
void	setRecordFormat(String val) Sets the recordFormat attribute of the DCSServicesForm object
void	setRecordXml(String val) Sets the recordXml attribute of the DCSServicesForm object
void	setResults(ResultDocList results) Sets the results attribute of the DCSServicesForm object
void	setS(int val) Sets the s attribute of the DCSServicesForm object
void	setStatusEntry(String entry)
void	setStatuses(String[] statusValues) Sets the statuses attribute of the DCSServicesForm object
void	setStatusLabels(List labels) Sets the statusLabels attribute of the DCSServicesForm object
void	setUrl(String url)
void	setXmlFormat(String xmlFormat) Sets the xmlFormat attribute of the DCSServicesForm object
void	setXmlFormats(List var) Sets the xmlFormats attribute of the DCSServicesForm object

Methods inherited from class org.dlese.dpc.dds.action.form.VocabForm

getAudience, getField, getFieldId, getFieldLabel, getIsVocabTermAvailable, getLanguage, getVocab, getVocabList, getVocabList, getVocabTerm, setField, setField, setMetaFormat, setValue, setVocab, setVocabInterface

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

DCSServicesForm

public DCSServicesForm()

Constructor for the RepositoryForm object

Method Detail

getId

public String getId()

Gets the id attribute of the DCSServicesForm object

Returns:

The id value

setId

public void setId(String id)

Sets the id attribute of the DCSServicesForm object

Parameters:

id - The new id value

getUrl

public String getUrl()

setUrl

public void setUrl(String url)

getCollections

public String[] getCollections()

setCollections

public void setCollections(String[] collections)

getCollection

public String getCollection()

Gets the collection attribute of the DCSServicesForm object

Returns:

The collection value

setCollection

public void setCollection(String collection)

Sets the collection attribute of the DCSServicesForm object

Parameters:

collection - The new collection value

getXmlFormat

public String getXmlFormat()

Gets the xmlFormat attribute of the DCSServicesForm object

Returns:

The xmlFormat value

setXmlFormat

public void setXmlFormat(String xmlFormat)

Sets the xmlFormat attribute of the DCSServicesForm object

Parameters:

xmlFormat - The new xmlFormat value

getStatuses

public String[] getStatuses()

Gets the statuses attribute of the DCSServicesForm object

Returns:

The statuses value

setStatuses

public void setStatuses(String[] statusValues)

Sets the statuses attribute of the DCSServicesForm object

Parameters:

statusValues - The new statuses value

getStatusLabels

public List getStatusLabels()

Gets the statusLabels attribute of the DCSServicesForm object

Returns:

The statusLabels value

setStatusLabels

public void setStatusLabels(List labels)

Sets the statusLabels attribute of the DCSServicesForm object

Parameters:

labels - The new statusLabels value

getStatusEntry

public String getStatusEntry()

setStatusEntry

public void setStatusEntry(String entry)

getExportDir

public String getExportDir()

Gets the exportDir attribute of the DCSServicesForm object

Returns:

The exportDir value

setExportDir

public void setExportDir(String dir)

Sets the exportDir attribute of the DCSServicesForm object

Parameters:

dir - The new exportDir value

setErrorList

public void setErrorList(List errorList)

Sets the errorList attribute of the DCSServicesForm object

Parameters:

errorList - The new errorList value

getErrorList

public List getErrorList()

Gets the errorList attribute of the DCSServicesForm object

Returns:

The errorList value

getXmlFormats

public List getXmlFormats()

Gets the xmlFormats attribute of the DCSServicesForm object

Returns:

The xmlFormats value

setXmlFormats

public void setXmlFormats(List var)

Sets the xmlFormats attribute of the DCSServicesForm object

Parameters:

var - The new xmlFormats value

getLocalizedRecordXml

public String getLocalizedRecordXml()

Gets the localizedRecordXml attribute of the DCSServicesForm object

Returns:

The localizedRecordXml value

getRecordXml

public String getRecordXml()

Gets the recordXml attribute of the DCSServicesForm object

Returns:

The recordXml value

setRecordXml

public void setRecordXml(String val)

Sets the recordXml attribute of the DCSServicesForm object

Parameters:

val - The new recordXml value

setRecordFormat

public void setRecordFormat(String val)

Sets the recordFormat attribute of the DCSServicesForm object

Parameters:

val - The new recordFormat value

getRecordFormat

public String getRecordFormat()

Gets the recordFormat attribute of the DCSServicesForm object

Returns:

The recordFormat value

getS

public int getS()

Gets the s attribute of the DCSServicesForm object

Returns:

The s value

setS

public void setS(int val)

Sets the s attribute of the DCSServicesForm object

Parameters:

val - The new s value

getN

public int getN()

Gets the n attribute of the DCSServicesForm object

Returns:

The n value

setN

public void setN(int val)

Sets the n attribute of the DCSServicesForm object

Parameters:

val - The new n value

getAuthorizedFor

public String getAuthorizedFor()

Gets the role name for which this user is authorized

Returns:

The authorizedFor value

setAuthorizedFor

public void setAuthorizedFor(String val)

Sets the role name for which this user is authorized

Parameters:

val - The new authorizedFor value

setErrorMsg

public void setErrorMsg(String errorMsg)

Sets the errorMsg attribute of the DCSServicesForm object

Parameters:

errorMsg - The new errorMsg value

getErrorMsg

public String getErrorMsg()

Gets the errorMsg attribute of the DCSServicesForm object

Returns:

The errorMsg value

getResults

public ResultDocList getResults()

Gets the results attribute of the DCSServicesForm object

Returns:

The results value

setResults

public void setResults(ResultDocList results)

Sets the results attribute of the DCSServicesForm object

Parameters:

results - The new results value

getNumResults

public int getNumResults()

Gets the number of matching results.

Returns:

The numResults value

getUtcDates

public 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 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(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(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