|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jasig.portal.tools.checks.CheckResult
public class CheckResult
Object representing the result of a check. All CheckResults convey the result of a check. Additionally, CheckResults representing failures convey advice about how to remediate the failed check.
Field Summary | |
---|---|
private java.lang.String |
message
A message describing the result of the check. |
private java.lang.String |
remediationAdvice
In the case where the check failed, a String describing how to resolve the failure. |
private boolean |
success
True if this CheckResult represents a successful result. |
Constructor Summary | |
---|---|
private |
CheckResult(boolean success,
java.lang.String message,
java.lang.String remediationAdvice)
|
Method Summary | |
---|---|
static CheckResult |
createFailure(java.lang.String message,
java.lang.String remediationAdvice)
Obtain a CheckResult representing a check that failed -- dependency for which you were checking was not present, thing you asserted to be true wasn't, etc. |
static CheckResult |
createSuccess(java.lang.String message)
Obtain a CheckResult representing a check that succeeded -- dependency for which you were checking was present, thing you asserted to be true actually was true, etc. |
java.lang.String |
getMessage()
|
java.lang.String |
getRemediationAdvice()
|
boolean |
isSuccess()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private final boolean success
private final java.lang.String message
private final java.lang.String remediationAdvice
Constructor Detail |
---|
private CheckResult(boolean success, java.lang.String message, java.lang.String remediationAdvice)
Method Detail |
---|
public static CheckResult createSuccess(java.lang.String message)
message
- - a message describing the success of that check
public static CheckResult createFailure(java.lang.String message, java.lang.String remediationAdvice)
message
- - a message describing the failure of the checkremediationAdvice
- - advice for the uPortal deployer about how to resolve this failure
public java.lang.String getMessage()
public java.lang.String getRemediationAdvice()
public boolean isSuccess()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |