Decision Center API

ilog.rules.teamserver.brm
Interface IlrRuleProject

All Superinterfaces:
Cloneable, IlrBasicModelElement, ilog.rules.teamserver.model.IlrCompositeObject, ilog.rules.commonbrm.model.IlrElement, IlrElementDetails, IlrElementHandle, IlrElementSummary, IlrModelElement, Serializable

public interface IlrRuleProject
extends IlrModelElement

A representation of the model object 'Rule Project'.

The following features are supported:

See Also:
IlrBrmPackage.getRuleProject()

Method Summary
 String getAdvancedProperties()
          Returns the value of the 'Advanced Properties' attribute.
 IlrBaseline getBaselineNamed(String name)
          Gets the baseline with the given name for this project.
 List getBaselines()
          Returns the value of the 'Baselines' containment reference list.
 List getBaselines(IlrElementVersion version)
          Returns the value of the 'Baselines' containment reference list for the given version.
 List getConnectionEntries()
          Returns the value of the 'Connection Entries' containment reference list.
 List getConnectionEntries(IlrElementVersion version)
          Returns the value of the 'Connection Entries' containment reference list for the given version.
 IlrBaseline getCurrentBaseline()
          Gets the current baseline for this project.
 String getDescription()
          Returns the value of the 'Description' attribute.
 String getPlatform()
          Returns the value of the 'Platform' attribute.
 IlrBaseline getRecyclebinBaseline()
          Gets the recycle bin baseline for this project.
 int getVersion()
          Returns the value of the 'Version' attribute.
 boolean isDecisionService()
          Returns the value of the 'Decision Service' attribute.
 
Methods inherited from interface ilog.rules.teamserver.brm.IlrModelElement
getName, getUuid
 
Methods inherited from interface ilog.rules.teamserver.brm.IlrBasicModelElement
getCreatedBy, getCreatedOn, getLastChangedBy, getLastChangedOn
 
Methods inherited from interface ilog.rules.teamserver.model.IlrElementDetails
cloneElement, getContainer, getRawValue, setRawValue, setRawValueNoCheck
 
Methods inherited from interface ilog.rules.teamserver.model.IlrElementHandle
eClass, equals, equals, getModelInfo, getSession, getType, getValue, hashCode, isNew, toIdString
 
Methods inherited from interface ilog.rules.commonbrm.model.IlrElement
getPropertyValue, getPropertyValue, isInstanceOf
 

Method Detail

getBaselines

List getBaselines()
                  throws IlrObjectNotFoundException
Returns the value of the 'Baselines' containment reference list.

The list contents are of type IlrBaseline.

Throws:
IlrObjectNotFoundException
Returns:
the value of the 'Baselines' containment reference list.
See Also:
IlrBrmPackage.getRuleProject_Baselines()

getBaselines

List getBaselines(IlrElementVersion version)
                  throws IlrObjectNotFoundException
Returns the value of the 'Baselines' containment reference list for the given version. Allows to retrieve the value linked to a specific version. Useful when the working baseline is the current baseline.

The list contents are of type IlrBaseline.

Throws:
IlrObjectNotFoundException
Parameters:
version - The version of the element.
Returns:
the value of the 'Baselines' containment reference list.
See Also:
IlrBrmPackage.getRuleProject_Baselines()

getAdvancedProperties

String getAdvancedProperties()
Returns the value of the 'Advanced Properties' attribute.

Returns:
the value of the 'Advanced Properties' attribute.
See Also:
IlrBrmPackage.getRuleProject_AdvancedProperties()

getPlatform

String getPlatform()
Returns the value of the 'Platform' attribute.

Returns:
the value of the 'Platform' attribute.
See Also:
IlrBrmPackage.getRuleProject_Platform()

getConnectionEntries

List getConnectionEntries()
                          throws IlrObjectNotFoundException
Returns the value of the 'Connection Entries' containment reference list.

The list contents are of type IlrConnectionEntry.

Throws:
IlrObjectNotFoundException
Returns:
the value of the 'Connection Entries' containment reference list.
See Also:
IlrBrmPackage.getRuleProject_ConnectionEntries()

getConnectionEntries

List getConnectionEntries(IlrElementVersion version)
                          throws IlrObjectNotFoundException
Returns the value of the 'Connection Entries' containment reference list for the given version. Allows to retrieve the value linked to a specific version. Useful when the working baseline is the current baseline.

The list contents are of type IlrConnectionEntry.

Throws:
IlrObjectNotFoundException
Parameters:
version - The version of the element.
Returns:
the value of the 'Connection Entries' containment reference list.
See Also:
IlrBrmPackage.getRuleProject_ConnectionEntries()

isDecisionService

boolean isDecisionService()
Returns the value of the 'Decision Service' attribute.

The default value is "false".

If the meaning of the 'Decision Service' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Decision Service' attribute.
See Also:
IlrBrmPackage.getRuleProject_DecisionService()

getVersion

int getVersion()
Returns the value of the 'Version' attribute.

If the meaning of the 'Version' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Version' attribute.
See Also:
IlrBrmPackage.getRuleProject_Version()

getDescription

String getDescription()
Returns the value of the 'Description' attribute.

If the meaning of the 'Description' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Description' attribute.
See Also:
IlrBrmPackage.getRuleProject_Description()

getCurrentBaseline

IlrBaseline getCurrentBaseline()
                               throws IlrObjectNotFoundException
Gets the current baseline for this project.

Throws:
IlrObjectNotFoundException - If the project cannot be found.
Returns:
The current baseline.

getRecyclebinBaseline

IlrBaseline getRecyclebinBaseline()
                                  throws IlrObjectNotFoundException
Gets the recycle bin baseline for this project.

Throws:
IlrObjectNotFoundException - If the project cannot be found.
Returns:
The recycle bin baseline.

getBaselineNamed

IlrBaseline getBaselineNamed(String name)
                             throws IlrObjectNotFoundException
Gets the baseline with the given name for this project.

Throws:
IlrObjectNotFoundException - If the project cannot be found.
Parameters:
name - The name of the requested baseline
Returns:
The current baseline.

Decision Center API

© Copyright IBM Corp. 1987, 2013