com.corticon.eclipse.studio.test.ruletest.core

Interface IRuletestModelAPI

All Superinterfaces:

IModelAPI

All Known Subinterfaces:

IRuletestTabFolderModelAPI

public interface IRuletestModelAPI
extends IModelAPI

The Ruletest Model API provides a standardized interface for querying and manipulating canonical Ruletest assets.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addTestsheet() Create all necessary canonical objects for this model
com.corticon.rulesemf.assetmodel.RuletestAsset	createRuletest(org.eclipse.emf.common.util.URI aURIRuletest) Create a new Ruletest Resource with the specified URI.
void	deleteRuletest() Delete the Ruletest and remove its respective Resource.
com.corticon.rulesemf.canonicaltestmodel.ruletest.Ruletest	findRuletest() Finder for Ruletest.
com.corticon.rulesemf.assetmodel.RuletestAsset	findRuletestAsset() Finder for RuletestAsset.
com.corticon.rulesemf.assetmodel.TestsheetAsset	findTestsheetAsset(int aiIndex) Find the Testsheet asset corresponding to the specified index.
java.util.Date	getDecisionServiceEffectiveTargetDate() Return the Date, which is the effective target date of the Decision Service to use during Remote Execution of the currently active Testsheet
java.lang.Integer	getDecisionServiceMajorVersion() Return the Integer, which is the major version of the Decision Service to use during Remote Execution of the currently active Testsheet
java.lang.Integer	getDecisionServiceMinorVersion() Return the Integer, which is the minor version of the Decision Service to use during Remote Execution of the currently active Testsheet
java.lang.String	getDecisionServiceName() Return the String, which is the name of the Decision Service to use during Remote Execution of the currently active Testsheet
java.lang.String	getNewRuletestName(org.eclipse.emf.common.util.URI aURIContainer) Given the URI of a container in the storage system, create a new unique Ruletest name using sequence numbers if necessary.
java.lang.String	getRemoteServerUri() Return the String URI of the location of the Remote Server of the currently active Testsheet
com.corticon.rulesemf.canonicalrulemodel.ruleflow.RuleActivity	getRuleActivity() Return the RuleActivity (i.e., either Ruleflow or PRuleset) of currently active Testsheet.
IModelAPI	getSecondaryAPI() Return the secondary (nested) API.
int	getSelectedTestsheetIndex() Returns the index of currently selected Testsheet.
org.eclipse.emf.common.util.URI	getTestSubjectURI() Return the URI of the test subject of the currently active Testsheet, even if the test subject is missing.
IDomain	getVocabulary() Get a reference to the Vocabulary root domain.
IVocabularyModelAPI	getVocabularyModelAPI() Return an instance of the Vocabulary model API with its state set identically to *this* API.
org.eclipse.emf.common.util.URI	getVocabularyURI() Return the URI of the Vocabulary, even if that Vocabulary is missing.
boolean	isTestSubjectAvailable() Determine whether the test subject is currently available.
boolean	isVocabularyAvailable() Determine whether the Vocabulary for this Ruletest is available.
boolean	linkToPrevious(int aiIndex, boolean abCascade) Set the Cascade state of Testsheet based on given index of TestsheetAsset.
boolean	removeTestsheet(com.corticon.rulesemf.canonicaltestmodel.testsheet.Testsheet aTestsheet) Remove a Testsheet from the Ruletest instance.
boolean	renameRuletest(org.eclipse.emf.common.util.URI aURIRuletestNew) Rename the specified Ruletest.
boolean	setDecisionServiceEffectiveTargetDate(java.util.Date aEffectiveTargetDate) Set the Remote Server Decision Service Effective Target Date to currently active Testsheet.
boolean	setDecisionServiceMajorVersion(java.lang.Integer aintDecisionServiceMajorVersion) Set the Remote Server Decision Service Major version to currently active Testsheet.
boolean	setDecisionServiceMinorVersion(java.lang.Integer aintDecisionServiceMinorVersion) Set the Remote Server Decision Service Minor version to currently active Testsheet.
boolean	setDecisionServiceName(java.lang.String astrDecisionServiceName) Set the Remote Server Decision Service Name to currently active Testsheet.
boolean	setRemoteServerURI(java.lang.String astrRemoteServerUri) Set the Remote Server URI to currently active Testsheet.
boolean	setRuleActivity(com.corticon.rulesemf.canonicalrulemodel.ruleflow.RuleActivity aRuleActivity) Set the RuleActivity (i.e., either Ruleflow or PRuleset) to currently active Testsheet.
boolean	setRuleActivity(org.eclipse.emf.common.util.URI aURIRuleActivity) Set the RuleActivity based on the URI (i.e., either Ruleflow or PRuleset) to currently active Testsheet.
void	setSecondaryAPI(IModelAPI aIModelAPISecondary) Set a reference to the secondary (nested) API.
boolean	setTestsheetCascade(int aiIndex, boolean cascade) Deprecated. Use linkToPrevious(int,boolean) instead
boolean	setTestsheetIndex(int aiIndex) Set the index of the current TestsheetAsset.
boolean	setVocabulary(IDomain aDomain) Set a reference to the Vocabulary.

Methods inherited from interface com.corticon.eclipse.core.IModelAPI

activate, addAnnotation, addBatchedModelListener, addLowLevelModelListener, addModelListener, addResourceListener, addView, beginTransaction, cancelTransaction, canSetSupportedLocales, closeResource, createResource, deleteAnnotation, deleteAnnotation, deleteAnnotation, deleteResource, displayMessageBox, dispose, doPostLoadValidation, doSmartValidation, endTransaction, endTransaction, flushCommandStack, formatValidationMessageLocation, formatValidationMessageText, getAllLocalesProvidingCompleteLocalization, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getAPIContextObject, getAsset, getBaseAttribute, getBaseAttributeString, getBatchedModelListeners, getBuildNumber, getBuildNumberOfLastValidationRulesChange, getEditingDomain, getErrors, getErrors, getIndexByLocale, getLocale, getLocalizedAttribute, getLocalizedAttributeString, getLowLevelModelListeners, getMajorServiceNumber, getMajorVersionNumber, getMessage, getMessage, getMessageBase, getMessageBoxDelegate, getMinorServiceNumber, getMinorVersionNumber, getModelAPIState, getModelListeners, getNewResourceName, getPersistenceServicesDelegate, getPreferences, getPrimaryResource, getPrimaryResourceURI, getScrollableMessageDelegate, getSupportedLocales, getSuppressBrokenLinkValidation, getSuppressValidation, getToolTip, getUpdateStamp, getUserInterfaceInfoDelegate, getValidationMessageCount, getValidationMessageCount, getValidationMessageCount, getValidationMessageCount, getValidationMessages, getValidationMessages, getWarnings, getWarnings, handleException, hasErrors, hasErrors, hasErrors, hasErrors, hasErrors, hasErrors, hasErrorsOrWarnings, hasErrorsOrWarnings, hasErrorsOrWarnings, hasErrorsOrWarnings, hasErrorsOrWarnings, hasErrorsOrWarnings, hasWarnings, hasWarnings, hasWarnings, hasWarnings, hasWarnings, hasWarnings, isAPIStateEstablished, isEnabledRedo, isEnabledUndo, isInhibitNotification, isLoaded, isOperationModeNormal, isOperationModeRedo, isOperationModeUndo, isPassive, isPostLoadInProgress, isPrimaryResourceSet, isReadOnly, isResourceActivated, isResourceConflict, isResourceDemandLoaded, isResourceLoaded, isScrollableMessageDelegateAvailable, isShowCanonicalValidationMessages, isSuppressModifiedFlagUpdates, isSuppressPostLoad, isTransactionInProgress, isValid, isValid, loadResource, loadResource, loadResource, newInstance, noOperation, postLoad, postMethod, postMethod, postsave, preMethod, presave, redo, reloadResource, remapResource, remapResource, removeBatchedModelListener, removeLowLevelModelListener, removeModelListener, removeResource, removeResourceListener, removeView, renameResource, rollbackTransaction, saveAll, saveResource, setAnnotation, setAPIContextObject, setAPIState, setBuildNumber, setEditingDomain, setInhibitNotification, setLocale, setMajorServiceNumber, setMajorVersionNumber, setMessageBoxDelegate, setMinorServiceNumber, setMinorVersionNumber, setModelAPIState, setModelListeners, setPassive, setPersistenceServicesDelegate, setPostLoadInProgress, setPreferencesDelegate, setPrimaryResource, setReadOnly, setScrollableMessageDelegate, setSupportedLocales, setSuppressBrokenLinkValidation, setSuppressModifiedFlagUpdates, setSuppressPostLoad, setSuppressValidation, setUserInterfaceInfoDelegate, undo, unloadResource, validate, validateLicense

Method Detail

createRuletest

com.corticon.rulesemf.assetmodel.RuletestAsset createRuletest(org.eclipse.emf.common.util.URI aURIRuletest)

Create a new Ruletest Resource with the specified URI. Examples:

platform:/LoanProject/Loan.ert platform:/FIM/Allocation.ert

This function creates a new Ruletest Resource in the editing domain, with a new RuletestAsset instance as the root object.

Parameters:

aURIRuletest - New Ruletest URI.

Returns:

New RuletestAsset instance.

deleteRuletest

void deleteRuletest()

Delete the Ruletest and remove its respective Resource.

findRuletest

com.corticon.rulesemf.canonicaltestmodel.ruletest.Ruletest findRuletest()

Finder for Ruletest.

Returns:

Instance of Ruletest.

findRuletestAsset

com.corticon.rulesemf.assetmodel.RuletestAsset findRuletestAsset()

Finder for RuletestAsset.

Returns:

Instance of RuletestAsset.

findTestsheetAsset

com.corticon.rulesemf.assetmodel.TestsheetAsset findTestsheetAsset(int aiIndex)

Find the Testsheet asset corresponding to the specified index.

Parameters:

aiIndex - Index of Testsheet in asset list.

Returns:

Instance of TestsheetAsset.

getNewRuletestName

java.lang.String getNewRuletestName(org.eclipse.emf.common.util.URI aURIContainer)

Given the URI of a container in the storage system, create a new unique Ruletest name using sequence numbers if necessary.

Example (URI shown is for Eclipse platform):

platform:/Examples/TradeAllocation/Tests

Parameters:

aURIContainer - URI of container.

Returns:

New Ruletest name.

getRuleActivity

com.corticon.rulesemf.canonicalrulemodel.ruleflow.RuleActivity getRuleActivity()

Return the RuleActivity (i.e., either Ruleflow or PRuleset) of currently active Testsheet.

Returns:

aRuleActivity RuleActivity instance or null.

getRemoteServerUri

java.lang.String getRemoteServerUri()

Return the String URI of the location of the Remote Server of the currently active Testsheet

Returns:

String location of the Remote Server or null.

getDecisionServiceName

java.lang.String getDecisionServiceName()

Return the String, which is the name of the Decision Service to use during Remote Execution of the currently active Testsheet

Returns:

String Decision Service Name to be used during Remote Execution or null.

getDecisionServiceMajorVersion

java.lang.Integer getDecisionServiceMajorVersion()

Return the Integer, which is the major version of the Decision Service to use during Remote Execution of the currently active Testsheet

Returns:

Integer Decision Sevice Major Version to be used during Remote Execution or null.

getDecisionServiceMinorVersion

java.lang.Integer getDecisionServiceMinorVersion()

Return the Integer, which is the minor version of the Decision Service to use during Remote Execution of the currently active Testsheet

Returns:

Integer Decision Service Minor Version to be used during Remote Execution or null.

getDecisionServiceEffectiveTargetDate

java.util.Date getDecisionServiceEffectiveTargetDate()

Return the Date, which is the effective target date of the Decision Service to use during Remote Execution of the currently active Testsheet

Returns:

Date Decision Service Effective Target Date to be used during Remote Execution or null.

getSecondaryAPI

IModelAPI getSecondaryAPI()

Return the secondary (nested) API.

Returns:

Secondary API instance.

getSelectedTestsheetIndex

int getSelectedTestsheetIndex()

Returns the index of currently selected Testsheet.

Returns:

Index of currently selected Testsheet.

getTestSubjectURI

org.eclipse.emf.common.util.URI getTestSubjectURI()

Return the URI of the test subject of the currently active Testsheet, even if the test subject is missing.

Returns:

URI of test subject.

getVocabulary

IDomain getVocabulary()

Get a reference to the Vocabulary root domain.

Returns:

IDomain instance (Vocabulary root).

getVocabularyModelAPI

IVocabularyModelAPI getVocabularyModelAPI()

Return an instance of the Vocabulary model API with its state set identically to *this* API. This Vocabulary API instance can be used for parsing utilities or any other purpose.

Returns:

Instance of IVocabularyModelAPI.

getVocabularyURI

org.eclipse.emf.common.util.URI getVocabularyURI()

Return the URI of the Vocabulary, even if that Vocabulary is missing.

Returns:

URI of Vocabulary.

isTestSubjectAvailable

boolean isTestSubjectAvailable()

Determine whether the test subject is currently available.

Returns:

true if test subject is available.

isVocabularyAvailable

boolean isVocabularyAvailable()

Determine whether the Vocabulary for this Ruletest is available.

Returns:

true if Vocabulary is available.

linkToPrevious

boolean linkToPrevious(int aiIndex,
                     boolean abCascade)

Set the Cascade state of Testsheet based on given index of TestsheetAsset.

Parameters:

aiIndex - Index of Testsheet Asset.

abCascade - true to link to previous.

Returns:

true if the command was successful.

removeTestsheet

boolean removeTestsheet(com.corticon.rulesemf.canonicaltestmodel.testsheet.Testsheet aTestsheet)

Remove a Testsheet from the Ruletest instance.

Parameters:

aTestsheet - Testsheet instance to be removed.

Returns:

true if the command was successful.

renameRuletest

boolean renameRuletest(org.eclipse.emf.common.util.URI aURIRuletestNew)

Rename the specified Ruletest.

Parameters:

aURIRuletestNew - New Ruletest URI.

Returns:

true if the command was successful.

setRuleActivity

boolean setRuleActivity(com.corticon.rulesemf.canonicalrulemodel.ruleflow.RuleActivity aRuleActivity)

Set the RuleActivity (i.e., either Ruleflow or PRuleset) to currently active Testsheet.

Parameters:

aRuleActivity - RuleActivity instance or null.

Returns:

true if the set command was successful.

setRuleActivity

boolean setRuleActivity(org.eclipse.emf.common.util.URI aURIRuleActivity)

Set the RuleActivity based on the URI (i.e., either Ruleflow or PRuleset) to currently active Testsheet.

Parameters:

aURIRuleActivity - Location of the RuleActivity or null.

Returns:

true if the set command was successful.

setRemoteServerURI

boolean setRemoteServerURI(java.lang.String astrRemoteServerUri)

Set the Remote Server URI to currently active Testsheet.

Parameters:

astrRemoteServerUri - String that points to the remote server or null.

Returns:

true if the set command was successful.

setDecisionServiceName

boolean setDecisionServiceName(java.lang.String astrDecisionServiceName)

Set the Remote Server Decision Service Name to currently active Testsheet.

Parameters:

astrDecisionServiceName - String that is used as the Decision Service Name for remote executions or null.

Returns:

true if the set command was successful.

setDecisionServiceMajorVersion

boolean setDecisionServiceMajorVersion(java.lang.Integer aintDecisionServiceMajorVersion)

Set the Remote Server Decision Service Major version to currently active Testsheet.

Parameters:

aintDecisionServiceMajorVersion - Integer that is used as the Decision Service Name for remote executions or null.

Returns:

true if the set command was successful.

setDecisionServiceMinorVersion

boolean setDecisionServiceMinorVersion(java.lang.Integer aintDecisionServiceMinorVersion)

Set the Remote Server Decision Service Minor version to currently active Testsheet.

Parameters:

aintDecisionServiceMinorVersion - Integer that is used as the Decision Service Name for remote executions or null.

Returns:

true if the set command was successful.

setDecisionServiceEffectiveTargetDate

boolean setDecisionServiceEffectiveTargetDate(java.util.Date aEffectiveTargetDate)

Set the Remote Server Decision Service Effective Target Date to currently active Testsheet.

Parameters:

aEffectiveTargetDate - date that is used as the Decision Service Name for remote executions or null.

Returns:

true if the set command was successful.

setSecondaryAPI

void setSecondaryAPI(IModelAPI aIModelAPISecondary)

Set a reference to the secondary (nested) API.

Parameters:

aIModelAPISecondary - Secondary API instance.

setTestsheetCascade

boolean setTestsheetCascade(int aiIndex,
                          boolean cascade)

Deprecated. Use linkToPrevious(int,boolean) instead

Set the Cascade state of Testsheet based on given index of TestsheetAsset.

Parameters:

aiIndex - Index of Testsheet Asset.

cascade - Cascade state for the Testsheet.

Returns:

true if the command was successful.

setTestsheetIndex

boolean setTestsheetIndex(int aiIndex)

Set the index of the current TestsheetAsset.

Parameters:

aiIndex - Index of current Testsheet Asset.

Returns:

true if the command was successful.

setVocabulary

boolean setVocabulary(IDomain aDomain)

Set a reference to the Vocabulary.

Parameters:

aIDomain - Vocabulary root domain.

Returns:

true if the command was successful.

addTestsheet

boolean addTestsheet()

Create all necessary canonical objects for this model

Returns:

true if the command was successful.