Public Member Functions | |
| IdentifierDefinition (string href=default(string), DomainEnum domain=default(DomainEnum), string identifierScope=default(string), string identifierType=default(string), LifeTimeEnum lifeTime=default(LifeTimeEnum), string hierarchyUsage=default(string), string hierarchyLevel=default(string), string displayName=default(string), string description=default(string), Dictionary< string, Property > properties=default(Dictionary< string, Property >), ModelVersion varVersion=default(ModelVersion)) | |
| Initializes a new instance of the IdentifierDefinition class. More... | |
| override string | ToString () |
| Returns the string presentation of the object More... | |
| virtual string | ToJson () |
| Returns the JSON string presentation of the object More... | |
| override bool | Equals (object input) |
| Returns true if objects are equal More... | |
| bool | Equals (IdentifierDefinition input) |
| Returns true if IdentifierDefinition instances are equal More... | |
| override int | GetHashCode () |
| Gets the hash code More... | |
Protected Member Functions | |
| IdentifierDefinition () | |
| Initializes a new instance of the IdentifierDefinition class. More... | |
Properties | |
| DomainEnum | Domain [get, set] |
| The type of entity to which the identifier can be attached. Available values: Transaction, Portfolio, Holding, ReferenceHolding, TransactionConfiguration, Instrument, PortfolioGroup, Person, Order, Allocation, Calendar, LegalEntity, InvestorRecord, InvestmentAccount, Placement, Execution, Block, Participation, Package, OrderInstruction, CustomEntity, InstrumentEvent, Account, ChartOfAccounts, CustodianAccount, CheckDefinition, Abor, AborConfiguration, Fund, FundConfiguration, Fee, Reconciliation, PropertyDefinition, Compliance, DiaryEntry, Leg, DerivedValuation, Timeline, ClosedPeriod, IdentifierDefinition, SettlementInstruction, TransactionFeeType. More... | |
| LifeTimeEnum | LifeTime [get, set] |
| Describes whether an identifier value is associated with an entity for all effective dates or applies within a specified effective date range. Available values: Perpetual, TimeVariant. More... | |
| string | Href [get, set] |
| The specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime. More... | |
| string | IdentifierScope [get, set] |
| The scope that the identifier definition exists in. More... | |
| string | IdentifierType [get, set] |
| What the identifier represents. Together with "domain" and "identifierScope" this uniquely identifies the identifier definition. More... | |
| string | HierarchyUsage [get, set] |
| MasterIdentifier (aka unique) An entity can have one value for this identifier definition on a given effective date. A value for this identifier definition can only be associated with one entity (in a given scope) on a given effective date. ParentIdentifier (aka non-unique) An entity can have one value for this identifier definition on a given effective date. A value for this identifier definition can be associated with many entities (in a given scope) on a given effective date. Default value: MasterIdentifier. Available values: MasterIdentifier, ParentIdentifier. More... | |
| string | HierarchyLevel [get, set] |
| Optional metadata associated with the identifier definition. More... | |
| string | DisplayName [get, set] |
| A display name for the identifier. E.g. Figi. More... | |
| string | Description [get, set] |
| An optional description for the identifier. More... | |
| Dictionary< string, Property > | Properties [get, set] |
| A set of properties for the identifier definition. More... | |
| ModelVersion | VarVersion [get, set] |
| Gets or Sets VarVersion More... | |
Detailed Description
Member Enumeration Documentation
◆ DomainEnum
|
strong |
The type of entity to which the identifier can be attached. Available values: Transaction, Portfolio, Holding, ReferenceHolding, TransactionConfiguration, Instrument, PortfolioGroup, Person, Order, Allocation, Calendar, LegalEntity, InvestorRecord, InvestmentAccount, Placement, Execution, Block, Participation, Package, OrderInstruction, CustomEntity, InstrumentEvent, Account, ChartOfAccounts, CustodianAccount, CheckDefinition, Abor, AborConfiguration, Fund, FundConfiguration, Fee, Reconciliation, PropertyDefinition, Compliance, DiaryEntry, Leg, DerivedValuation, Timeline, ClosedPeriod, IdentifierDefinition, SettlementInstruction, TransactionFeeType.
The type of entity to which the identifier can be attached. Available values: Transaction, Portfolio, Holding, ReferenceHolding, TransactionConfiguration, Instrument, PortfolioGroup, Person, Order, Allocation, Calendar, LegalEntity, InvestorRecord, InvestmentAccount, Placement, Execution, Block, Participation, Package, OrderInstruction, CustomEntity, InstrumentEvent, Account, ChartOfAccounts, CustodianAccount, CheckDefinition, Abor, AborConfiguration, Fund, FundConfiguration, Fee, Reconciliation, PropertyDefinition, Compliance, DiaryEntry, Leg, DerivedValuation, Timeline, ClosedPeriod, IdentifierDefinition, SettlementInstruction, TransactionFeeType.
| Enumerator | |
|---|---|
| NotDefined | Enum NotDefined for value: NotDefined |
| Transaction | Enum Transaction for value: Transaction |
| Portfolio | |
| Holding | Enum Holding for value: Holding |
| ReferenceHolding | Enum ReferenceHolding for value: ReferenceHolding |
| TransactionConfiguration | Enum TransactionConfiguration for value: TransactionConfiguration |
| Instrument | Enum Instrument for value: Instrument |
| CutLabelDefinition | Enum CutLabelDefinition for value: CutLabelDefinition |
| Analytic | Enum Analytic for value: Analytic |
| PortfolioGroup | Enum PortfolioGroup for value: PortfolioGroup |
| Person | |
| AccessMetadata | Enum AccessMetadata for value: AccessMetadata |
| Order | |
| UnitResult | Enum UnitResult for value: UnitResult |
| MarketData | Enum MarketData for value: MarketData |
| ConfigurationRecipe | Enum ConfigurationRecipe for value: ConfigurationRecipe |
| Allocation | Enum Allocation for value: Allocation |
| Calendar | |
| LegalEntity | Enum LegalEntity for value: LegalEntity |
| InvestorRecord | Enum InvestorRecord for value: InvestorRecord |
| InvestmentAccount | Enum InvestmentAccount for value: InvestmentAccount |
| Placement | |
| Execution | |
| Block | |
| Participation | Enum Participation for value: Participation |
| Package | |
| OrderInstruction | Enum OrderInstruction for value: OrderInstruction |
| NextBestAction | Enum NextBestAction for value: NextBestAction |
| CustomEntity | Enum CustomEntity for value: CustomEntity |
| InstrumentEvent | Enum InstrumentEvent for value: InstrumentEvent |
| Account | |
| ChartOfAccounts | Enum ChartOfAccounts for value: ChartOfAccounts |
| CustodianAccount | Enum CustodianAccount for value: CustodianAccount |
| CheckDefinition | Enum CheckDefinition for value: CheckDefinition |
| Abor | |
| AborConfiguration | Enum AborConfiguration for value: AborConfiguration |
| Fund | |
| FundConfiguration | Enum FundConfiguration for value: FundConfiguration |
| Fee | |
| Reconciliation | Enum Reconciliation for value: Reconciliation |
| PropertyDefinition | Enum PropertyDefinition for value: PropertyDefinition |
| Compliance | Enum Compliance for value: Compliance |
| DiaryEntry | Enum DiaryEntry for value: DiaryEntry |
| Leg | Enum Leg for value: Leg |
| DerivedValuation | Enum DerivedValuation for value: DerivedValuation |
| Timeline | |
| ClosedPeriod | Enum ClosedPeriod for value: ClosedPeriod |
| AddressKeyDefinition | Enum AddressKeyDefinition for value: AddressKeyDefinition |
| AmortisationRuleSet | Enum AmortisationRuleSet for value: AmortisationRuleSet |
| AnalyticsSetInventory | Enum AnalyticsSetInventory for value: AnalyticsSetInventory |
| AtomUnitResult | Enum AtomUnitResult for value: AtomUnitResult |
| CleardownModule | Enum CleardownModule for value: CleardownModule |
| ComplexMarketData | Enum ComplexMarketData for value: ComplexMarketData |
| ComplianceRunSummary | Enum ComplianceRunSummary for value: ComplianceRunSummary |
| ComplianceRule | Enum ComplianceRule for value: ComplianceRule |
| ComplianceRunInfo | Enum ComplianceRunInfo for value: ComplianceRunInfo |
| CorporateActionSource | Enum CorporateActionSource for value: CorporateActionSource |
| CounterpartyAgreement | Enum CounterpartyAgreement for value: CounterpartyAgreement |
| CustomEntityDefinition | Enum CustomEntityDefinition for value: CustomEntityDefinition |
| DataType | |
| Dialect | |
| EventHandler | Enum EventHandler for value: EventHandler |
| GeneralLedgerProfile | Enum GeneralLedgerProfile for value: GeneralLedgerProfile |
| PostingModule | Enum PostingModule for value: PostingModule |
| Quote | |
| RecipeComposer | Enum RecipeComposer for value: RecipeComposer |
| ReconciliationRunBreak | Enum ReconciliationRunBreak for value: ReconciliationRunBreak |
| ReferenceList | Enum ReferenceList for value: ReferenceList |
| RelationDefinition | Enum RelationDefinition for value: RelationDefinition |
| ReturnBlockIndex | Enum ReturnBlockIndex for value: ReturnBlockIndex |
| SRSDocument | Enum SRSDocument for value: SRSDocument |
| SRSIndex | Enum SRSIndex for value: SRSIndex |
| TransactionTemplate | Enum TransactionTemplate for value: TransactionTemplate |
| TransactionTemplateScope | Enum TransactionTemplateScope for value: TransactionTemplateScope |
| TransactionType | Enum TransactionType for value: TransactionType |
| TransactionTypeConfig | Enum TransactionTypeConfig for value: TransactionTypeConfig |
| TranslationScript | Enum TranslationScript for value: TranslationScript |
| TaskDefinition | Enum TaskDefinition for value: TaskDefinition |
| TaskInstance | Enum TaskInstance for value: TaskInstance |
| Worker | Enum Worker for value: Worker |
| StagingRuleSet | Enum StagingRuleSet for value: StagingRuleSet |
| IdentifierDefinition | Enum IdentifierDefinition for value: IdentifierDefinition |
| SettlementInstruction | Enum SettlementInstruction for value: SettlementInstruction |
| TransactionFeeType | Enum TransactionFeeType for value: TransactionFeeType |
| AllocationMethod | Enum AllocationMethod for value: AllocationMethod |
| TransactionFee | Enum TransactionFee for value: TransactionFee |
◆ LifeTimeEnum
Describes whether an identifier value is associated with an entity for all effective dates or applies within a specified effective date range. Available values: Perpetual, TimeVariant.
Describes whether an identifier value is associated with an entity for all effective dates or applies within a specified effective date range. Available values: Perpetual, TimeVariant.
| Enumerator | |
|---|---|
| Perpetual | Enum Perpetual for value: Perpetual |
| TimeVariant | Enum TimeVariant for value: TimeVariant |
Constructor & Destructor Documentation
◆ IdentifierDefinition() [1/2]
|
inlineprotected |
Initializes a new instance of the IdentifierDefinition class.
◆ IdentifierDefinition() [2/2]
|
inline |
Initializes a new instance of the IdentifierDefinition class.
- Parameters
-
href The specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime.. domain The type of entity to which the identifier can be attached. Available values: Transaction, Portfolio, Holding, ReferenceHolding, TransactionConfiguration, Instrument, PortfolioGroup, Person, Order, Allocation, Calendar, LegalEntity, InvestorRecord, InvestmentAccount, Placement, Execution, Block, Participation, Package, OrderInstruction, CustomEntity, InstrumentEvent, Account, ChartOfAccounts, CustodianAccount, CheckDefinition, Abor, AborConfiguration, Fund, FundConfiguration, Fee, Reconciliation, PropertyDefinition, Compliance, DiaryEntry, Leg, DerivedValuation, Timeline, ClosedPeriod, IdentifierDefinition, SettlementInstruction, TransactionFeeType. (required). identifierScope The scope that the identifier definition exists in. (required). identifierType What the identifier represents. Together with "domain" and "identifierScope" this uniquely identifies the identifier definition. (required). lifeTime Describes whether an identifier value is associated with an entity for all effective dates or applies within a specified effective date range. Available values: Perpetual, TimeVariant. (required). hierarchyUsage MasterIdentifier (aka unique) An entity can have one value for this identifier definition on a given effective date. A value for this identifier definition can only be associated with one entity (in a given scope) on a given effective date. ParentIdentifier (aka non-unique) An entity can have one value for this identifier definition on a given effective date. A value for this identifier definition can be associated with many entities (in a given scope) on a given effective date. Default value: MasterIdentifier. Available values: MasterIdentifier, ParentIdentifier.. hierarchyLevel Optional metadata associated with the identifier definition.. displayName A display name for the identifier. E.g. Figi.. description An optional description for the identifier.. properties A set of properties for the identifier definition.. varVersion varVersion.
Member Function Documentation
◆ Equals() [1/2]
|
inline |
Returns true if IdentifierDefinition instances are equal
- Parameters
-
input Instance of IdentifierDefinition to be compared
- Returns
- Boolean
◆ Equals() [2/2]
|
inline |
Returns true if objects are equal
- Parameters
-
input Object to be compared
- Returns
- Boolean
◆ GetHashCode()
|
inline |
Gets the hash code
- Returns
- Hash code
◆ ToJson()
|
inlinevirtual |
Returns the JSON string presentation of the object
- Returns
- JSON string presentation of the object
◆ ToString()
|
inline |
Returns the string presentation of the object
- Returns
- String presentation of the object
Property Documentation
◆ Description
|
getset |
An optional description for the identifier.
An optional description for the identifier.
◆ DisplayName
|
getset |
A display name for the identifier. E.g. Figi.
A display name for the identifier. E.g. Figi.
◆ Domain
|
getset |
The type of entity to which the identifier can be attached. Available values: Transaction, Portfolio, Holding, ReferenceHolding, TransactionConfiguration, Instrument, PortfolioGroup, Person, Order, Allocation, Calendar, LegalEntity, InvestorRecord, InvestmentAccount, Placement, Execution, Block, Participation, Package, OrderInstruction, CustomEntity, InstrumentEvent, Account, ChartOfAccounts, CustodianAccount, CheckDefinition, Abor, AborConfiguration, Fund, FundConfiguration, Fee, Reconciliation, PropertyDefinition, Compliance, DiaryEntry, Leg, DerivedValuation, Timeline, ClosedPeriod, IdentifierDefinition, SettlementInstruction, TransactionFeeType.
The type of entity to which the identifier can be attached. Available values: Transaction, Portfolio, Holding, ReferenceHolding, TransactionConfiguration, Instrument, PortfolioGroup, Person, Order, Allocation, Calendar, LegalEntity, InvestorRecord, InvestmentAccount, Placement, Execution, Block, Participation, Package, OrderInstruction, CustomEntity, InstrumentEvent, Account, ChartOfAccounts, CustodianAccount, CheckDefinition, Abor, AborConfiguration, Fund, FundConfiguration, Fee, Reconciliation, PropertyDefinition, Compliance, DiaryEntry, Leg, DerivedValuation, Timeline, ClosedPeriod, IdentifierDefinition, SettlementInstruction, TransactionFeeType.
◆ HierarchyLevel
|
getset |
Optional metadata associated with the identifier definition.
Optional metadata associated with the identifier definition.
◆ HierarchyUsage
|
getset |
MasterIdentifier (aka unique) An entity can have one value for this identifier definition on a given effective date. A value for this identifier definition can only be associated with one entity (in a given scope) on a given effective date. ParentIdentifier (aka non-unique) An entity can have one value for this identifier definition on a given effective date. A value for this identifier definition can be associated with many entities (in a given scope) on a given effective date. Default value: MasterIdentifier. Available values: MasterIdentifier, ParentIdentifier.
MasterIdentifier (aka unique) An entity can have one value for this identifier definition on a given effective date. A value for this identifier definition can only be associated with one entity (in a given scope) on a given effective date. ParentIdentifier (aka non-unique) An entity can have one value for this identifier definition on a given effective date. A value for this identifier definition can be associated with many entities (in a given scope) on a given effective date. Default value: MasterIdentifier. Available values: MasterIdentifier, ParentIdentifier.
◆ Href
|
getset |
The specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime.
The specific Uniform Resource Identifier (URI) for this resource at the requested effective and asAt datetime.
◆ IdentifierScope
|
getset |
The scope that the identifier definition exists in.
The scope that the identifier definition exists in.
◆ IdentifierType
|
getset |
What the identifier represents. Together with "domain" and "identifierScope" this uniquely identifies the identifier definition.
What the identifier represents. Together with "domain" and "identifierScope" this uniquely identifies the identifier definition.
◆ LifeTime
|
getset |
Describes whether an identifier value is associated with an entity for all effective dates or applies within a specified effective date range. Available values: Perpetual, TimeVariant.
Describes whether an identifier value is associated with an entity for all effective dates or applies within a specified effective date range. Available values: Perpetual, TimeVariant.
◆ Properties
|
getset |
A set of properties for the identifier definition.
A set of properties for the identifier definition.
◆ VarVersion
|
getset |
Gets or Sets VarVersion
The documentation for this class was generated from the following file:
- /home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Model/IdentifierDefinition.cs
