Class DDSServicesForm
java.lang.Object
org.apache.struts.action.ActionForm
org.dlese.dpc.dds.action.form.VocabForm
org.dlese.dpc.services.dds.action.form.DDSServicesForm
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
DDSServicesForm_1_1
A ActionForm bean that holds data for DDS web services and has access to vocab info.
- Author:
- John Weatherley
- See Also:
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final StringFields inherited from class org.dlese.dpc.dds.action.form.VocabForm
audience, field, language, metaFormat, value, vocabFields inherited from class org.apache.struts.action.ActionForm
multipartRequestHandler, servlet -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGets the role name for which this user is authorized forprotected static final StringgetDs()Return a string for the current time and date, sutiable for display in log files and output to standout:Gets the errorCode attribute of the DDSServicesForm objectGets the errorMsg attribute of the DDSServicesForm objectGets the localizedRecordXml attribute of the DDSServicesForm objectintgetN()Gets the n attribute of the DDSServicesForm objectintGets the number of matching results.Gets the recordFormat attribute of the DDSServicesForm objectGets the recordXml attribute of the DDSServicesForm objectGets the results attribute of the DDSServicesForm objectintgetS()Gets the s attribute of the DDSServicesForm objectA list of UTC dates in the past in the following order: one minute, one hour, one day, one week, one month, one year.Gets the xmlFormats attribute of the DDSServicesForm objectprotected final voidOutput a line of text to standard out, with datestamp, if debug is set to true.protected final voidOutput a line of text to error out, with datestamp.voidsetAuthorizedFor(String val) Sets the role name for which this user is authorized forstatic voidsetDebug(boolean isDebugOuput) Sets the debug attributevoidsetErrorCode(String errorCode) Sets the errorCode attribute of the DDSServicesForm objectvoidsetErrorMsg(String errorMsg) Sets the errorMsg attribute of the DDSServicesForm objectvoidsetN(int val) Sets the n attribute of the DDSServicesForm objectvoidsetRecordFormat(String val) Sets the recordFormat attribute of the DDSServicesForm objectvoidsetRecordXml(String val) Sets the recordXml attribute of the DDSServicesForm objectvoidsetResults(ResultDocList results) Sets the results attribute of the DDSServicesForm objectvoidsetS(int val) Sets the s attribute of the DDSServicesForm objectvoidsetXmlFormats(List var) Sets the xmlFormats attribute of the DDSServicesForm objectMethods 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, setVocabInterfaceMethods inherited from class org.apache.struts.action.ActionForm
getMultipartRequestHandler, getServlet, getServletWrapper, reset, reset, setMultipartRequestHandler, setServlet, validate, validate
-
Field Details
-
ERROR_CODE_NORECORDSMATCH
- See Also:
-
ERROR_CODE_CANNOTDISSEMINATEFORMAT
- See Also:
-
ERROR_CODE_IDDOESNOTEXIST
- See Also:
-
ERROR_CODE_BADARGUMENT
- See Also:
-
ERROR_CODE_BADVERB
- See Also:
-
ERROR_CODE_BADQUERY
- See Also:
-
ERROR_CODE_NOTAUTHORIZED
- See Also:
-
ERROR_CODE_INTERNALSERVERERROR
- See Also:
-
-
Constructor Details
-
DDSServicesForm
public DDSServicesForm()Constructor for the RepositoryForm object
-
-
Method Details
-
getXmlFormats
Gets the xmlFormats attribute of the DDSServicesForm object- Returns:
- The xmlFormats value
-
setXmlFormats
Sets the xmlFormats attribute of the DDSServicesForm object- Parameters:
var- The new xmlFormats value
-
getLocalizedRecordXml
Gets the localizedRecordXml attribute of the DDSServicesForm object- Returns:
- The localizedRecordXml value
-
getRecordXml
Gets the recordXml attribute of the DDSServicesForm object- Returns:
- The recordXml value
-
setRecordXml
Sets the recordXml attribute of the DDSServicesForm object- Parameters:
val- The new recordXml value
-
setRecordFormat
Sets the recordFormat attribute of the DDSServicesForm object- Parameters:
val- The new recordFormat value
-
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
Gets the role name for which this user is authorized for- Returns:
- The authorizedFor value
-
setAuthorizedFor
Sets the role name for which this user is authorized for- Parameters:
val- The new authorizedFor value
-
setErrorCode
Sets the errorCode attribute of the DDSServicesForm object- Parameters:
errorCode- The new errorCode value
-
getErrorCode
Gets the errorCode attribute of the DDSServicesForm object- Returns:
- The errorCode value
-
setErrorMsg
Sets the errorMsg attribute of the DDSServicesForm object- Parameters:
errorMsg- The new errorMsg value
-
getErrorMsg
Gets the errorMsg attribute of the DDSServicesForm object- Returns:
- The errorMsg value
-
getResults
Gets the results attribute of the DDSServicesForm object- Returns:
- The results value
-
setResults
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
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
Return a string for the current time and date, sutiable for display in log files and output to standout:- Returns:
- The dateStamp value
-
prtlnErr
Output a line of text to error out, with datestamp.- Parameters:
s- The text that will be output to error out.
-
prtln
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
-