Module `macrobond_data_api.com.com_types.metadata_information`

Classes

class MetadataInformation

Interface for a type of metadata in the Macrobond database.

var CanHaveMultipleValues : bool: If True then this type of metadata can have multiple values in a metadata collection.

Browse git
var CanListValues : bool: If True then the values of this type of metadata can be listen using the ListAllValues function.

Browse git
var Comment : str: The comment about the metadata.

Browse git
var Description : str: The description of the metadata.

Browse git
var IsDatabaseEntity : bool: If True then this type of metadata is an entity that can be retrieved from the database.

Browse git
var Name : str: The name of the metadata.

Browse git
var Restriction : Optional[Literal['url', 'email', 'date', 'positive', 'json']]: Potential restriction of the data type. Can be 'date', 'json' or 'positive'.

Browse git
var UsesValueList : bool: Returns True if this type of metadata has a list of possible values.

Browse git
var ValueType : MetadataValueType: The datatype that corresponds directly to the COM VT_* values.

Browse git

def ArrangeValues(self, values: object) ‑> List[object]: Get a list of possible values for this type of metadata if it uses a list of values.

Browse git
def GetValueInformation(self, value: object) ‑> MetadataValueInformation: Get detailed information of a value when this type of metadata uses a list of values.

Browse git
def GetValuePresentationText(self, value: object) ‑> str: Format the value as a text.

Browse git
def ListAllValues(self) ‑> List[MetadataValueInformation]: Get a list of possible values for this type of metadata if it uses a list of values.

Browse git

class MetadataValueInformation

Interface for a metadata value in the Macrobond database.

var Comment : Optional[str]: The comment about the metadata value.

Browse git
var Description : str: The description of the metadata value.

Browse git
var Value : object: The value of the metadata.

Browse git

class MetadataValueType (value, names=None, *, module=None, qualname=None, type=None, start=1)

The type of a metadata value. These values corresponds to the COM VARIANT data types.