company logo

PropertyDefinition :: superset - Get super set definition

The function provides the property definition for a super set (base extent).

The function works for property definitions referring to extents. When calling the function for structure properties or key components, no property definition is returned.

In order to provide the super set for a local property (relationship) the Property function baseCollection() can be called.

When the function is called with an invalid property definition it, throws an exception.
Return value:  Property definition ( odaba::PropertyDefinition  )

The property definition provides meta-information about the property.

Implementation overview

Implementation details

  1. Get super set definition by name
    odaba::PropertyDefinition PropertyDefinition  :: superset ( odaba::String &sPropertyName )

    The function returns the property definition for the super set (extent) with the name passed to the function. The name must contain the complete key for locating the super set. This includes the namespace number, when the super set is not defined in the root namespace.
    • sPropertyName - Property name

      The property name may contain a property path that consists of a sequence of property names. Not allowed are operation paths or path properties, i.e. the property name must consist of identifiers separated by dots (.), only.

      In order to pass no property name, an empty string ( String() ) has to be passed.
    2. to list
  2. Get super set at given position
    odaba::PropertyDefinition PropertyDefinition  :: superset ( int32 iPosition )

    The function returns the super set (extent) at the given position. The first super set has position 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