DLESE Tools
v1.6.0

org.dlese.dpc.services.dds.action.form
Class DDSServicesForm

java.lang.Object
  extended by org.apache.struts.action.ActionForm
      extended by org.dlese.dpc.dds.action.form.VocabForm
          extended by org.dlese.dpc.services.dds.action.form.DDSServicesForm
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
DDSServicesForm_1_1

public class DDSServicesForm
extends VocabForm
implements 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
 class DDSServicesForm.DateLabelPair
          NOT YET DOCUMENTED
 
Field Summary
static String ERROR_CODE_BADARGUMENT
           
static String ERROR_CODE_BADQUERY
           
static String ERROR_CODE_BADVERB
           
static String ERROR_CODE_CANNOTDISSEMINATEFORMAT
           
static String ERROR_CODE_IDDOESNOTEXIST
           
static String ERROR_CODE_INTERNALSERVERERROR
           
static String ERROR_CODE_NORECORDSMATCH
           
static String ERROR_CODE_NOTAUTHORIZED
           
 
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
DDSServicesForm()
          Constructor for the RepositoryForm object
 
Method Summary
 String getAuthorizedFor()
          Gets the role name for which this user is authorized for
protected static String getDs()
          Return a string for the current time and date, sutiable for display in log files and output to standout:
 String getErrorCode()
          Gets the errorCode attribute of the DDSServicesForm object
 String getErrorMsg()
          Gets the errorMsg attribute of the DDSServicesForm object
 String getLocalizedRecordXml()
          Gets the localizedRecordXml attribute of the DDSServicesForm object
 int getN()
          Gets the n attribute of the DDSServicesForm object
 int getNumResults()
          Gets the number of matching results.
 String getRecordFormat()
          Gets the recordFormat attribute of the DDSServicesForm object
 String getRecordXml()
          Gets the recordXml attribute of the DDSServicesForm object
 ResultDocList getResults()
          Gets the results attribute of the DDSServicesForm object
 int getS()
          Gets the s attribute of the DDSServicesForm object
 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.
 List getXmlFormats()
          Gets the xmlFormats attribute of the DDSServicesForm 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 for
static void setDebug(boolean isDebugOuput)
          Sets the debug attribute
 void setErrorCode(String errorCode)
          Sets the errorCode attribute of the DDSServicesForm object
 void setErrorMsg(String errorMsg)
          Sets the errorMsg attribute of the DDSServicesForm object
 void setN(int val)
          Sets the n attribute of the DDSServicesForm object
 void setRecordFormat(String val)
          Sets the recordFormat attribute of the DDSServicesForm object
 void setRecordXml(String val)
          Sets the recordXml attribute of the DDSServicesForm object
 void setResults(ResultDocList results)
          Sets the results attribute of the DDSServicesForm object
 void setS(int val)
          Sets the s attribute of the DDSServicesForm object
 void setXmlFormats(List var)
          Sets the xmlFormats attribute of the DDSServicesForm 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
 

Field Detail

ERROR_CODE_NORECORDSMATCH

public static final String ERROR_CODE_NORECORDSMATCH
See Also:
Constant Field Values

ERROR_CODE_CANNOTDISSEMINATEFORMAT

public static final String ERROR_CODE_CANNOTDISSEMINATEFORMAT
See Also:
Constant Field Values

ERROR_CODE_IDDOESNOTEXIST

public static final String ERROR_CODE_IDDOESNOTEXIST
See Also:
Constant Field Values

ERROR_CODE_BADARGUMENT

public static final String ERROR_CODE_BADARGUMENT
See Also:
Constant Field Values

ERROR_CODE_BADVERB

public static final String ERROR_CODE_BADVERB
See Also:
Constant Field Values

ERROR_CODE_BADQUERY

public static final String ERROR_CODE_BADQUERY
See Also:
Constant Field Values

ERROR_CODE_NOTAUTHORIZED

public static final String ERROR_CODE_NOTAUTHORIZED
See Also:
Constant Field Values

ERROR_CODE_INTERNALSERVERERROR

public static final String ERROR_CODE_INTERNALSERVERERROR
See Also:
Constant Field Values
Constructor Detail

DDSServicesForm

public DDSServicesForm()
Constructor for the RepositoryForm object

Method Detail

getXmlFormats

public List getXmlFormats()
Gets the xmlFormats attribute of the DDSServicesForm object

Returns:
The xmlFormats value

setXmlFormats

public void setXmlFormats(List var)
Sets the xmlFormats attribute of the DDSServicesForm object

Parameters:
var - The new xmlFormats value

getLocalizedRecordXml

public String getLocalizedRecordXml()
Gets the localizedRecordXml attribute of the DDSServicesForm object

Returns:
The localizedRecordXml value

getRecordXml

public String getRecordXml()
Gets the recordXml attribute of the DDSServicesForm object

Returns:
The recordXml value

setRecordXml

public void setRecordXml(String val)
Sets the recordXml attribute of the DDSServicesForm object

Parameters:
val - The new recordXml value

setRecordFormat

public void setRecordFormat(String val)
Sets the recordFormat attribute of the DDSServicesForm object

Parameters:
val - The new recordFormat value

getRecordFormat

public String getRecordFormat()
Gets the recordFormat attribute of the DDSServicesForm object

Returns:
The recordFormat value

getS

public int getS()
Gets the s attribute of the DDSServicesForm object

Returns:
The s value

setS

public void setS(int val)
Sets the s attribute of the DDSServicesForm object

Parameters:
val - The new s value

getN

public int getN()
Gets the n attribute of the DDSServicesForm object

Returns:
The n value

setN

public void setN(int val)
Sets the n attribute of the DDSServicesForm object

Parameters:
val - The new n value

getAuthorizedFor

public String getAuthorizedFor()
Gets the role name for which this user is authorized for

Returns:
The authorizedFor value

setAuthorizedFor

public void setAuthorizedFor(String val)
Sets the role name for which this user is authorized for

Parameters:
val - The new authorizedFor value

setErrorCode

public void setErrorCode(String errorCode)
Sets the errorCode attribute of the DDSServicesForm object

Parameters:
errorCode - The new errorCode value

getErrorCode

public String getErrorCode()
Gets the errorCode attribute of the DDSServicesForm object

Returns:
The errorCode value

setErrorMsg

public void setErrorMsg(String errorMsg)
Sets the errorMsg attribute of the DDSServicesForm object

Parameters:
errorMsg - The new errorMsg value

getErrorMsg

public String getErrorMsg()
Gets the errorMsg attribute of the DDSServicesForm object

Returns:
The errorMsg value

getResults

public ResultDocList getResults()
Gets the results attribute of the DDSServicesForm object

Returns:
The results value

setResults

public void setResults(ResultDocList results)
Sets the results attribute of the DDSServicesForm 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

DLESE Tools
v1.6.0