wt.rule
Interface Rule

All Superinterfaces:

AccessControlled, NetFactor

All Known Implementing Classes:

CompositeRule, PersistentRule

public interface Rule

extends AccessControlled

A Rule provides a holder for business logic that describes actions to be performed under certain conditions. This business logic is specified using XML.

Supported API: false

Extendable: false

Field Summary

static String	DEFAULT_RULE Label for the attribute; Specifies whether or not this is a default rule.
static String	DESCRIPTION Label for the attribute; A description of the rule's content and purpose.
static String	NAME Label for the attribute; The name of the rule.
static String	RULE_TYPE Label for the attribute; The type of business logic described by this rule.

Method Summary

String	getContents() Get the String content of the rule's specification.
String	getDescription() Gets the value of the attribute: DESCRIPTION.
String	getEncoding() Get the character encoding of the rule's specification.
InputSource	getInputSource() Get an InputSource on the contents of this rule's XML specification.
String	getName() Gets the value of the attribute: NAME.
RuleType	getRuleType() Gets the value of the attribute: RULE_TYPE.
boolean	isDefaultRule() Gets the value of the attribute: DEFAULT_RULE.
boolean	isEnabled() Specifies whether or not this rule is enabled.
void	setContents(String xml) Set the content of the rule's specification to the the specified String.
void	setDefaultRule(boolean a_DefaultRule) Sets the value of the attribute: DEFAULT_RULE.
void	setDescription(String a_Description) Sets the value of the attribute: DESCRIPTION.
void	setEncoding(String encoding) Set the encoding of the rule's specification.
void	setName(String a_Name) Sets the value of the attribute: NAME.
void	setRuleType(RuleType a_RuleType) Sets the value of the attribute: RULE_TYPE.

Methods inherited from interface wt.fc.NetFactor

getClassInfo, getConceptualClassname

Field Detail

NAME

public static final String NAME

Label for the attribute; The name of the rule.

Supported API: false

See Also:

Constant Field Values

RULE_TYPE

public static final String RULE_TYPE

Label for the attribute; The type of business logic described by this rule.

Supported API: false

See Also:

Constant Field Values

DEFAULT_RULE

public static final String DEFAULT_RULE

Label for the attribute; Specifies whether or not this is a default rule.

Supported API: false

See Also:

Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

Label for the attribute; A description of the rule's content and purpose.

Supported API: false

See Also:

Constant Field Values

Method Detail

getName

public String getName()

Gets the value of the attribute: NAME. The name of the rule.

Supported API: false

Returns:

String

setName

public void setName(String a_Name)
             throws WTPropertyVetoException

Sets the value of the attribute: NAME. The name of the rule.

Supported API: false

Parameters:

a_Name -

Throws:

WTPropertyVetoException

getRuleType

public RuleType getRuleType()

Gets the value of the attribute: RULE_TYPE. The type of business logic described by this rule.

Supported API: false

Returns:

RuleType

setRuleType

public void setRuleType(RuleType a_RuleType)
                 throws WTPropertyVetoException

Sets the value of the attribute: RULE_TYPE. The type of business logic described by this rule.

Supported API: false

Parameters:

a_RuleType -

Throws:

WTPropertyVetoException

isDefaultRule

public boolean isDefaultRule()

Gets the value of the attribute: DEFAULT_RULE. Specifies whether or not this is a default rule.

Supported API: false

Returns:

boolean

setDefaultRule

public void setDefaultRule(boolean a_DefaultRule)
                    throws WTPropertyVetoException

Sets the value of the attribute: DEFAULT_RULE. Specifies whether or not this is a default rule.

Supported API: false

Parameters:

a_DefaultRule -

Throws:

WTPropertyVetoException

getDescription

public String getDescription()

Gets the value of the attribute: DESCRIPTION. A description of the rule's content and purpose.

Supported API: false

Returns:

String

setDescription

public void setDescription(String a_Description)
                    throws WTPropertyVetoException

Sets the value of the attribute: DESCRIPTION. A description of the rule's content and purpose.

Supported API: false

Parameters:

a_Description -

Throws:

WTPropertyVetoException

getContents

public String getContents()

Get the String content of the rule's specification. The specification is written in XML. The semantics of the specification depends on the rule's RuleType.

Supported API: false

Returns:

String

setContents

public void setContents(String xml)
                 throws WTPropertyVetoException

Set the content of the rule's specification to the the specified String. The specification is written in XML. The semantics of the specification depends on the rule's RuleType.

Supported API: false

Parameters:

xml -

Throws:

WTPropertyVetoException

getEncoding

public String getEncoding()

Get the character encoding of the rule's specification. The specification is written in XML. The semantics of the specification depends on the rule's RuleType.

Supported API: false

Returns:

String

setEncoding

public void setEncoding(String encoding)
                 throws WTPropertyVetoException

Set the encoding of the rule's specification. The specification is written in XML. The semantics of the specification depends on the rule's RuleType.

Supported API: false

Parameters:

encoding -

Throws:

WTPropertyVetoException

getInputSource

public InputSource getInputSource()
                           throws UnsupportedEncodingException

Get an InputSource on the contents of this rule's XML specification.

This method returns null if the rule specification has no content.

Supported API: false

Returns:

InputSource

Throws:

UnsupportedEncodingException

isEnabled

public boolean isEnabled()

Specifies whether or not this rule is enabled. An enabled rule is available for use. A disabled rule should not be used.

Supported API: false

Returns:

boolean