Skip navigation links

ilog.rules.res.model
Interface IlrRuleAppInformationBase<R,E>

All Known Subinterfaces:

IlrMutableRuleAppInformation, IlrRuleAppInformation

public interface IlrRuleAppInformationBase<R,E>

The IlrRuleAppInformationBase interface represents a generic ruleset container. This class can contain properties.

Since:

7.0

Method Summary

IlrPath	getCanonicalPath() Retrieves the canonical path of this RuleApp.
Date	getCreationDate() Retrieves the creation date of this RuleApp.
String	getDescription() Returns the description of this RuleApp.
String	getDisplayName() Retrieves the display name of this RuleApp.
E	getGreatestRuleset(String rulesetName) Retrieves the latest version of a specific ruleset.
String	getName() Retrieves the name of this RuleApp.
IlrRuleAppProperties	getProperties() Retrieves all the properties associated with this RuleApp.
R	getRepository() Retrieves the repository that contains this RuleApp.
E	getRuleset(String rulesetName, IlrVersion rulesetVersion) Retrieves the ruleset with a specific name and version number.
Set<E>	getRulesets() Retrieves all the rulesets in this RuleApp.
Set<E>	getRulesets(String rulesetName) Retrieves all the rulesets with a specific name.
IlrVersion	getVersion() Retrieves the version of this RuleApp.
byte[]	getXOM() Retrieves a binary representation of the execution object model (XOM).

Method Detail

getRepository

R getRepository()

Retrieves the repository that contains this RuleApp.

Returns:

The repository that contains this RuleApp. If this RuleApp is not linked to a repository, null is returned.

getName

String getName()

Retrieves the name of this RuleApp.

Returns:

The name of this RuleApp. This method never returns null.

getVersion

IlrVersion getVersion()

Retrieves the version of this RuleApp.

Returns:

The version of this RuleApp. This method never returns null.

getDisplayName

String getDisplayName()

Retrieves the display name of this RuleApp.

Returns:

The display name of this RuleApp. The value returned can be null.

getDescription

String getDescription()

Returns the description of this RuleApp.

Returns:

The description of this RuleApp. The value returned can be null.

getCreationDate

Date getCreationDate()

Retrieves the creation date of this RuleApp.

Returns:

The creation date. This method never returns null.

getCanonicalPath

IlrPath getCanonicalPath()

Retrieves the canonical path of this RuleApp.

Returns:

The canonical path of this RuleApp. This method never returns null.

getProperties

IlrRuleAppProperties getProperties()

Retrieves all the properties associated with this RuleApp.

Returns:

All properties associated with this RuleApp.

getXOM

byte[] getXOM()

Retrieves a binary representation of the execution object model (XOM).

Returns:

A binary representation of the execution object model.

getRulesets

Set<E> getRulesets()

Retrieves all the rulesets in this RuleApp.

Returns:

A set of IlrRulesetArchiveInformation objects.

getRulesets

Set<E> getRulesets(String rulesetName)

Retrieves all the rulesets with a specific name.

Parameters:

rulesetName - The name of the ruleset to return.

Returns:

A set of IlrRulesetArchiveInformation objects.

getGreatestRuleset

E getGreatestRuleset(String rulesetName)

Retrieves the latest version of a specific ruleset.

Parameters:

rulesetName - The name of the ruleset to return.

Returns:

The ruleset that matches rulesetName. If no ruleset matches this name, null is returned.

getRuleset

E getRuleset(String rulesetName,
             IlrVersion rulesetVersion)

Retrieves the ruleset with a specific name and version number.

Parameters:

rulesetName - The name of the ruleset to return.

rulesetVersion - The version of the ruleset to return.

Returns:

The ruleset that matches rulesetName and rulesetVersion. If no ruleset matches the parameters, null is returned.