jadex.bridge.modelinfo

Interface IModelInfo

All Known Implementing Classes:

BDIXModel, ModelInfo

public interface IModelInfo

This model interface represents the common properties of all component models. The common properties are transferable across platforms. Kernel-specific properties of locally loaded models can be accessed by fetching the raw model and casting it to the corresponding type (e.g. MBpmnModel).

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getAllImports() Get the imports including the package.
IArgument	getArgument(java.lang.String name) Get the argument.
IArgument[]	getArguments() Get the arguments.
java.lang.String[]	getBreakpoints() Get the possible breakpoint places in that model.
ConfigurationInfo	getConfiguration(java.lang.String name) Get the configurations.
java.lang.String[]	getConfigurationNames() Get the configurations.
ConfigurationInfo[]	getConfigurations() Get the configurations.
java.lang.String	getDescription() Get the model description.
IComponentFeatureFactory[]	getFeatures() Get the features.
java.lang.String	getFilename() Get the filename.
java.lang.String	getFullName() Get the full model name (package.name)
java.lang.String[]	getImports() Get the imports.
java.lang.String	getInstanceName() Get the default instance name.
java.lang.Boolean	getKeepalive(java.lang.String configname) Get the keepalive flag.
IMonitoringService.PublishEventLevel	getMonitoring(java.lang.String configname) Get the monitoring flag.
java.lang.String	getName() Get the name.
java.lang.String	getNameHint() Get the name hint for instances.
java.util.List<NFPropertyInfo>	getNFProperties() Get the nf properties.
java.lang.String	getPackage() Get the package name.
java.lang.String[]	getPredecessors() Get required predecessors (dependencies).
java.util.Map<java.lang.String,java.lang.Object>	getProperties() Get the properties.
java.lang.Object	getProperty(java.lang.String name, java.lang.ClassLoader cl) Get a parsed property.
ProvidedServiceInfo[]	getProvidedServices() Get the provided services.
java.lang.Object	getRawModel() Get the kernel-specific model.
IErrorReport	getReport() Get the report.
IResourceIdentifier	getResourceIdentifier() Return the resource identifier.
IArgument	getResult(java.lang.String name) Get the results.
IArgument[]	getResults() Get the results.
RequiredServiceInfo	getService(java.lang.String name) Get the required service.
RequiredServiceInfo[]	getServices() Get the required services.
SubcomponentTypeInfo[]	getSubcomponentTypes() Get the subcomponent names.
java.lang.String[]	getSuccessors() Get declared successors (dependencies).
java.lang.Boolean	getSuspend(java.lang.String configname) Get the suspend flag.
java.lang.Boolean	getSynchronous(java.lang.String configname) Get the synchronous flag.
java.lang.String	getType() Get the component type (i.e.
boolean	isStartable() Is the model startable.

Method Detail

getName

java.lang.String getName()

Get the name.

Returns:

The name.

getInstanceName

java.lang.String getInstanceName()

Get the default instance name.

Returns:

The instance name.

getPredecessors

java.lang.String[] getPredecessors()

Get required predecessors (dependencies).

getSuccessors

java.lang.String[] getSuccessors()

Get declared successors (dependencies).

getPackage

java.lang.String getPackage()

Get the package name.

Returns:

The package name.

getFullName

java.lang.String getFullName()

Get the full model name (package.name)

Returns:

The full name.

getDescription

java.lang.String getDescription()

Get the model description.

Returns:

The model description.

getImports

java.lang.String[] getImports()

Get the imports.

Returns:

The imports.

getAllImports

java.lang.String[] getAllImports()

Get the imports including the package.

Returns:

The imports.

getReport

IErrorReport getReport()

Get the report.

Returns:

The report.

getConfigurationNames

java.lang.String[] getConfigurationNames()

Get the configurations.

Returns:

The configuration.

getConfigurations

ConfigurationInfo[] getConfigurations()

Get the configurations.

Returns:

The configuration.

getConfiguration

ConfigurationInfo getConfiguration(java.lang.String name)

Get the configurations.

Returns:

The configuration.

getArguments

IArgument[] getArguments()

Get the arguments.

Returns:

The arguments.

getArgument

IArgument getArgument(java.lang.String name)

Get the argument.

Returns:

The argument.

getResults

IArgument[] getResults()

Get the results.

Returns:

The results.

getResult

IArgument getResult(java.lang.String name)

Get the results.

Parameters:

name - The name.

Returns:

The results.

isStartable

boolean isStartable()

Is the model startable.

Returns:

True, if startable.

getType

java.lang.String getType()

Get the component type (i.e. kernel).

Returns:

The component type.

getFilename

java.lang.String getFilename()

Get the filename.

Returns:

The filename.

getProperties

java.util.Map<java.lang.String,java.lang.Object> getProperties()

Get the properties. Arbitrary properties that can e.g. be used to define model-specific settings to configure tools.

Returns:

The properties.

getProperty

java.lang.Object getProperty(java.lang.String name,
                             java.lang.ClassLoader cl)

Get a parsed property. Unlike raw properties, which may be parsed or unparsed, this method always returns parsed property values.

Parameters:

name - The property name.

Returns:

The property value.

getNFProperties

java.util.List<NFPropertyInfo> getNFProperties()

Get the nf properties.

Returns:

The nf properties.

getResourceIdentifier

IResourceIdentifier getResourceIdentifier()

Return the resource identifier.

Returns:

The resource identifier.

getServices

RequiredServiceInfo[] getServices()

Get the required services.

Returns:

The required services.

getService

RequiredServiceInfo getService(java.lang.String name)

Get the required service.

Returns:

The required service.

getProvidedServices

ProvidedServiceInfo[] getProvidedServices()

Get the provided services.

Returns:

The provided services.

getSuspend

java.lang.Boolean getSuspend(java.lang.String configname)

Get the suspend flag.

Parameters:

configname - The configname.

Returns:

The suspend flag value.

getSynchronous

java.lang.Boolean getSynchronous(java.lang.String configname)

Get the synchronous flag.

Parameters:

configname - The configname.

Returns:

The synchronous flag value.

getKeepalive

java.lang.Boolean getKeepalive(java.lang.String configname)

Get the keepalive flag.

Parameters:

configname - The configname.

Returns:

The keepalive flag value.

getMonitoring

IMonitoringService.PublishEventLevel getMonitoring(java.lang.String configname)

Get the monitoring flag.

Parameters:

monitoring - The monitoring.

Returns:

The monitoring flag value.

getSubcomponentTypes

SubcomponentTypeInfo[] getSubcomponentTypes()

Get the subcomponent names.

getBreakpoints

java.lang.String[] getBreakpoints()

Get the possible breakpoint places in that model.

Returns:

The breakpoints.

getRawModel

java.lang.Object getRawModel()

Get the kernel-specific model.

Returns:

The kernel-specific model when loaded locally, null for remote models.

getFeatures

IComponentFeatureFactory[] getFeatures()

Get the features.

Returns:

The features

getNameHint

java.lang.String getNameHint()

Get the name hint for instances.

Returns:

the name hint