company logo

PropertyDefinition :: subset - Get for definition subset

The function provides the property definition for a subset (derived extent).

The function works for property definitions referring to extents. When calling the function with an invalid property or for structure properties or key components, an exception is thrown.

Return value:  Property definition ( odaba::PropertyDefinition  )

The property definition provides meta-information about the property.

Implementation overview

Implementation details

  1. Get subset definition by name
    odaba::PropertyDefinition PropertyDefinition  :: subset ( odaba::String &sPropertyName )

    The function returns the property definition for the subset (extent) with the name passed to the function. The name must contain the complete key for locating the subset. This includes the namespace number, when the subset 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 subset at given position
    odaba::PropertyDefinition PropertyDefinition  :: subset ( int32 iPosition )

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