company logo

Property :: superset - Get collection handle for super set (base collection)

The function returns the super set (base collection) property handle, when a super set has been defined for the collection (relationship or extent). Otherwise the function throws an exception.

For relationships, the returned property handle is a subordinated handle to the current property handle, i.e. the super set may change whenever the collection in the current property handle changes (or the instance in the parent property changes).
Return value:  Property reference ( odaba::Property  )

A property handle refers to a (usually) opened property. Invalid properties may cause an exception.

Implementation overview

Implementation details

  1. Get property handle for default super set
    odaba::Property Property  :: superset (  )

    The function returns the property handle for the default super set for the collection (if there is any). When no super set has been defined, the function throws an exception.

    For extents, which may have got more than one super set, the function returns the property handle for the first super set, if there is any (same as superset(0));
    2. to list
  2. Get property handle for super set by position
    odaba::Property Property  :: superset ( int32 iPosition )

    The function should be called for extent properties in order to obtain the property handle for one of several defined super sets at position iPosition in the super set list. For relationships or extents with only one super set it is more appropriate to call superset() or superset(0).
    • iPosition - Position in collection

      The position of an element in a collection is beginning with 0 for the first element.
    3. to list
to top previous next upper table of contents Comment