| SchemaElementDefinition Class |
Inheritance HierarchyBloomberglp.BlpapiSchemaElementDefinition
Namespace: Bloomberglp.Blpapi
Assembly: Bloomberglp.Blpapi (in Bloomberglp.Blpapi.dll) Version: 3.24.11.1
SyntaxThe SchemaElementDefinition type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SchemaElementDefinition | Initializes a new instance of the SchemaElementDefinition class |
Properties| Name | Description | |
|---|---|---|
 | AlternateNames |
Creates an enumerable collection of all alternate names.
|
| Constraints | Return the list of constraints.
|
| Description |
Gets a string containing a human readable description of this item.
|
| MaxValues |
Return the maximum number of occurrences of the this item. This value may
be UNBOUNDED (-1) or any value >= 1.
|
| MinValues |
Gets the minimum number of occurrences of this item. This value is
always >= 0.
|
| Name |
Gets the name of this item.
|
| NumAlternateNames |
Gets the number of alternate names for this item.
|
| Status |
Gets the status of this SchemaElementDefinition.
|
| TypeDefinition |
Gets the SchemaTypeDefinition of this item.
|
| UserData |
Sets and gets the user data associated with this object.
|
Methods| Name | Description | |
|---|---|---|
 | GetAlternateName |
Gets the alternate name for this item at the specified index.
|
Fields
RemarksSchemaElementDefinition are returned by {@link Service} objects and {@link Operation} objects to define the content of requests, replies and events. The {@link SchemaTypeDefinition} returned by {@link SchemaElementDefinition#typeDefinition()} may itself return SchemaElementDefinition objects when the schema contains complex items. SchemaElementDefinition objects are read-only and always created by the API, never by the application. The SchemaElementDefinition defines the symbolic name any constraints on this item and the SchemaTypeDefinition which represents instances of this item.
- An item which is optional in the schema has SchemaElementDefinition.MinValues == 0.
- An item which is mandatory in the schema has SchemaElementDefinition.MinValues >= 1.
- An item which is a single value has SchemaElementDefinition.MaxValues == 1.
- An item which is an array has SchemaElementDefinition.MaxValues > 1.
- An item which is an unbounded array has SchemaElementDefinition.MaxValues == SchemaElementDefinition.UNBOUNDED.
As well as the symbolic name, array constraints and other constraints this class also provides access to the description and status of the item.
Thread SafetySee Also