ILOG JRules

ilog.rules.studio.model.query
Interface IlrAbstractQuery

All Superinterfaces:
EModelElement, EObject, IlrBRLElement, IlrBRLRuleElement, IlrElement, IlrModelElement, IlrMutableBRLRuleElement, IlrProjectElement, ilog.rules.brl.bql.model.IlrQueryElement, IlrResourceElement, Notifier
All Known Subinterfaces:
IlrQuery

public interface IlrAbstractQuery
extends IlrProjectElement, ilog.rules.brl.bql.model.IlrQueryElement

A representation of the model object 'Abstract Query'.

See Also:
IlrQueryPackage.getAbstractQuery()

Method Summary
 Set getCategoryFilter()
           
 String getDefinition()
          Returns the value of the 'Definition' attribute.
 String getDocumentation()
          Returns the value of the 'Documentation' attribute.
 IlrBRLDefinition getLanguageDefinition()
           
 Locale getLocale()
          Returns the value of the 'Locale' attribute.
 String getPackageName()
           
 String getRootName()
           
 IlrSyntaxTree getSyntaxTree()
           
 List getTemplateInfo()
           
 Map getTranslationProperties()
           
 boolean isIncludeDependencies()
          Returns the value of the 'Include Dependencies' attribute.
 void setDefinition(String value)
          Sets the value of the 'Definition' attribute.
 void setDocumentation(String value)
          Sets the value of the 'Documentation' attribute.
 void setIncludeDependencies(boolean value)
          Sets the value of the 'Include Dependencies' attribute.
 void setLocale(Locale value)
          Sets the value of the 'Locale' attribute.
 
Methods inherited from interface ilog.rules.studio.model.base.IlrProjectElement
getRuleProject, setRuleProject
 
Methods inherited from interface ilog.rules.studio.model.resource.IlrResourceElement
deleteElement, getOriginal, getResource, isWorkingCopy, setResource
 
Methods inherited from interface ilog.rules.studio.model.IlrModelElement
getName, getUuid, setName, setUuid
 
Methods inherited from interface ilog.rules.studio.model.IlrElement
cloneElement, createAnnotation, deleteElement, fillWith, getAdapter, getDisplayName, getModel, isDeleted, isValid, setPropertyValue, setPropertyValue
 
Methods inherited from interface org.eclipse.emf.ecore.EModelElement
getEAnnotation, getEAnnotations
 
Methods inherited from interface ilog.rules.commonbrm.model.IlrElement
eClass, getPropertyValue, getPropertyValue, isInstanceOf
 
Methods inherited from interface ilog.rules.brl.IlrMutableBRLRuleElement
setCategoryFilter, setPackageName, setPropertyValue, setRootName, setSyntaxTree, setTemplateInfo, setTranslationProperties
 
Methods inherited from interface ilog.rules.brl.IlrBRLElement
getName, getPropertyValue
 

Method Detail

getDefinition

String getDefinition()
Returns the value of the 'Definition' attribute.

Get the BQL definition of the query (for example, 'Find all business rules such that...').

Specified by:
getDefinition in interface IlrBRLRuleElement
Returns:
the value of the 'Definition' attribute.
See Also:
setDefinition(String), IlrQueryPackage.getAbstractQuery_Definition()

setDefinition

void setDefinition(String value)
Sets the value of the 'Definition' attribute.

Set the BQL definition of the query.

Specified by:
setDefinition in interface IlrMutableBRLRuleElement
Parameters:
value - the new value of the 'Definition' attribute.
See Also:
getDefinition()

isIncludeDependencies

boolean isIncludeDependencies()
Returns the value of the 'Include Dependencies' attribute.

The default value is "true". Returns whether the query will take into account the dependencies of the project it is being run on.

Returns:
the value of the 'Include Dependencies' attribute.
See Also:
setIncludeDependencies(boolean), IlrQueryPackage.getAbstractQuery_IncludeDependencies()

setIncludeDependencies

void setIncludeDependencies(boolean value)
Sets the value of the 'Include Dependencies' attribute.

Sets whether the query will take into account the dependencies of the project it's being run on.

Parameters:
value - the new value of the 'Include Dependencies' attribute.
See Also:
isIncludeDependencies()

getDocumentation

String getDocumentation()
Returns the value of the 'Documentation' attribute.

Returns the documentation of the query.

Specified by:
getDocumentation in interface IlrBRLElement
Returns:
the value of the 'Documentation' attribute.
See Also:
setDocumentation(String), IlrQueryPackage.getAbstractQuery_Documentation()

setDocumentation

void setDocumentation(String value)
Sets the value of the 'Documentation' attribute.

Sets the documentation of the query.

Specified by:
setDocumentation in interface IlrMutableBRLRuleElement
Parameters:
value - the new value of the 'Documentation' attribute.
See Also:
getDocumentation()

getLocale

Locale getLocale()
Returns the value of the 'Locale' attribute.

Returns the locale of the query.

Specified by:
getLocale in interface IlrBRLElement
Returns:
the value of the 'Locale' attribute.
See Also:
setLocale(Locale), IlrQueryPackage.getAbstractQuery_Locale()

setLocale

void setLocale(Locale value)
Sets the value of the 'Locale' attribute.

Sets the locale of the query.

Parameters:
value - the new value of the 'Locale' attribute.
See Also:
getLocale()

getLanguageDefinition

IlrBRLDefinition getLanguageDefinition()

Specified by:
getLanguageDefinition in interface IlrBRLRuleElement

getCategoryFilter

Set getCategoryFilter()

Specified by:
getCategoryFilter in interface IlrBRLElement

getTemplateInfo

List getTemplateInfo()

Specified by:
getTemplateInfo in interface IlrBRLRuleElement

getPackageName

String getPackageName()

Specified by:
getPackageName in interface IlrBRLRuleElement

getTranslationProperties

Map getTranslationProperties()

Specified by:
getTranslationProperties in interface IlrBRLRuleElement

getRootName

String getRootName()

Specified by:
getRootName in interface IlrBRLRuleElement

getSyntaxTree

IlrSyntaxTree getSyntaxTree()

Specified by:
getSyntaxTree in interface IlrBRLRuleElement
See Also:
IlrBRLParserManager

ILOG JRules