ilog.rules.engine
Class IlrTask
- java.lang.Object
-
- ilog.rules.engine.IlrTask
-
- All Implemented Interfaces:
- java.io.Serializable
public abstract class IlrTask extends java.lang.Object implements java.io.SerializableThis abstract class represents the super class of a task definition of the IRL language. Tasks are created using the parsing methods of
IlrRulesetand are then exhibited by the ruleset. It provides the name, properties and the comments defined on the task.- See Also:
- Serialized Form
-
-
Method Summary
Methods Modifier and Type Method and Description java.lang.StringgetFormalComment()Returns the formal comment associated with the task as a string.java.lang.StringgetName()Returns the fully qualified name of the task.IlrPackagegetPackage()Returns the package in which the task is defined.IlrPropertyListgetProperties()Gets the properties of this task.java.lang.ObjectgetProperty(java.lang.String key)Returns the property value corresponding to the passed key.java.lang.StringgetShortName()Returns the short name of the task.IlrTaskFactorymakeFactory()Builds a factory object to represent this task.abstract IlrTaskFactorymakeFactory(IlrPackageFactory pkgF)Builds a factory object to represent this task.
-
-
-
Method Detail
-
getName
public java.lang.String getName()
Returns the fully qualified name of the task.
- Returns:
- The fully qualified name of the task
-
getShortName
public java.lang.String getShortName()
Returns the short name of the task.
- Returns:
- The short name of the task
-
getFormalComment
public final java.lang.String getFormalComment()
Returns the formal comment associated with the task as a string. If the task does not have a formal comment
nullis returned.- Returns:
- The comment associated to the task.
-
getProperty
public java.lang.Object getProperty(java.lang.String key)
Returns the property value corresponding to the passed key. If the property has not been defined on the task, it returns
null.- Parameters:
key- The property name.- Returns:
- The value of the property defined on the task.
-
getProperties
public final IlrPropertyList getProperties()
Gets the properties of this task.
- Returns:
- A property list.
-
makeFactory
public final IlrTaskFactory makeFactory()
Builds a factory object to represent this task.
- Returns:
- The factory object of this task.
-
makeFactory
public abstract IlrTaskFactory makeFactory(IlrPackageFactory pkgF)
Builds a factory object to represent this task.
*- Parameters:
pkgF- The package containing the task.- Returns:
- The factory object of this task.
-
getPackage
public IlrPackage getPackage()
Returns the package in which the task is defined.- Returns:
- The package that contains the task.
-
-