blpapi.SchemaTypeDefinition

class blpapi.SchemaTypeDefinition

Representation of a “type” that can be used within a schema.

This class implements a representation of a “type” that can be used within a schema, including both plain types (integers, dates, strings, etc.) and “complex” types. The latter may be a “sequence” or a “choice” allowing either all or one of the named elements respectively. Those elements in turn are each described by a type. In addition to accessors for the type’s structure, this class also offers access to metadata providing a description and deprecation status for the type.

Each SchemaElementDefinition object is associated with a single SchemaTypeDefinition; one SchemaTypeDefinition may be used by zero, one, or many SchemaElementDefinition objects.

SchemaTypeDefinition objects are read-only.

Application clients need never create SchemaTypeDefinition objects directly; applications will typically work with objects returned by other blpapi components.

datatype()

Returns: The data type of this SchemaTypeDefinition.
Return type: int

The possible return values are enumerated in DataType.

description()

Returns: Human readable description of this SchemaTypeDefinition.
Return type: str

elementDefinitions()

Returns: Iterator over SchemaElementDefinitions defined by this SchemaTypeDefinition.

enumeration()

Returns: All possible values of the enumeration defined by this type. None in case this SchemaTypeDefinition is not a enumeration.
Return type: ConstantList

getElementDefinition(nameOrIndex)

Parameters

nameOrIndex (Name or str or int) – Name or index of the element

Returns

The definition of a specified element.

Return type

SchemaElementDefinition

Raises

NotFoundException – If nameOrIndex is a string and hasElement(nameOrIndex) != True.
IndexOutOfRangeException – If nameOrIndex is an integer and nameOrIndex >= numElementDefinitions()

hasElementDefinition(name)

Parameters: name (Name or str) – Item identifier
Returns: True if this object contains an item with the specified name, False otherwise
Return type: bool
Raises: Exception – If name is neither a Name nor a string.

isComplexType()

Returns: True if this SchemaTypeDefinition represents a sequence or choice type.
Return type: bool

isEnumerationType()

Returns: True if this SchemaTypeDefinition represents an enumeration type, False otherwise.
Return type: bool

isSimpleType()

Returns: True if this SchemaTypeDefinition represents neither a sequence nor a choice type.
Return type: bool

name()

Returns: The name of this SchemaTypeDefinition.
Return type: Name

numElementDefinitions()

Returns: The number of SchemaElementDefinition objects.
Return type: int

If this SchemaTypeDefinition is neither a choice nor a sequence this will return 0.

status()

Returns: The deprecation status of this SchemaTypeDefinition.
Return type: int

The possible return values are enumerated in SchemaStatus.

toString(level=0, spacesPerLevel=4)

Parameters

level (int) – Indentation level
spacesPerLevel (int) – Number of spaces per indentation level for this and all nested objects

Returns

This object formatted as a string

Return type

str

If level is negative, suppress indentation of the first line. If spacesPerLevel is negative, format the entire output on one line, suppressing all but the initial indentation (as governed by level).