com.sas.iquery.metadata.business
Interface ExportObject<U,X>

Type Parameters:

U - Underlying object class.

X - Export object class.

All Superinterfaces:

NamedObjectInterface

All Known Subinterfaces:

ExportColumn, ExportColumnGroup, ExportDataSource, ExportDimension, ExportFilter, ExportHierarchy, ExportJoin, ExportLevel, ExportMember

public interface ExportObject<U,X>
extends NamedObjectInterface

Base interface for exported objects with templates: U = underlying object class, X = export object class.

Method Summary

abstract java.lang.String	getDescription() Returns the description for this export object (if any).
abstract ExportGeneralMetadata	getExportMetadata()
abstract ExportObjectFactoryInterface<U,X>	getExportObjectFactory()
abstract java.lang.String	getID() Returns the Model ID if this is a business model item or the physical resource name is a business model resource.
abstract java.lang.String	getLabel() Returns the label for this export object.
abstract U	getUnderlyingObject() Returns the underlying object.
abstract java.lang.String	getUniqueExportName() Uniquely identifies this exported object within the scope of the exported metadata.

Method Detail

getUniqueExportName

java.lang.String getUniqueExportName()
                                     throws MetadataException

Uniquely identifies this exported object within the scope of the exported metadata.

Returns:

Throws:

MetadataException

getID

java.lang.String getID()
                       throws MetadataException

Returns the Model ID if this is a business model item or the physical resource name is a business model resource.

Throws:

MetadataException

getLabel

java.lang.String getLabel()

Returns the label for this export object.

Specified by:

getLabel in interface NamedObjectInterface

Returns:

String a label or null if not set

getDescription

java.lang.String getDescription()

Returns the description for this export object (if any).

Specified by:

getDescription in interface NamedObjectInterface

Returns:

a description or null if not set

getUnderlyingObject

U getUnderlyingObject()

Returns the underlying object.

getExportObjectFactory

ExportObjectFactoryInterface<U,X> getExportObjectFactory()

Returns:

Returns the export object factory that created this object.

Throws:

MetadataException

getExportMetadata

ExportGeneralMetadata getExportMetadata()

Returns:

Returns the export metadata object that contains this object.