org.sandev.basics.util
Class FormOutput

java.lang.Object
  extended by org.sandev.basics.sandmessages.ErrorInfoCollection
      extended by org.sandev.basics.util.FormOutput
All Implemented Interfaces:
SandCollectionMessage, SandMessage, SandTransmitMessage, SandVerbMessage

public class FormOutput
extends ErrorInfoCollection

An extension of a FormItemCollection with some extra utility methods for easy output capture.


Field Summary
 
Fields inherited from class org.sandev.basics.sandmessages.ErrorInfoCollection
complete, errorInfos, pagination, queryResult, sandTransmissionCount, sandTransmissionLocale, sandTransmitAuthID, sandTransmitErrorCode, sandTransmitErrorMessage, sandTransmitStatus, total
 
Fields inherited from interface org.sandev.basics.structs.SandTransmitMessage
APPERROR_NODE_UNAVAILABLE, APPERROR_NODE_UNKNOWN, APPERROR_NODE_UNREACHABLE, STATUS_APPERROR, STATUS_NORMAL, STATUS_SANDERROR, STATUS_SYSERROR
 
Constructor Summary
FormOutput()
           
 
Method Summary
 void addOutput(int sev, java.lang.String text)
          Convenience append method to add output text.
 void addOutput(int sev, java.lang.String fieldname, java.lang.String code, java.lang.String text)
          Convenience append method to add output text.
 void appendError(java.lang.String text)
          Convenience append method to add an error to the output text.
 void appendInfo(java.lang.String text)
          Convenience append method for informational messages
 void appendWarning(java.lang.String text)
          Convenience append method for informational messages
static void debugout(java.lang.String text)
          Used for all debug output.
 boolean hasErrorOutput()
          Return true if the outputText contains error output, false otherwise.
 
Methods inherited from class org.sandev.basics.sandmessages.ErrorInfoCollection
addElement, addElements, addErrorInfos, addErrorInfos, addPagination, addPagination, clearErrorInfos, clearPagination, cloneErrorInfoCollection, errorInfosContains, errorInfosIndexOf, fieldHasFlag, getBaseMemoryUse, getCollectionMessage, getComplete, getCompleteDefaultValue, getCompleteFieldPrintValue, getCompleteFlag, getCompleteMetatype, getCompletePrintValue, getCompleteRange, getCompleteValidityCheck, getElements, getErrorInfos, getErrorInfos, getErrorInfosDefaultValue, getErrorInfosElementInvalidValue, getErrorInfosFieldPrintValue, getErrorInfosFlag, getErrorInfosInvalidValue, getErrorInfosMetatype, getErrorInfosPrintValue, getErrorInfosRange, getErrorInfosValidityCheck, getPagination, getPagination, getPaginationDefaultValue, getPaginationElementInvalidValue, getPaginationFieldPrintValue, getPaginationFlag, getPaginationInvalidValue, getPaginationMetatype, getPaginationPrintValue, getPaginationRange, getPaginationValidityCheck, getQueryMessage, getQueryResult, getQueryResultDefaultValue, getQueryResultFieldPrintValue, getQueryResultFlag, getQueryResultInvalidValue, getQueryResultLengthMax, getQueryResultLengthNorm, getQueryResultMetatype, getQueryResultPrintValue, getQueryResultRange, getQueryResultValidityCheck, getSandTransmissionCount, getSandTransmissionCountDefaultValue, getSandTransmissionCountFieldPrintValue, getSandTransmissionCountFlag, getSandTransmissionCountInvalidValue, getSandTransmissionCountMetatype, getSandTransmissionCountPrintValue, getSandTransmissionCountRange, getSandTransmissionCountValidityCheck, getSandTransmissionLocale, getSandTransmissionLocaleDefaultValue, getSandTransmissionLocaleFieldPrintValue, getSandTransmissionLocaleFlag, getSandTransmissionLocaleInvalidValue, getSandTransmissionLocaleMetatype, getSandTransmissionLocalePrintValue, getSandTransmissionLocaleRange, getSandTransmissionLocaleValidityCheck, getSandTransmitAuthID, getSandTransmitAuthIDDefaultValue, getSandTransmitAuthIDFieldPrintValue, getSandTransmitAuthIDFlag, getSandTransmitAuthIDInvalidValue, getSandTransmitAuthIDMetatype, getSandTransmitAuthIDPrintValue, getSandTransmitAuthIDRange, getSandTransmitAuthIDValidityCheck, getSandTransmitErrorCode, getSandTransmitErrorCodeDefaultValue, getSandTransmitErrorCodeFieldPrintValue, getSandTransmitErrorCodeFlag, getSandTransmitErrorCodeInvalidValue, getSandTransmitErrorCodeLengthMax, getSandTransmitErrorCodeLengthNorm, getSandTransmitErrorCodeMetatype, getSandTransmitErrorCodePrintValue, getSandTransmitErrorCodeRange, getSandTransmitErrorCodeValidityCheck, getSandTransmitErrorMessage, getSandTransmitErrorMessageDefaultValue, getSandTransmitErrorMessageFieldPrintValue, getSandTransmitErrorMessageFlag, getSandTransmitErrorMessageInvalidValue, getSandTransmitErrorMessageLengthMax, getSandTransmitErrorMessageLengthNorm, getSandTransmitErrorMessageMetatype, getSandTransmitErrorMessagePrintValue, getSandTransmitErrorMessageRange, getSandTransmitErrorMessageValidityCheck, getSandTransmitStatus, getSandTransmitStatusDefaultValue, getSandTransmitStatusFieldPrintValue, getSandTransmitStatusFlag, getSandTransmitStatusInvalidValue, getSandTransmitStatusMetatype, getSandTransmitStatusPrintValue, getSandTransmitStatusRange, getSandTransmitStatusValidityCheck, getShortName, getStructMessage, getTotal, getTotalDefaultValue, getTotalFieldPrintValue, getTotalFlag, getTotalInvalidValue, getTotalMetatype, getTotalPrintValue, getTotalRange, getTotalValidityCheck, getUpdateMessage, init, insertErrorInfos, insertPagination, isComplete, isEquivalent, paginationContains, paginationIndexOf, removeElement, removeErrorInfos, removeErrorInfosValue, removePagination, removePaginationValue, setComplete, setElements, setErrorInfos, setErrorInfos, setErrorInfos, setPagination, setPagination, setPagination, setQueryResult, setQueryResult, setSandTransmissionCount, setSandTransmissionLocale, setSandTransmissionLocale, setSandTransmitAuthID, setSandTransmitError, setSandTransmitErrorCode, setSandTransmitErrorCode, setSandTransmitErrorMessage, setSandTransmitErrorMessage, setSandTransmitStatus, setTotal, sizeofErrorInfos, sizeofPagination
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FormOutput

public FormOutput()
Method Detail

appendError

public void appendError(java.lang.String text)
Convenience append method to add an error to the output text.


appendWarning

public void appendWarning(java.lang.String text)
Convenience append method for informational messages


appendInfo

public void appendInfo(java.lang.String text)
Convenience append method for informational messages


addOutput

public void addOutput(int sev,
                      java.lang.String text)
Convenience append method to add output text.


addOutput

public void addOutput(int sev,
                      java.lang.String fieldname,
                      java.lang.String code,
                      java.lang.String text)
Convenience append method to add output text.


hasErrorOutput

public boolean hasErrorOutput()
Return true if the outputText contains error output, false otherwise.


debugout

public static void debugout(java.lang.String text)
Used for all debug output. If singleton access to a Logger instance is standardized, then this method should use that mechanism. For now this just wraps System.out.println.