com.metamatrix.metadata.runtime.api
Interface VirtualDatabase

All Superinterfaces:

MetadataObject, java.io.Serializable

All Known Implementing Classes:

BasicVirtualDatabase

public interface VirtualDatabase
extends MetadataObject

The VirtualDatabase identifies a collection of DataSources and Virtual DataSources that a client can connect to and interrogate its metadata.

Nested Class Summary

static interface

VirtualDatabase.ModifiableAttributes Defines the VDB attributes that can be modified.

Method Summary

java.lang.String	getCreatedBy() Return the user name who create this Virtual Database.
java.util.Date	getCreationDate() Return the date the Virtual Database was created.
java.util.Collection	getDataTypeIDs() Returns the DataTypeID's that exist in this virtual database.
java.lang.String	getDescription() Return the description.
java.lang.String	getFileName() Get this name of the VDB jar file.
java.lang.String	getGUID() Return the global unique identifier for this Virtual Databse.
java.util.Collection	getModelIDs() Returns the ModelID's that exist in this virtual database.
short	getStatus() Returns a short indicating if the status of the VirtualDatabase.
java.util.Date	getUpdateDate() Return the date the Virtual Database was updated.
java.lang.String	getUpdatedBy() Return the user name who update this version of the Virtual Database.
java.lang.String	getVersionBy() Return the user name who create this version of the Virtual Database.
java.util.Date	getVersionDate() Return the date the Virtual Database was created.
boolean	hasWSDLDefined() Returns true if a WSDL is defined for this VDB
void	update(java.lang.String attribute, java.lang.Object value) Update a VDB attribute.

Methods inherited from interface com.metamatrix.metadata.runtime.api.MetadataObject

clone, compareTo, equals, getFullName, getID, getName, getProperties, getVirtualDatabaseID, toString

Method Detail

getDescription

java.lang.String getDescription()

Return the description.

Returns:

String

getModelIDs

java.util.Collection getModelIDs()

Returns the ModelID's that exist in this virtual database.

Returns:

Collection of the ModelID's contained in this VirtualDatabase

getStatus

short getStatus()

Returns a short indicating if the status of the VirtualDatabase. There are four status of the VirtualDatabase: "Incomplete", "Inactive", "Active", and "Deleted".

Returns:

boolean true indicates marked for deletion

getGUID

java.lang.String getGUID()

Return the global unique identifier for this Virtual Databse. This is the ProjectGUID that identifies the Design Time Configuration that created this VDB.

Returns:

String

getVersionDate

java.util.Date getVersionDate()

Return the date the Virtual Database was created.

Returns:

Date

getVersionBy

java.lang.String getVersionBy()

Return the user name who create this version of the Virtual Database.

Returns:

String

getCreationDate

java.util.Date getCreationDate()

Return the date the Virtual Database was created.

Returns:

Date

getCreatedBy

java.lang.String getCreatedBy()

Return the user name who create this Virtual Database.

Returns:

String

getUpdateDate

java.util.Date getUpdateDate()

Return the date the Virtual Database was updated.

Returns:

Date

getUpdatedBy

java.lang.String getUpdatedBy()

Return the user name who update this version of the Virtual Database.

Returns:

String

getDataTypeIDs

java.util.Collection getDataTypeIDs()

Returns the DataTypeID's that exist in this virtual database.

Returns:

Collection of the DataTypeID's contained in this VirtualDatabase

update

void update(java.lang.String attribute,
            java.lang.Object value)

Update a VDB attribute. Only the attributes defined in VirtualDatabase.ModifiableAttributes can be modefied.

Parameters:

attribute - attribute to be updated.

value - new value.

getFileName

java.lang.String getFileName()

Get this name of the VDB jar file.

Returns:

the VDB's name; never null or zero-length

hasWSDLDefined

boolean hasWSDLDefined()

Returns true if a WSDL is defined for this VDB

Returns:

true if a WSDL is defined for this VDB