com.metamatrix.metadata.runtime.api
Interface Model

All Superinterfaces:
MetadataObject, java.io.Serializable
All Known Implementing Classes:
BasicModel

public interface Model
extends MetadataObject

Instances of this interface represent Models in a Virtual Database. The values of a Model are analogous to a DataSource or a Virtual DataSource.


Field Summary
static short PRIVATE
           
static short PUBLIC
           
 
Method Summary
 void enableMutliSourceBindings(boolean isEnabled)
          Enable the model to have multiple connector bindings associated by passing in true.
 java.util.List getConnectorBindingNames()
          Return the connector binding name(s).
 java.util.Date getDateVersioned()
          Get the date this model was versioned.
 java.lang.String getDescription()
          Return the description
 java.lang.String getGUID()
          Return the global unique identifier for this Virtual Databse.
 int getModelType()
          Return the type of model
 java.lang.String getModelTypeName()
          Returns the String version of the model type.
 java.lang.String getModelURI()
          Return the model uri.
 java.lang.String getVersion()
           
 java.lang.String getVersionedBy()
          Get the name of the person who versioned this model.
 short getVisibility()
           
 boolean isMaterialization()
          Check whether this model is a materialization of a virtual group.
 boolean isMultiSourceBindingEnabled()
          Returns true if the model has been enabled to have multiple connector bindings assigned.
 boolean isPhysical()
          Return boolean indicating if this model is of a physical type.
 boolean isVisible()
          Returns true if the model is visible to the use for querying
 boolean requireConnectorBinding()
          Return boolean indicating whether the model requires connector bindings.
 boolean supportsMultiSourceBindings()
          Returns true if the model, based on its model type, supports mutliple connector bindings.
 
Methods inherited from interface com.metamatrix.metadata.runtime.api.MetadataObject
clone, compareTo, equals, getFullName, getID, getName, getProperties, getVirtualDatabaseID, toString
 

Field Detail

PRIVATE

static final short PRIVATE
See Also:
Constant Field Values

PUBLIC

static final short PUBLIC
See Also:
Constant Field Values
Method Detail

getVersion

java.lang.String getVersion()

getDescription

java.lang.String getDescription()
Return the description

Returns:
String

getGUID

java.lang.String getGUID()
Return the global unique identifier for this Virtual Databse.

Returns:
String

getConnectorBindingNames

java.util.List getConnectorBindingNames()
Return the connector binding name(s). The only time this list would have more than one connector binding name, is if the model supports (@see #supportsMultiSourceBindings()).

Returns:
Since:
4.2

supportsMultiSourceBindings

boolean supportsMultiSourceBindings()
Returns true if the model, based on its model type, supports mutliple connector bindings. If true, isMultiSourceBindingEnabled() to determine if the model has been flagged so that the user can actually assign multi connector bindngs.

Returns:
Since:
4.2

isMultiSourceBindingEnabled

boolean isMultiSourceBindingEnabled()
Returns true if the model has been enabled to have multiple connector bindings assigned.

Returns:
Since:
4.2

isPhysical

boolean isPhysical()
Return boolean indicating if this model is of a physical type.

Returns:
boolean true if it contains physical group(s).

isMaterialization

boolean isMaterialization()
Check whether this model is a materialization of a virtual group.

Returns:
Returns the isMaterialization.
Since:
4.2

isVisible

boolean isVisible()
Returns true if the model is visible to the use for querying

Returns:
boolean

getVisibility

short getVisibility()

requireConnectorBinding

boolean requireConnectorBinding()
Return boolean indicating whether the model requires connector bindings.

Returns:
boolean

getModelType

int getModelType()
Return the type of model

Returns:

getModelTypeName

java.lang.String getModelTypeName()
Returns the String version of the model type.

Returns:

getModelURI

java.lang.String getModelURI()
Return the model uri.

Returns:

getDateVersioned

java.util.Date getDateVersioned()
Get the date this model was versioned.

Returns:
The model's version date.

getVersionedBy

java.lang.String getVersionedBy()
Get the name of the person who versioned this model.

Returns:
The name of the Model versioner.

enableMutliSourceBindings

void enableMutliSourceBindings(boolean isEnabled)
Enable the model to have multiple connector bindings associated by passing in true.

Parameters:
isEnabled -
Since:
4.2
See Also:
to determine if the model is enabled. Just because a model supports mutliple bindings, does not mean it will be enabled.


Copyright © 2009. All Rights Reserved.