Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

The following table provides a quick summry and link to the associated class modules in the ER/Studio Type Library.

Classes

Class ModuleDescription

Application

The main object through which all other objects are accessed. The Programmatic ID (PROGID) for this object is 'ERStudio.Application'. Macros, which run inside ER/Studio's Macro Editor, use the pre-initialized 'DiagramManager' object.

Attachment

This object represents an Attachment in ER/Studio.

Attachments

This object represents a collection of Attachments. The owner of this collection is the AttachmentType.

AttachmentType

This object represents an AttachmentType in ER/Studio.

AttachmentTypes

This object represents a collection of AttachmentTypes. The owner of this collection is the Data Dictionary.

AttributeObj

This object represents an attribute in ER/Studio.

Attributes

This object represents a collection of attributes. The owner of this collection is the entity.

BoundAttachment

This object represents a BoundAttachment in ER/Studio.

BoundAttachments

This object represents a collection of BoundAttachments. Many of the ERStudio objects have this collection

BoundObject

This object represents a binding between a dictionary object and a using object, such as a diagram object and contains the IDs of the using object. For example for a domain bound to an attribute, it has the attribute's IDs.

BoundObjects

This the collection of objects that represent bindings between a dictionary object and a using object, such as a diagram object. This collection is owned by the dictionary object of the binding.

BoundSecurityProperties

This object represents a collection of BoundSecurityProperties. Many of the ERStudio objects have this collection

BoundSecurityProperty

This object represents a BoundSecurityProperty in ER/Studio.

BusinessDataObject

This object represents a Business Data Object in ER/Studio.

BusinessDataObjectDisplay

This object represents an Business Data Object display object in ER/Studio. A Business Data Object display object is a graphical representation of a BusinessDataObject object in a specific submodel; it is not a BusinessDataObject object itself.

BusinessDataObjectDisplays

This object represents a collection of Business Data Object display objects. The owner of this collection is the submodel object.

BusinessDataObjects

This object represents a collection of Business Data Objects. The owner of this collection is the model.

DataFlow

This object represents a data flow in ER/Studio.

DataFlows

This object represents a collection of data flows. The owner of this collection is the diagram.

DataLineageColumn

This object represents a DataLineageColumn.

DataLineageColumns

This object represents the collection of DataLineageColumns. The owner of this collection is the DataLineageTable (Data Source/Target Table).

DataLineageRule

This object represents an DataLineageRule (Data Movement Rule) in ER/Studio.

DataLineageRules

This object represents a collection of DataLineageRules. The owner of this collection is the DataDictionary.

DataLineageSource

This object represents a DataLineageSource (Data Source/Target model in the DataLineage tree).

DataLineageSources

This object represents the collection of DataLineageSources (Data Source/Target models in the DataLineage tree). The owner of this collection is the diagram.

DataLineageTable

This object represents a DataLineageTable.

DataLineageTables

This object represents the collection of DataLineageTables. The owner of this collection is the DataLineageSource (Data Source/Target).

DataLineageView

This object represents a DataLineageView.

DataLineageViewField

This object represents a DataLineageViewField.

DataLineageViewFields

This object represents the collection of DataLineageViewFields. The owner of this collection is the DataLineageView (Data Source/Target View).

DataLineageViews

This object represents the collection of DataLineageViews. The owner of this collection is the DataLineageSource (Data Source/Target).

DataMovementColumnLink

This object represents a link between a column in a Source/Target (Data Lineage) Model and a column in a physical model.

DataMovementColumnLinks

This object represents a collection of DataMovementColumnLinks. The owner of this collection is the Column.

DataMovementModelLink

This object represents a link between a Source/Target (DataLineage) Model and a Physical Model.

DataMovementModelLinks

This object represents a collection of DataMovementModelLinks. The owner of this collection is the model.

DataMovementRuleLink

This object represents a link between a DataMovementRule and a Table/Entity or a Transformation.

DataMovementRuleLinks

This object represents a collection of DataMovementRuleLinks. The owner of this collection is the EntityObj.

DataStream

This object represents a Data Lineage Stream in ER/Studio.

DataStreams

This object represents a collection of DataStreams. The owner of this collection is the data flow.

DB2390AuxTable

This object represents a DB2 OS/390 Auxiliary Table in ER/Studio. It is stored as its create statement.

DB2390AuxTables

This object represents a collection of auxiliary tables. The owner of this collection is the model (of type DB2 OS/390).

DB2Database

This object represents a DB2Database in ER/Studio.

DB2Databases

This object represents a collection of DB2Database objects.

DB2IdxPartition

This object represents a DB2IdxPartition in ER/Studio.

DB2IdxPartitions

This object represents a collection of DB2IdxPartition objects.

DB2OS390Alias

This object represents a DB2 OS/390 Alias in ER/Studio.

DB2OS390Aliases

This object represents a collection of DB2 OS/390 Aliases. The owner of this collection is the model.

DB2OS390AuxTable

This object represents a DB2 OS/390 Auxiliary Table in ER/Studio. It is stored as its create statement.

DB2OS390AuxTables

This object represents a collection of auxiliary tables. The owner of this collection is the model (of type DB2 OS/390).

DB2OS390Synonym

This object represents a DB2 OS/390 Synonym in ER/Studio.

DB2OS390Synonyms

This object represents a collection of DB2 OS/390 Synonyms. The owner of this collection is the model.

DB2OS390TablePartition

This object represents a DB2OS390TablePartition in ER/Studio.

DB2OS390TablePartitions

This object represents a collection of DB2OS390TablePartition objects.

DB2StoGroup

This object represents a DB2StoGroup in ER/Studio.

DB2StoGroups

This object represents a collection of DB2StoGroup objects.

DB2Tablespace

This object represents a DB2Tablespace in ER/Studio.

DB2Tablespaces

This object represents a collection of DB2Tablespace objects.

DB2TbsPartition

This object represents a DB2TbsPartition in ER/Studio.

DB2TbsPartitions

This object represents a collection of DB2TbsPartition objects. This is the collection of Partitions contained in a DB2Tablespace object.

DB2UDBAlias

This object represents a DB2 UDB Alias in ER/Studio.

DB2UDBAliases

This object represents a collection of DB2 UDB Aliases. The owner of this collection is the model.

DB2UDBBufferPool

This object represents a DB2 UDB BufferPool in ER/Studio. It is stored as its create statement.

DB2UDBBufferPools

This object represents a collection of DB2UDBBufferPools. The owner of this collection is the Model.

DB2UDBContainerDMS

This object represents a DB2UDBContainerDMS in ER/Studio. It belongs to a database managed Tablespace.

DB2UDBContainersDMS

This object represents a collection of DB2 UDB ContainerDMSs. The owner of this collection is the DB2UDBTablespace.

DB2UDBContainerSMS

This object represents a DB2UDBContainerSMS in ER/Studio. It belongs to a system managed Tablespace.

DB2UDBContainersSMS

This object represents a collection of DB2 UDB ContainerSMSs. The owner of this collection is the DB2UDBTablespace.

DB2UDBDimension

This object represents a DB2Dimension in ER/Studio.

DB2UDBDimensions

This object represents a collection of DB2UDBDimension objects.

DB2UDBExceptNode

This object represents a DB2UDBExceptNode in ER/Studio.

DB2UDBExceptNodes

This object represents a collection of DB2UDBExceptNodes. The owner of this collection is the DB2UDBBufferPool.

DB2UDBMaterializedQueryTable

This object represents a DB2 UDB Materialized Query Table in ER/Studio.

DB2UDBMaterializedQueryTables

This object represents a collection of DB2 UDB Materialized Query Tables. The owner of this collection is the model.

DB2UDBNode

This object represents a DB2 UDB Node in ER/Studio.

DB2UDBNodeGroup

This object represents a DB2 UDB NodeGroup in ER/Studio. It is stored as its create statement.

DB2UDBNodeGroups

This object represents a collection of DB2 UDB NodeGroups. The owner of this collection is the Model.

DB2UDBNodeName

This object represents a DB2UDBNodeName in ER/Studio.

DB2UDBNodeNames

This object represents a collection of DB2 UDB NodeNames. The owner of this collection is the DB2UDBBufferPool.

DB2UDBNodes

This object represents a collection of DB2 UDB Nodes. The owner of this collection is the DB2UDBNodeGroup.

DB2UDBSequence

This object represents an DB2UDB sequence in ER/Studio. It is stored as its create statement.

DB2UDBSequences

This object represents a collection of DB2UDB sequences. The owner of this collection is the model.

DB2UDBTableRangePartition

This object represents a DB2UDBTableRangePartition in ER/Studio.

DB2UDBTableRangePartitions

This object represents a collection of DB2UDBTableRangePartitions objects.

DB2UDBTablespace

This object represents a DB2 UDB Tablespace in ER/Studio. It is stored as its create statement.

DB2UDBTablespaces

This object represents a collection of DB2UDBTablespaces. The owner of this collection is the Model.

DBRole

This represents a Database Role in ER/Studio.

DBRoles

This object represents a collection of Database Roles in ER/Studio. The owner of the collection is the Model.

DBSchema

This represents a Database Schema in ER/Studio.

DBSchemas

This object represents a collection of Database Schemas in ER/Studio. The owner of the collection is the Model.

DBUser

This represents a Database User in ER/Studio.

DBUsers

This object represents a collection of Database Users in ER/Studio. The owner of the collection is the Model.

DDLGeneration

This object represents a DDLGeneration object that provides an interface for generating the DDL for the model.

Default

This object represents a default in ER/Studio.

Defaults

This object represents a collection of defaults. The owner of this collection is the data dictionary.

Diagram

This object represents a diagram in ER/Studio.

Dictionary

This object represents the data dictionary in ER/Studio.

Document


Domain

This object represents a domain in ER/Studio.

DomainFolder

This object represents a Domain Folder in ER/Studio.

DomainFolders

This object represents a collection of Domain Folders. The owner of this collection is the data dictionary.

Domains

This object represents a collection of domains. The owner of this collection is the data dictionary.

EnterpriseDataDictionaries

This object represents a collection of EnterpriseDataDictionary objects.

Entities

This object represents a collection of entities. The owner of this collection is the model.

Entity

This object represents an entity in ER/Studio.

EntityDisplay

This object represents an entity display object in ER/Studio. An entity display object is a graphical representation of an entity in a specific submodel - it is not an entity itself.

EntityDisplays

This object represents a collection of entity display objects. The owner of this collection is the submodel object.

ERSFont

This object represents a font in ER/Studio. A user can get a font object for a specific label (ie, the font for the entity name or the font for the attribute name) from the submodel. A user can access or change font properties through this object.

ExportImageOptions

This object represents an ExportImageOptions object that provides an interface for generating an image of the Submodel.

FirebirdGenerator

This object represents a Firebird Generator in ER/Studio. It is stored as its create statement.

FirebirdGenerators

This object represents a collection of Firebird generators. The owner of this collection is the model.

FKColumnPair

This object represents a foreign key column pair. A foreign key column pair gives information on a parent attribute (an attribute in the parent entity) and its corresponding child attribute (a propagated foreign key attribute in the child entity).

FKColumnPairs

This object represents a collection of foreign key column pairs. The owner of this collection is the relationship.

IBusinessDataObject


IBusinessDataObjectDisplay


IBusinessDataObjectDisplays


IBusinessDataObjects


IFirebirdGenerator


IFirebirdGenerators


IInterBaseGenerator


IInterBaseGenerators


INamingStandardsTemplate


INamingStandardsTemplates


Index

This object represents an index in ER/Studio.

IndexColumn

This object represents an index column in ER/Studio.

IndexColumns

This object represents a collection of index columns. The owner of this collection is the index.

Indexes

This object represents a collection of indexes. The owner of this collection is the entity.

InterBaseGenerator

This object represents a InterBase Generator in ER/Studio. It is stored as its create statement.

InterBaseGenerators

This object represents a collection of InterBase generators. The owner of this collection is the model.

ISQLServerSequence


ISQLServerSequences


Line

This object represents a line in ER/Studio.

LineageComponent

This object represents a Data Lineage Component in ER/Studio.

LineageComponentDisplay

This object represents a lineage component display in ER/Studio. A view lineage component object is a graphical representation of a lineage component in a specific data flow - it is not a lineage component itself.

LineageComponentDisplays

This object represents a collection of LineageComponentDisplays. The owner of this collection is the data flow.

LineageComponents

This object represents a collection of LineageComponents. The owner of this collection is the data flow.

LineDisplay

This object represents a line display object in ER/Studio. A line display object is a graphical representation of a line in a specific submodel; it is not a line itself.

LineDisplays

This object represents a collection of line display objects. The owner of this collection is the submodel.

Lines

This object represents a collection of lines. The owner of this collection is the model.

ListMember

This object represents a ListMember in ER/Studio. It's an item in an Attachment TextList

MacroResultObj

This is a hidden object that is used internally in different Editors inside ER/Studio. It represents templated Procedures and triggers.

MergeModel

This object represent the MergeModel object in ER/Studio.

MetaImportObject

This object represent the MetaImportObject object in ER/Studio, which implements MetaWizard (Import) functionality for the automation interface.

Model

This object represents a model in ER/Studio.

Models

This object represents a collection of models. The owner of this collection is the diagram.

NamingStandardsTemplate

This object represents a naming standards template in ER/Studio.

NamingStandardsTemplates

This object represents a collection of NamingStandardsTemplates. The owner of this collection is the data dictionary.

NetezzaSynonym

This object represents a Netezza Synonym in ER/Studio. It is stored as its create statement.

NetezzaSynonyms

This object represents a collection of Netezza Synonyms. The owner of this collection is the model.

ObjectPermission

This represents an ObjectPermission in ER/Studio.

ObjectPermissions

This represents a collection of ObjectPermissions. The owner of the collection can be an Entity, View, Procedure, Package, Materialized View, and Sequence.

ObjectType

This object represents an Object Type in ER/Studio.

ObjectTypes

This object represents a collection of Object Types. The owner of this collection is the model.

OracleDatafile

This object represents an Oracle Datafile in ER/Studio.

OracleDatafiles

This object represents a collection of Datafiles. The owner of this collection is the Oracle Tablespace.

OracleIndexPartition

This object represents a OracleIndexPartition in ER/Studio.

OracleIndexPartitions

This object represents a collection of OracleIndexPartition objects. The owner of this collection is Index.

OracleMaterializedView

This object represents an Oracle Materialized View in ER/Studio. It is stored as its create statement.

OracleMaterializedViews

This object represents a collection of Oracle materialized views. The owner of this collection is the model.

OracleRollbackSegment

This object represents an Oracle rollback segment in ER/Studio. It is stored as its create statement.

OracleRollbackSegments

This object represents a collection of Oracle rollback segments. The owner of this collection is the model.

OracleSequence

This object represents an Oracle sequence in ER/Studio. It is stored as its create statement.

OracleSequences

This object represents a collection of Oracle sequences. The owner of this collection is the model.

OracleSynonym

This object represents an Oracle Synonym in ER/Studio. It is stored as its create statement.

OracleSynonyms

This object represents a collection of Oracle Synonyms. The owner of this collection is the model.

OracleTablePartition

This object represents a OracleTablePartition in ER/Studio.

OracleTablePartitions

This object represents a collection of OracleTablePartition objects.

OracleTablespace

This object represents an Oracle Tablespace in ER/Studio. It is stored as its create statement.

OracleTablespaces

This object represents a collection of Oracle Tablespaces. The owner of this collection is the Model.

OracleTableSubpartition

This object represents a OracleTableSubpartition in ER/Studio.

OracleTableSubpartitions

This object represents a collection of OracleTableSubpartition objects.

Package

This object represents a Package in ER/Studio.

Packages

This object represents a collection of Packages. The owner of this collection is the model.

PhysicalGeneration

This object represents a PhysicalGeneration object that provides an interface for generating the physical model for the logical model.

PrintOptions

This object represents a PrintOptions object that provides an interface for printing an image of the Submodel.

Procedure

This object represents a stored procedure in ER/Studio.

Procedures

This object represents a collection of stored procedures. The owner of this collection is the model.

Profile

This object represents a Profile in ER/Studio.

Profiles

This object represents a collection of Profile objects

Project

This object represents a Repository Project in ER/Studio.

Projects

This object represents a collection of Project objects.

ReferenceValue

This object represents a reference value in ER/Studio.

ReferenceValues

This object represents a collection of ReferenceValues. The owner of this collection is the data dictionary.

Relationship

This object represents a relationship in ER/Studio.

RelationshipDisplay

This object represents a relationship display object in ER/Studio. A relationship display object is a graphical representation of a relationship in a specific submodel - it is not a relationship itself.

RelationshipDisplays

This object represents a collection of relationship display objects. The owner of this collection is the submodel.

Relationships

This object represents a collection of relationships. The owner of this collection is the model.

RepoSubmodel

This object does NOT represents a submodel object in ER/Studio. It represents the combination of model name, submodel name referencing a submodel belonging to a diagram that exists in the repository.

RepoSubmodels

This object represents a collection of RepoSubmodels (i.e. model/submodel name combinations of submodels belonging to the diagram represented by this collection. The owner of this collection is the diagram manager.

ReverseEngineer

This object represent the ReverseEngineer object in ER/Studio.

Role

This object represents a Repository Role in ER/Studio.

Roles

This object represents a collection of Role objects.

Rule

This object represents a rule in ER/Studio.

Rules

This object represents a collection of rules. The owner of this collection is the data dictionary.

SchemaObjDisplay

This object represents an schema display object in ER/Studio. An schema display object is a graphical representation of a schema object in a specific submodel - it is not a schema object itself.

SchemaObjDisplays

This object represents a collection of schema display objects. The owner of this collection is the submodel object.

SchemaObjRelationshipDisplay

This object represents a schema object relationship display object in ER/Studio. A schema object relationship display object is a graphical representation of a schema object in a specific submodel.

SchemaObjRelationshipDisplays

This object represents a collection of schema object relationship display objects. The owner of this collection is the submodel.

SecurityProperties

This object represents a collection of SecurityProperties associated with a given SecurityType. The owner of this collection is that SecurityType.

SecurityProperty

This object represents a SecurityProperty in ER/Studio.

SecurityType

This object represents a SecurityType in ER/Studio.

SecurityTypes

This object represents a collection of SecurityTypes. The owner of this collection is the Data Dictionary.

SelectedObject

This object represents a selected object in ER/Studio. A selected object is highlighted in a submodel. Usually, a selected object will either be a view or an entity.

SelectedObjects

This object represents a collection of selected objects. The owner of this collection is the submodel.

Shape

This object represents a Shape in ER/Studio.

ShapeDisplay

This object represents an shape display object in ER/Studio. A shape display object is a graphical representation of a shape object in a specific submodel; it is not a shape object itself.

ShapeDisplays

This object represents a collection of shape display objects. The owner of this collection is the submodel object.

Shapes

This object represents a collection of Shapes. The owner of this collection is the model.

SQLServerSequence

This object represents an SQL Server sequence in ER/Studio. It is stored as its create statement.

SQLServerSequences

This object represents a collection of SQL Server sequences. The owner of this collection is the model.

SQLServerSynonym

This object represents a SQLServer Synonym in ER/Studio. It is stored as its create statement.

SQLServerSynonyms

This object represents a collection of SQLServer Synonyms. The owner of this collection is the model.

StringObject

This is a string object. Needed to store string collection.

StringObjects

This object represent a collection of StringObject

SubModel

This object represents a submodel in ER/Studio.

SubModels

This object represents a collection of submodels. The owner of this collection is the model.

SubType

This object represents a SubType in a SubTypeCluster.

SubTypeCluster

This object represents a SubTypeCluster in ER/Studio.

SubTypeClusters

This object represents a collection of SubTypeCluster in ER/Studio. The owner of this collection is the model.

SubTypes

This object represents a collection of SubType in a SubTypeCluster.

TableCheckConstraint

This object represents a Table Level Check Constraint in ER/Studio.

TableCheckConstraints

This object represents a collection of TableCheckConstraint. The owner of this collection is the Entity object.

TextList

This object represents a collection that's equivalent to an Attachment TextList. The owner of this collection is the Attachment object.

Transformation

This object represents a data lineage transformation in ER/Studio.

TransformationDisplay

This object represents a data lineage transformation display in ER/Studio. A data lineage transformation display object is a graphical representation of a transformation in a specific data flow - it is not a transformation itself.

TransformationDisplays

This object represents a collection of TransformationDisplays. The owner of this collection is the data flow.

TransformationField

This object represents a data lineage transformation field in ER/Studio.

TransformationFields

This object represents a collection of transformationFields. The owner of this collection is the transformation.

Transformations

This object represents a collection of transformations. The owner of this collection is the data flow.

Trigger

This object represents a trigger in ER/Studio.

Triggers

This object represents a collection of triggers. The owner of this collection is the entity.

UniversalMapping

This represents a universal mapping in ER/Studio - a mapping between objects across Data Architect diagrams and/or Business Architect workspaces.

UniversalMappings

This object represents a collection of UniversalMapping objects returned as a result of a UniversalMapping query.

User

This object represents a Repository User in ER/Studio.

UserComment

This object represents a user comment in ER/Studio.

UserComments

This object represents a collection of user comments. The owner of this collection is a dm1 object, e.g., an entity, an attribute, or an index, etc..

UserDatatype

This object represents a user datatype in ER/Studio.

UserDatatypes

This object represents a collection of user datatypes. The owner of this collection is the data dictionary.

UserDefinedMappingCollection

This object represents a collection of UserDefinedMappingObj objects returned as a result of a User Defined Mapping query.

UserDefinedMappingObj

This represents a user defined mapping in ER/Studio - an object in one model that maps to an object in another model.

Users

This object represents a collection of User objects.

ValidAttachmentBinding

This object represents an ValidAttachmentBinding in ER/Studio.

ValidAttachmentBindings

This object represents a collection of ValidAttachmentBindings. The owner of this collection is the AttachmentType.

ValuePair

This object represents a ValuePair (Value and ValueDescription) in ER/Studio.

Values

This object represents a collection of ValuePairs. The owner of this collection is the ReferenceValue object.

View

This object represents a view in ER/Studio.

ViewDisplay

This objects represents a view display object in ER/Studio. A view display object is a graphical representation of a view in a specific submodel - it is not a view itself.

ViewDisplays

This object represents a collection of view display objects. The owner of this collection is the submodel.

ViewField

This object represents a view field in ER/Studio.

ViewFields

This object represents a collection of view fields. The owner of this collection is the view.

ViewRelationship

This object represents a view relationship in ER/Studio.

ViewRelationshipDisplay

This object represents a view relationship display object in ER/Studio. A view relationship display object is a graphical representation of a view relationship in a specific submodel - it is not a view relationship itself.

ViewRelationshipDisplays

This object represents a collection of view relationship display objects. The owner of this collection is the submodel.

ViewRelationships

This object represents a collection of view relationships. The owner of this collection is the model.

Views

This object represents a collection of views. The owner of this collection is the model.

WhereUsedDataCollection

This object represents a collection of WhereUsedDataObj objects returned as a result of a WhereUsed ModelUsage or SubmodelUsage query.

WhereUsedDataObj

This represents a WhereUsed match in ER/Studio - an object in one model that matches an object in another model based on a WhereUsed query. It can also refer to a submodel that contains a particular object based on a WhereUsed Submodel Usage query.