com.cafesoft.cams.attr
Class StandardEvaluationStatus

java.lang.Object
  com.cafesoft.cams.attr.StandardEvaluationStatus

All Implemented Interfaces:

EvaluationStatus

public class StandardEvaluationStatus
extends Object
implements EvaluationStatus

StandardEvaluationStatus is the standard implementation of EvaluationStatus, which represents the status after evaluation of an Evaluatable object.

Since:

4/27/2004

Field Summary

static EvaluationStatus

OK_EVALUATION_STATUS Standard EvaluationStatus for successul evaluation.

Fields inherited from interface com.cafesoft.cams.attr.EvaluationStatus

STATUS_MISSING_ATTRIBUTE, STATUS_OK, STATUS_PROCESSING_ERROR, STATUS_SYNTAX_ERROR

Constructor Summary

StandardEvaluationStatus(String message, List attrList)
Constructor that takes a message and a List of missing attributes.

StandardEvaluationStatus(String message, List attrList, EvaluationStatus nestedStatus)
Constructor that takes a message, a List of missing attributes, and a nested EvaluationStatus.

StandardEvaluationStatus(String code, String message)
Constructor that take the status code, message, and an optional nested EvaluationStatus.

StandardEvaluationStatus(String code, String message, EvaluationStatus nestedStatus)
Constructor that take the status code, message, and a nested EvaluationStatus.

Method Summary

String	getCode() Returns the status code.
String	getMessage() Returns the status message or null if there is none.
List	getMissingAttributes() Returns a List of missing attributes.
EvaluationStatus	getNestedEvalutionStatus() Return a nested EvaluationStatus if available.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OK_EVALUATION_STATUS

public static final EvaluationStatus OK_EVALUATION_STATUS

Standard EvaluationStatus for successul evaluation.

Constructor Detail

StandardEvaluationStatus

public StandardEvaluationStatus(String code,
                                String message)

Constructor that take the status code, message, and an optional nested EvaluationStatus.

Parameters:

code - the status code.

message - the status message.

StandardEvaluationStatus

public StandardEvaluationStatus(String code,
                                String message,
                                EvaluationStatus nestedStatus)

Constructor that take the status code, message, and a nested EvaluationStatus.

Parameters:

code - the status code.

message - the status message.

nestedStatus - the nested EvaluationStatus.

StandardEvaluationStatus

public StandardEvaluationStatus(String message,
                                List attrList)

Constructor that takes a message and a List of missing attributes.

Parameters:

message - the status message.

attrList - a List of missing attributes.

StandardEvaluationStatus

public StandardEvaluationStatus(String message,
                                List attrList,
                                EvaluationStatus nestedStatus)

Constructor that takes a message, a List of missing attributes, and a nested EvaluationStatus.

Parameters:

message - the status message.

attrList - a List of missing attributes.

nestedStatus - the nested EvaluationStatus.

Method Detail

getCode

public String getCode()

Returns the status code.

Specified by:

getCode in interface EvaluationStatus

Returns:

the status code.

getMessage

public String getMessage()

Returns the status message or null if there is none.

Specified by:

getMessage in interface EvaluationStatus

Returns:

the status message or null

getMissingAttributes

public List getMissingAttributes()

Returns a List of missing attributes.

Specified by:

getMissingAttributes in interface EvaluationStatus

Returns:

a List of missing Attribute instances if the code is STATUS_MISSING_ATTRIBUTE or null if any other status code.

getNestedEvalutionStatus

public EvaluationStatus getNestedEvalutionStatus()

Return a nested EvaluationStatus if available.

Specified by:

getNestedEvalutionStatus in interface EvaluationStatus

Returns:

a nested EvaluationStatus if one available or null if no nested EvaluationStatus.