GetDormantDIMOrigCollection
Purpose
GetDormantDIMOrigCollection returns the collection of dormant objects of the origin class associated with this CMetaObject for the specified relationship that matches the selection criteria.
Description
The calling object can be dormant or active.
The property id, property value and comparison operator on which to perform the search can all be specified. 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. The name of the property upon which to sort the returned list can also be specified.
Requirements
The requirements are the same as for GetDormantDIMDestCollection.
Syntax
HRESULT GetDormantDIMOrigCollection(
vector<CMetaObject>& objectList,
const MetaFilterInfoVector& propFilter,
const MetaObjectKeyVector& sortList,
const GUID& gRelID,
const OBJECTID_t lRelID = NULLLOID,
LPCTSTR sObjName = 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 building the sortList parameter, see “Sort List” on page 130.
For more information on the settings for allClasses and returnClass, see “Inheritance” on page 132.
|
Argument |
In/Out |
Description |
|
objectList |
In/Out |
Reference to the list of CMetaObjects that will hold the collection returned. The list is cleared before adding the return collection |
|
propFilter |
In |
List of FilterInfo objects containing the property id and value to use to perform the search |
|
sortList |
In |
List of property identifiers (relative property id or name) to sort the collection by. The return list will be returned in ascending order and the sort will not be case specific |
|
gRelID |
In |
Relationship GUID |
|
IRelID |
In |
Relationship internal ID |
|
StrObjName |
In |
Search string for names of objects in the class to be returned. |
|
WithLock |
In |
WithLock=true keeps the class table locked for WRITE. Use within an explicit transaction. Set WithLock to true when one of the class objects will subsequently be updated within the transaction. Prevents deadlocks caused by Teradata promotional locks. |
|
returnClass |
In |
If the allClasses parameter is = true, the returnClass parameter is ignored. If the allClasses parameter = false: |
|
allClasses |
In |
If the destination class in the relationship is a superclass, setting allClasses = true will return all class types (superclass and subclasses). If allClasses = false, the destination class returned is determined by the returnClass parameter. If allClasses = true and the destination class in the relationship is not a superclass, only objects of the destination class defined in the relationship are returned. If allClasses = true, the return list is sorted first by class and then by the sort properties specified. |
|
SkipValidation |
In |
The function validates that the id of the object is an object in the origin class (or subclass) of the relationship. If returnClass is specified, the function will validate that the returnClass is the destination 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. |