|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IRule
an interface to be implemented to add rules to the validation engine.
Method Summary | |
---|---|
String |
getComponentCategory()
return the unique component category identifier in effect at the time this rule is evaluated. |
String |
getId()
get the unique id for this rule |
boolean |
getIgnoreIfNull()
returns the actf:ignoreifnull attribute for this rule |
Iterator |
getIterator(Object collection)
returns the iterator used for this rule should the rule involve any sort of collection or array. |
String |
getLongDescription()
returns the long description received upon a violation of this rule |
String |
getMessage()
returns the message resulting from violating this rule |
String |
getName()
return the name of the rule. |
String |
getRepairHint()
returns the repair hint for this rule |
int |
getSeverity()
return the severity level for a violation of this rule. |
boolean |
isEnabled()
returns the enable attribute for this rule |
void |
setComponentCategory(String categoryId)
set the component category identifier for this rule. |
void |
setEnabled(boolean enable)
set the enable attribute for this rule. |
void |
setId(String id)
set the id for this rule. |
void |
setIgnoreIfNull(boolean ignoreIfNull)
set the actf:ignoreifnull attribute for this rule. |
void |
setIteratorName(String clsName)
set the class name of the iterator to be used for iterating through any sort of collection. |
void |
setLongDescription(String desc)
set the long description or message to be received upon a violation of this rule. |
void |
setMessage(String msg)
set the message to be received upon a violation of this rule. |
void |
setName(String name)
set the name for this rule. |
void |
setRepairHint(String hint)
set the repair hint for this rule. |
void |
setSeverity(int level)
set the severity level for a violation of this rule. |
Methods inherited from interface org.eclipse.actf.validation.rules.ICriterion |
---|
addPart, apply, getAttribute, getParent, getParts, getRuleSet, initialize, setAttribute, setParent, setParts, setRuleSet |
Method Detail |
---|
String getName()
void setName(String name)
name
- String getId()
void setId(String id)
id
- boolean isEnabled()
void setEnabled(boolean enable)
enable
- -
true | falseString getMessage()
void setMessage(String msg)
msg
- -
message to be received upon a violation of this rulesetLongDescription(String)
String getLongDescription()
void setLongDescription(String desc)
desc
- -
long description to be received upon a violation of this rulesetMessage(String)
String getRepairHint()
void setRepairHint(String hint)
hint
- int getSeverity()
void setSeverity(int level)
org.eclipse.actf.util.logging.Reporter
.
level
- IReporter
String getComponentCategory()
boolean getIgnoreIfNull()
Iterator getIterator(Object collection)
ArrayIterator
is provided for
arrays and a DomNodeIterator
is provided for iterating through the
nodes of a W3C DOM level 2 NodeList
.
Other iterators may be specified using the actf:iterator attribute.
collection
- with which to initialize iterator
null
if no
iterator is requiredvoid setComponentCategory(String categoryId)
categoryId
- void setIgnoreIfNull(boolean ignoreIfNull)
ignoreIfNull
- -
true | falsevoid setIteratorName(String clsName)
RuleConstants.ITERATOR
attribute.
clsName
- - class name of iterator to be usedRuleConstants.ITERATOR
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |