com.corticon.eclipse.studio.test.testsheet.core

Interface ITestsheetModelAPI

All Superinterfaces:

IModelAPI

All Known Subinterfaces:

ITestsheetTreeSetModelAPI

public interface ITestsheetModelAPI
extends IModelAPI

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addTestsheet() Add a new Testsheet to the Ruletest instance.
com.corticon.rulesemf.canonicaltestmodel.testsheet.Input	createInput() Create and return a new Input instance.
com.corticon.rulesemf.canonicaltestmodel.testsheet.Output	createOutput() Create and return a new Output instance.
com.corticon.rulesemf.canonicaltestmodel.testsheet.PostedMessage	createPostedMessage() Create and return a new PostedMessage instance.
com.corticon.rulesemf.canonicaltestmodel.testsheet.Input	findInput() Finder for Input.
com.corticon.rulesemf.canonicaltestmodel.testsheet.Output	findOutput(boolean abExpected) Finder for Output.
com.corticon.rulesemf.assetmodel.RuletestAsset	findRuletestAsset() Find the RuletestAsset for this Testsheet.
com.corticon.rulesemf.canonicaltestmodel.testsheet.Testsheet	findTestsheet() Finder for Testsheet.
com.corticon.rulesemf.assetmodel.TestsheetAsset	findTestsheetAsset() Finder for TestsheetAsset.
com.corticon.rulesemf.assetmodel.TestsheetAsset	findTestsheetAsset(int index) Finder for TestsheetAsset based on the given index.
int	findTestsheetAssetIndex(com.corticon.rulesemf.assetmodel.TestsheetAsset aTestsheetAsset) Returns the index of given TestsheetAsset
com.corticon.rulesemf.canonicalrulemodel.ruleflow.RuleActivity	findTestSubject() Return the Test Subject associated with this Testsheet.
com.corticon.rulesemf.canonicaltestmodel.testsheet.DatabaseMode	getDatabaseMode()
com.corticon.rulesemf.canonicaltestmodel.testsheet.ReturnEntityMode	getReturnEntityMode()
IRuleflowDiagramModelAPI	getRuleflowDiagramModelAPI() Return an instance of the Ruleflow diagram model API with its state set identically to *this* API.
IRuleflowModelAPI	getRuleflowModelAPI() Return an instance of the Ruleflow model API with its state set identically to *this* API.
IRulesheetModelAPI	getRulesheetModelAPI() Return an instance of the Rulesheet model API with its state set identically to *this* API.
IRulesheetTableModelAPI	getRulesheetTableModelAPI() Return an instance of the Rulesheet table model API with its state set identically to *this* API.
int	getSelectedTestsheetIndex() Returns the index of currently selected Testsheet.
com.corticon.rulesemf.viewtestmodel.ruletest.tabfolder.TestTab	getSelectedTestTab() Deprecated.
java.lang.String	getTestSubjectPath() Return the test subject user-friendly path.
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.
java.lang.String	getTooltip() Return the Validation Messages as a String value that are associated with the Testsheet currently selected.
java.lang.String	getTooltip(int aiTestAssetIndex) Return the Validation Messages as a String value that are associated with the Testsheet at the index passed in.
IVocabularyModelAPI	getVocabularyModelAPI() Return an instance of the Vocabulary model API with its state set identically to *this* API.
boolean	isEnabledCascade() Determine whether the cascade check-box menu item should be enabled.
boolean	isEnabledExecuteTest() Determine whether the execute test function should be enabled.
boolean	isRemoteExecutionVariablesAvailable() Determine whether the test subject is currently pointing to a remote decision service.
boolean	isTestSubjectAvailable() Determine whether the test subject is currently available.
boolean	isTestSubjectRuleflow() Determine whether the test subject is a Ruleflow.
boolean	isTestSubjectRulesheet() Determine whether the test subject is a Rulesheet.
boolean	isVocabularyAvailable() Determine whether the Vocabulary for the test subject is available.
boolean	removeTestsheet(com.corticon.rulesemf.canonicaltestmodel.testsheet.Testsheet aTestsheet) Remove the specified Testsheet from its respective Ruletest asset.
boolean	setCascade(boolean abCascade) Set the Cascade state for this Testsheet, meaning that that the Testsheet takes it input from the output of the prior Testsheet.
boolean	setDatabaseMode(com.corticon.rulesemf.canonicaltestmodel.testsheet.DatabaseMode aDatabaseMode)
boolean	setReturnEntityMode(com.corticon.rulesemf.canonicaltestmodel.testsheet.ReturnEntityMode aReturnEntityMode)
boolean	setRuleActivity(com.corticon.rulesemf.canonicalrulemodel.ruleflow.RuleActivity aRuleActivity) Set the RuleActivity for this Testsheet (i.e., either Ruleflow or PRuleset).
void	setVocabularyModelAPI(IVocabularyModelAPI aIVocabularyModelAPI) Setter for Vocabulary model API instance.

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

addTestsheet

boolean addTestsheet()

Add a new Testsheet to the Ruletest instance.

Returns:

true if the command was successful.

createInput

com.corticon.rulesemf.canonicaltestmodel.testsheet.Input createInput()

Create and return a new Input instance.

Returns:

Input instance.

createOutput

com.corticon.rulesemf.canonicaltestmodel.testsheet.Output createOutput()

Create and return a new Output instance.

Returns:

Output instance.

createPostedMessage

com.corticon.rulesemf.canonicaltestmodel.testsheet.PostedMessage createPostedMessage()

Create and return a new PostedMessage instance.

Returns:

PostedMessage instance.

findInput

com.corticon.rulesemf.canonicaltestmodel.testsheet.Input findInput()

Finder for Input.

Returns:

Instance of Input.

findOutput

com.corticon.rulesemf.canonicaltestmodel.testsheet.Output findOutput(boolean abExpected)

Finder for Output.

Parameters:

abExpected - true to return expected Output instance.

Returns:

Instance of Output.

findRuletestAsset

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

Find the RuletestAsset for this Testsheet.

Returns:

RuletestAsset instance.

findTestsheet

com.corticon.rulesemf.canonicaltestmodel.testsheet.Testsheet findTestsheet()

Finder for Testsheet.

Returns:

Instance of Testsheet.

findTestsheetAsset

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

Finder for TestsheetAsset.

Returns:

Instance of TestsheetAsset.

findTestsheetAsset

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

Finder for TestsheetAsset based on the given index.

Returns:

Instance of TestsheetAsset based on the index.

findTestsheetAssetIndex

int findTestsheetAssetIndex(com.corticon.rulesemf.assetmodel.TestsheetAsset aTestsheetAsset)

Returns the index of given TestsheetAsset

Returns:

index of TestsheetAsset.

findTestSubject

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

Return the Test Subject associated with this Testsheet.

Returns:

RuleActivity (test subject).

getSelectedTestsheetIndex

int getSelectedTestsheetIndex()

Returns the index of currently selected Testsheet.

Returns:

Index of currently selected Testsheet.

getSelectedTestTab

com.corticon.rulesemf.viewtestmodel.ruletest.tabfolder.TestTab getSelectedTestTab()

Deprecated.

Convenience method to get reference to currently selected TestTab.

Returns:

Currently selected TestTab, null if not found

getRuleflowModelAPI

IRuleflowModelAPI getRuleflowModelAPI()

Return an instance of the Ruleflow model API with its state set identically to *this* API.

Returns:

Instance of IRulesheetModelAPI.

getRuleflowDiagramModelAPI

IRuleflowDiagramModelAPI getRuleflowDiagramModelAPI()

Return an instance of the Ruleflow diagram model API with its state set identically to *this* API.

Returns:

Instance of IRuleflowDiagramModelAPI.

getRulesheetModelAPI

IRulesheetModelAPI getRulesheetModelAPI()

Return an instance of the Rulesheet model API with its state set identically to *this* API.

Returns:

Instance of IRulesheetModelAPI.

getRulesheetTableModelAPI

IRulesheetTableModelAPI getRulesheetTableModelAPI()

Return an instance of the Rulesheet table model API with its state set identically to *this* API.

Returns:

Instance of IRulesheetTableModelAPI.

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.

getTestSubjectPath

java.lang.String getTestSubjectPath()

Return the test subject user-friendly path. This is the pathname that is displayed in the Ruletest editor path string, and can be either a local or remote decision service path.

Returns:

Test subject path.

getVocabularyModelAPI

IVocabularyModelAPI getVocabularyModelAPI()

Return an instance of the Vocabulary model API with its state set identically to *this* API.

Returns:

Instance of IVocabularyModelAPI();

isEnabledCascade

boolean isEnabledCascade()

Determine whether the cascade check-box menu item should be enabled.

Returns:

true if cascade function should be enabled.

isEnabledExecuteTest

boolean isEnabledExecuteTest()

Determine whether the execute test function should be enabled.

Returns:

true if function should be enabled.

isTestSubjectRulesheet

boolean isTestSubjectRulesheet()

Determine whether the test subject is a Rulesheet.

Returns:

true if the test subject is a Rulesheet.

isTestSubjectAvailable

boolean isTestSubjectAvailable()

Determine whether the test subject is currently available.

Returns:

true if test subject is available.

isRemoteExecutionVariablesAvailable

boolean isRemoteExecutionVariablesAvailable()

Determine whether the test subject is currently pointing to a remote decision service.

Returns:

true if test subject is pointing to a remote decision service.

isTestSubjectRuleflow

boolean isTestSubjectRuleflow()

Determine whether the test subject is a Ruleflow.

Returns:

true if the test subject is a Ruleflow.

isVocabularyAvailable

boolean isVocabularyAvailable()

Determine whether the Vocabulary for the test subject is available.

Returns:

true if Vocabulary is available.

removeTestsheet

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

Remove the specified Testsheet from its respective Ruletest asset.

Parameters:

aTestsheet - Testsheet to be removed.

setCascade

boolean setCascade(boolean abCascade)

Set the Cascade state for this Testsheet, meaning that that the Testsheet takes it input from the output of the prior Testsheet. Cascade affects both test execution and presentation.

Parameters:

abCascade - true to enable cascade for this Testsheet.

Returns:

true if the set command was successful.

setRuleActivity

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

Set the RuleActivity for this Testsheet (i.e., either Ruleflow or PRuleset). This method will also capture a reference to the Vocabulary associated with the test subject if it hasn't been explicitly established.

Parameters:

aRuleActivity - RuleActivity instance or null.

Returns:

true if the set command was successful.

setVocabularyModelAPI

void setVocabularyModelAPI(IVocabularyModelAPI aIVocabularyModelAPI)

Setter for Vocabulary model API instance.

Parameters:

aIVocabularyModelAPI - Vocabulary model API instance.

getTooltip

java.lang.String getTooltip()

Return the Validation Messages as a String value that are associated with the Testsheet currently selected.

Returns:

String Tooltip for the Testsheet

getTooltip

java.lang.String getTooltip(int aiTestAssetIndex)

Return the Validation Messages as a String value that are associated with the Testsheet at the index passed in.

Parameters:

int - Index of the Testsheet

Returns:

String Tooltip for the Testsheet

getDatabaseMode

com.corticon.rulesemf.canonicaltestmodel.testsheet.DatabaseMode getDatabaseMode()

setDatabaseMode

boolean setDatabaseMode(com.corticon.rulesemf.canonicaltestmodel.testsheet.DatabaseMode aDatabaseMode)

getReturnEntityMode

com.corticon.rulesemf.canonicaltestmodel.testsheet.ReturnEntityMode getReturnEntityMode()

setReturnEntityMode

boolean setReturnEntityMode(com.corticon.rulesemf.canonicaltestmodel.testsheet.ReturnEntityMode aReturnEntityMode)