|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.lang.Throwable java.lang.Exception com.ibm.workplace.wcm.api.exceptions.WCMException com.ibm.workplace.wcm.api.extensions.validation.FileUploadValidationException
public class FileUploadValidationException
A FileUploadValidationException
if any error occurs while validation file contents by a FileUploadValidation Plugin.
Field Summary |
---|
Fields inherited from class com.ibm.workplace.wcm.api.exceptions.WCMException |
---|
ERR_APTRIX |
Constructor Summary | |
---|---|
FileUploadValidationException()
Constructs a new exception with the given message. |
|
FileUploadValidationException(java.lang.String detail)
Constructs a new exception with the given message. |
|
FileUploadValidationException(java.lang.String detail,
java.lang.Throwable cause)
Constructs a new exception with the given message. |
|
FileUploadValidationException(java.lang.Throwable cause)
Constructs a new exception with the given message. |
Method Summary | |
---|---|
java.lang.String |
getReason()
Retrieves the detailed reason for validation failure. |
java.lang.String |
getReason(java.util.Locale locale)
Retrieves the detailed reason for validation failure. |
java.lang.String |
getValidationFailureMessage(java.util.Locale locale)
Retrieves the reason for validation failure, formatted ( if possible ) to the given Locale. |
boolean |
isConsiderFileContentsValid()
If true the file contents should be considered valid, even though an exception was thrown during validation. |
void |
setConsiderFileContentsValid(boolean considerFileContentsValid)
If set to true, WCM will consider the file content valid ( is passed validation) even though an exception is being thrown during validation. |
void |
setReason(java.lang.String reason)
Sets the reason for the validation failure. |
Methods inherited from class com.ibm.workplace.wcm.api.exceptions.WCMException |
---|
getCause, getDescription, getErrorCode, getLocales, getMessage, getMessage, getTitle, printStackTrace, printStackTrace, printStackTrace |
Methods inherited from class java.lang.Throwable |
---|
fillInStackTrace, getLocalizedMessage, getStackTrace, initCause, setStackTrace, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public FileUploadValidationException()
public FileUploadValidationException(java.lang.String detail, java.lang.Throwable cause)
detail
- the messagecause
- the exception that caused this exceptionpublic FileUploadValidationException(java.lang.String detail)
detail
- the messagepublic FileUploadValidationException(java.lang.Throwable cause)
cause
- the exception that caused this exceptionMethod Detail |
---|
public boolean isConsiderFileContentsValid()
public void setConsiderFileContentsValid(boolean considerFileContentsValid)
This can be used in a case where the plugin failed for some reason other than the file failing validation, and it wishes to a allow the file to be stored.
the default values is false.
considerFileContentsValid
- - set to true is the exception is "informational" to WCM and the file contents are valid.public java.lang.String getReason()
public java.lang.String getReason(java.util.Locale locale)
locale
- Locale version of the reason string.
public void setReason(java.lang.String reason)
reason
- Detailed description of the validation failure.public java.lang.String getValidationFailureMessage(java.util.Locale locale)
locale
- locale used to format the returned string
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |