GetOrigCollectionKeys3 - Teradata Meta Data Services

Teradata Meta Data Services Programmer Guide

Teradata Meta Data Services
Release Number
English (United States)
Last Update
Product Category
Teradata Tools and Utilities



GetOrigCollectionKeys3 returns a list of CMetaObjectClassKey objects (contains object id, object name, class id, and class name) which identify the collection of the Origin class objects associated with the current version of this CMetaObject for the specified relationship.


The GetOrigCollectionKeys3 function only uses the current version of the CMetaObject.

This API is expected to be used by a meta data browser to enable it to display the name/id of objects in a collection without having to read the entire collection of objects into memory. This is important for large collections that would consume a large amount of process space if all read into memory. The function allows you to specify the property id, property value and comparison operator on which to perform the search. The search is performed on the list of objects in the collection. If multiple properties are specified for the search, the logical operator between the property searches must be specified.

When the origin class supports versioning, GetOrigCollectionKeys3 will return the keys of object versions in the origin class that have a rigid relationship to the current version of this CMetaObject. The returned keys are not guaranteed to be for the current version of their respective objects, i.e CMetaPersist::IsPublished() may be true or false for each returned object key.


  • The internal object id must be set in the object and it must be for a version of the destination object.
  • The propFilter list may contain zero or more CMetaFilterInfo objects.
  • The PropertyID (SetPropertyID()) or PropertyName (SetName()) of the value attribute in each CMetaFilterInfo object must contain a valid Relative Property ID or name of a property description in the class.
  • The value attribute in each CMetaFilterInfo object must also be set to the value on which the search will be made. This value must be of the same type as the property description. For example, if the search is to be made on Relative Property ID = 1 and Relative Property ID 1 is defined as an integer, Value must be set to an integer (SetInt()). If relative Property ID 1 is a string, Value must be set to a string (SetString()).
  • The default ComparisonOperator in each CMetaFilterInfo object is EQUAL and the default LogicalOperator is META_AND.
  • If the propFilter list contains zero objects, the function will perform a search by strObjName only. If strObjName is also NULL, the API will return all the objects in the collection.
  • If the propFilter list contains objects and strObjName is set, the logical operator between the properties and the name will the “AND”. To perform a search of a name “OR” a property, set strObjName to NULL and add a CMetaFilterInfo object to the propFilter list for a name search.
  • Syntax

    HRESULT GetOrigCollectionKeys3(
    MetaObjectClassKeyVector& objectKeyList,
    const MetaFilterInfoVector &propFilter,
    const GUID &gRelID, 
    const OBJECTID_t lRelID = NULLLOID,
    LPCTSTR strObjName = NULL, 
    const bool WithLock = false,
    const OBJECTID_t returnClass = NULLLOID,
    const bool allClasses = false,
    const bool skipValidation = false);

    For more information on creating the propFilter for the search, see Chapter 8: “CMetaFilterInfo Class.”

    For more information on building the strObjName parameter for a search, see “Name Search” on page 131.

    For more information on the settings for allClasses and returnClass, see “Inheritance” on page 132.







    Reference to the list of object keys that will hold the collection returned. The list is cleared before adding the return collection.



    List of FilterInfo objects containing the property id and value to use to perform the search.



    Relationship GUID.



    Relationship internal ID.



    Search string for names of objects in the collection to be returned.



    WithLock=true keeps the class table of the Origin Collection locked for WRITE. Use within an explicit transaction. Set WithLock to true when one of the Origin Collection objects will subsequently be updated within the transaction. This prevents deadlocks caused by Teradata promotional locks.



    If the allClasses parameter is = true, the returnClass parameter is ignored. If the allClasses parameter = false:

  • If returnClass = 0, the origin class defined in the relationship is returned.
  • If the origin class in the relationship is a superclass, return class defines the class type of object to return (the superclass or one of its subclasses)
  • If the origin class in the relationship is not a superclass and return class specifies a classid other than the origin class, an error will be returned.
  • allClasses


    If the origin class in the relationship is a superclass, setting allClasses = true will return all class types (superclass and subclasses). If allClasses = false, the origin class returned is determined by the returnClass parameter. If allClasses = true and the origin class in the relationship is not a superclass, only objects of the origin class defined in the relationship are returned.



    The function validates that the id of the object is an object in the destination class (or subclass) of the relationship. If returnClass is specified, the function will validate that the returnClass is the origin class (or subclass) of the relationship. If skipValidation is true, this validation is not performed. If the validation is not performed and the validation would have returned an error, the function will return zero objects in the ObjectList.