|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.GenericService atg.markers.ValidateMarkerByPossibleValue
public abstract class ValidateMarkerByPossibleValue
This abstraction defines a marker validator that valdiates by ensuring the new marker's value is valid with the new marker's key.
The following options can be configured.
1. Accept all values as valid by setting acceptAllValues to true.
2. Accept only specific values as valid by setting nullValueValid to false and returning valid values from getValidValuesForKey.
3. Accept only a null value as valid by setting nullValueValid to true and returning null from getValidValuesForKey.
4. Accept null and specific values as valid by setting nullValueValid to true and returning valid values from getValidValuesForKey.
isAcceptAllValues()
,
isNullValueValid()
,
getValidValuesForKey(java.lang.String)
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
protected boolean |
mAcceptAllValues
|
protected boolean |
mNullValueValid
|
Fields inherited from class atg.nucleus.GenericService |
---|
SERVICE_INFO_KEY |
Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging |
---|
DEFAULT_LOG_TRACE_STATUS |
Fields inherited from interface atg.nucleus.logging.ApplicationLogging |
---|
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS |
Constructor Summary | |
---|---|
ValidateMarkerByPossibleValue()
|
Method Summary | |
---|---|
abstract java.util.List |
getValidValuesForKey(java.lang.String pMarkerKey)
This method should return the possible marker values for the the provided marker key. |
boolean |
isAcceptAllValues()
Boolean property for determining if all marker values are valid. |
boolean |
isNullValueValid()
Boolean property for determining if a marker value of null is valid. |
boolean |
isValidMarker(RepositoryMarkerManager pRepositoryMarkerManager,
RepositoryItem pMarkedItem,
RepositoryItem pMarkerToValidate)
This method determines if a marker is considered valid. |
boolean |
isValidValueForKey(java.lang.String pKey,
java.lang.String pValue)
Determines if the value is valid for the key |
void |
setAcceptAllValues(boolean pAcceptAllValues)
Sets the boolean property for determining if all marker values are valid. |
void |
setNullValueValid(boolean pNullValueValid)
Sets the boolean property for determining if the marker value is allowed to be null. |
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl |
---|
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
protected boolean mNullValueValid
protected boolean mAcceptAllValues
Constructor Detail |
---|
public ValidateMarkerByPossibleValue()
Method Detail |
---|
public boolean isValidMarker(RepositoryMarkerManager pRepositoryMarkerManager, RepositoryItem pMarkedItem, RepositoryItem pMarkerToValidate) throws MarkerException
isValidMarker
in interface MarkerValidator
pRepositoryMarkerManager
- the marker manager making the validation requestpMarkedItem
- the item being markedpMarkerToValidate
- the marker to validate
MarkerException
public abstract java.util.List getValidValuesForKey(java.lang.String pMarkerKey)
pMarkerKey
- the marker key
public boolean isNullValueValid()
public void setNullValueValid(boolean pNullValueValid)
public boolean isAcceptAllValues()
public void setAcceptAllValues(boolean pAcceptAllValues)
public boolean isValidValueForKey(java.lang.String pKey, java.lang.String pValue)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |