ilog.rules.res.model

Interface IlrMutableRuleAppInformation

All Superinterfaces:

IlrRuleAppInformationBase<IlrMutableRepository,IlrMutableRulesetArchiveInformation>

public interface IlrMutableRuleAppInformation
extends IlrRuleAppInformationBase<IlrMutableRepository,IlrMutableRulesetArchiveInformation>

The IlrMutableRuleAppInformation interface represents an IlrRulesetArchiveInformation container. An IlrMutableRuleAppInformation object contains rule application properties. It is also used to add rulesets to, and remove them, from a RuleApp.

Since:

7.0

Method Summary

Methods

Modifier and Type	Method and Description
IlrMutableRulesetArchiveInformation	addRuleset(IlrMutableRulesetArchiveInformation ruleset) Adds a ruleset to a RuleApp.
boolean	removeRuleset(IlrMutableRulesetArchiveInformation ruleset) Removes a ruleset from a RuleApp.
void	setDescription(java.lang.String description) Modifies the description of the RuleApp.
void	setDisplayName(java.lang.String displayName) Modifies the display name of the RuleApp.
void	setProperty(java.lang.String key, java.lang.String value) Sets the value corresponding to a key.

Methods inherited from interface ilog.rules.res.model.IlrRuleAppInformationBase

getCanonicalPath, getCreationDate, getDescription, getDisplayName, getGreatestRuleset, getName, getProperties, getRepository, getRuleset, getRulesets, getRulesets, getVersion, getXOM

Method Detail

setDisplayName

void setDisplayName(java.lang.String displayName)

Modifies the display name of the RuleApp.

Parameters:

displayName - The new display name of the RuleApp. This parameter can be set to null.

setDescription

void setDescription(java.lang.String description)

Modifies the description of the RuleApp.

Parameters:

description - The new RuleApp description. This parameter can be set to null.

addRuleset

IlrMutableRulesetArchiveInformation addRuleset(IlrMutableRulesetArchiveInformation ruleset)
                                               throws IlrAlreadyExistException

Adds a ruleset to a RuleApp. If ruleset already exists in the RuleApp, an IlrAlreadyExistException instance is thrown before ruleset is added to the RuleApp.

Throws:

IlrAlreadyExistException - If ruleset already exists in the RuleApp.

Parameters:

ruleset - The ruleset to add.

Returns:

The ruleset added.

removeRuleset

boolean removeRuleset(IlrMutableRulesetArchiveInformation ruleset)

Removes a ruleset from a RuleApp. Nothing is changed in the RuleApp if it does not contain ruleset.

The behavior of ruleset after it has been removed from the RuleApp is undefined .

Parameters:

ruleset - The ruleset to remove.

Returns:

true if this RuleApp contains ruleset,

setProperty

void setProperty(java.lang.String key,
               java.lang.String value)

Sets the value corresponding to a key.

Parameters:

key - The key to be placed into the property list. This parameter must not be set to null.

value - The value for the key parameter. Set to null to remove the property corresponding to key.