Decision Center API

ilog.rules.teamserver.model
Interface IlrElementHandle

All Superinterfaces:
ilog.rules.commonbrm.model.IlrElement, Serializable
All Known Subinterfaces:
IlrAbstractQuery, IlrAction, IlrActionObject, IlrActionRule, IlrActivity, IlrActivityComment, IlrActivityCommentAccess, IlrActivityCommentAttachment, IlrActivityCommentEvent, IlrActivityCommentLink, IlrActivityLock, IlrActivitySubscription, IlrActivityUserComment, IlrArgument, IlrBaseline, IlrBasicLock, IlrBasicModelElement, IlrBOM, IlrBOM2XOMMapping, IlrBOMEntry, IlrBOMPathEntry, IlrBranch, IlrBRLRule, IlrBusinessObject, IlrBusinessRule, IlrChangeAct, IlrChart, IlrConnectionEntry, IlrDataConnection, IlrDecisionTable, IlrDecisionTree, IlrDefinition, IlrDependency, IlrElementDetails, IlrElementSummary, IlrEvent, IlrEventArtifact, IlrEventElement, IlrEventFlow, IlrEventObject, IlrEventObjectArtifact, IlrEventRule, IlrEventRuleArtifact, IlrEventRuleGroup, IlrExtractor, IlrFile, IlrFilter, IlrFunction, IlrFunctionTask, IlrHierarchy, IlrInitialValue, IlrLock, IlrManagedBranch, IlrMergeReport, IlrMessageMap, IlrModelElement, IlrNamedConstant, IlrOverriddenRule, IlrPackageElement, IlrParameter, IlrProfile, IlrProjectBOMEntry, IlrProjectElement, IlrProjectInfo, IlrProxy, IlrQuery, IlrReferencingBsln, IlrRelease, IlrResource, IlrRule, IlrRuleApp, IlrRuleAppProperty, IlrRuleArtifact, IlrRuleArtifactTag, IlrRuleflow, IlrRuleflowTag, IlrRulePackage, IlrRuleProject, IlrRuleProjectTag, IlrRuleset, IlrRulesetProperty, IlrRuleTask, IlrScenarioSuite, IlrScenarioSuiteKPIReport, IlrScenarioSuiteReport, IlrScenarioSuiteResource, IlrScenarioTestReport, IlrSchema, IlrScopeElement, IlrServer, IlrSimulation, IlrSmartView, IlrSnapshot, IlrTag, IlrTask, IlrTechnicalRule, IlrTemplate, IlrTestReport, IlrTestSuite, IlrTimestampBsln, IlrTypedElement, IlrUserSetting, IlrValidationAct, IlrVariable, IlrVariableSet, IlrVocabulary

public interface IlrElementHandle
extends Serializable, ilog.rules.commonbrm.model.IlrElement

Handle on an element in Decision Center.


Method Summary
 org.eclipse.emf.ecore.EClass eClass()
          Gets the EMF class of the element.
 boolean equals(IlrElementHandle handle, boolean considerVersion)
          Compares two handles and indicates whether they references the same Decision Center object.
 boolean equals(Object object)
           
 IlrModelInfo getModelInfo()
          Gets the model info object this element is associated with.
 IlrSession getSession()
          Gets the session from which this instance has been created.
 String getType()
          Gets the fully qualified name of the EMF type of the element.
 Object getValue(org.eclipse.emf.ecore.EStructuralFeature feature)
          Gets the value of the given feature.
 int hashCode()
           
 boolean isNew()
          Indicates whether this handle represents a new object, that is, not committed in the database.
 String toIdString()
          Gets a string representation of the handle.
 
Methods inherited from interface ilog.rules.commonbrm.model.IlrElement
getPropertyValue, getPropertyValue, isInstanceOf
 

Method Detail

getType

String getType()
Gets the fully qualified name of the EMF type of the element.

Returns:
The fully qualified name of the EMF type.
See Also:
eClass()

getSession

IlrSession getSession()
Gets the session from which this instance has been created.

Returns:
The session of the handle.

getModelInfo

IlrModelInfo getModelInfo()
Gets the model info object this element is associated with.

Returns:
The model info.

toIdString

String toIdString()
Gets a string representation of the handle.

See Also:
IlrSession.stringToElementHandle(String)

eClass

org.eclipse.emf.ecore.EClass eClass()
Gets the EMF class of the element.

Specified by:
eClass in interface ilog.rules.commonbrm.model.IlrElement
Returns:
An EMF class.

equals

boolean equals(IlrElementHandle handle,
               boolean considerVersion)
Compares two handles and indicates whether they references the same Decision Center object.

Parameters:
handle - The handle to compare.
considerVersion - If true, the comparison is done considering the versions. Otherwise, the elements are compared regardless of the versions.
Returns:
true If both handles reference the same Decision Center object

isNew

boolean isNew()
Indicates whether this handle represents a new object, that is, not committed in the database.

Returns:
True if the element represents a new object, and false otherwise, that is, if the element already has some versions committed in the database.

getValue

Object getValue(org.eclipse.emf.ecore.EStructuralFeature feature)
                throws IlrObjectNotFoundException
Gets the value of the given feature.

Depending on the type of this object (details, summary, or simple handle) and depending on the feature (containment/multivalued reference), this operation may perform a call to the database.

Throws:
IlrObjectNotFoundException - If this element cannot be found in the database while requesting one of its properties.
Parameters:
feature - An EMF feature.
Returns:
An object representing the feature's value.
See Also:
IlrElementDetails.getRawValue(org.eclipse.emf.ecore.EStructuralFeature)

equals

boolean equals(Object object)
Overrides:
equals in class Object

hashCode

int hashCode()
Overrides:
hashCode in class Object

Decision Center API

© Copyright IBM Corp. 1987, 2013