Class: AvailableInventory

A data type that can be used to describe the inventory of securities that a party holds. The securities are held in the AvailableInventoryRecord, with each item in the array being an individual security and its associated criteria. Criteria can include the quantity available, the rate at which the security is available to borrow at, as well as other details that can affect the decision as to whether a party wants to utilise the securities listed.

URI: common_domain_model:AvailableInventory

 classDiagram
    class AvailableInventory
    click AvailableInventory href "../AvailableInventory/"
      AvailableInventory <|-- SecurityLocate
        click SecurityLocate href "../SecurityLocate/"
      
      AvailableInventory : availableInventoryRecord
        
          
    
        
        
        AvailableInventory --> "*" AvailableInventoryRecord : availableInventoryRecord
        click AvailableInventoryRecord href "../AvailableInventoryRecord/"
    

        
      AvailableInventory : availableInventoryType
        
          
    
        
        
        AvailableInventory --> "1" AvailableInventoryTypeEnum : availableInventoryType
        click AvailableInventoryTypeEnum href "../AvailableInventoryTypeEnum/"
    

        
      AvailableInventory : comment
        
      AvailableInventory : identifier
        
          
    
        
        
        AvailableInventory --> "0..1" AssignedIdentifier : identifier
        click AssignedIdentifier href "../AssignedIdentifier/"
    

        
      AvailableInventory : messageInformation
        
          
    
        
        
        AvailableInventory --> "0..1" MessageInformation : messageInformation
        click MessageInformation href "../MessageInformation/"
    

        
      AvailableInventory : party
        
          
    
        
        
        AvailableInventory --> "*" Party : party
        click Party href "../Party/"
    

        
      AvailableInventory : partyRole
        
          
    
        
        
        AvailableInventory --> "*" PartyRole : partyRole
        click PartyRole href "../PartyRole/"
    

        
      

Inheritance

• AvailableInventory
  • SecurityLocate

Slots

Name	Cardinality and Range	Description	Inheritance
availableInventoryType	1 AvailableInventoryTypeEnum	Defines the purpose of this inventory	direct
identifier	0..1 AssignedIdentifier	Unique identifier for this group	direct
comment	0..1 string	Optional comments for this group of inventory records	direct
messageInformation	0..1 MessageInformation	Allows details related to the availability messaging use case to be defined	direct
party	* Party	Defines all parties involved for the list of inventory records in this set of…	direct
partyRole	* PartyRole	Defines the role(s) that party(ies) may have in relation to the inventory	direct
availableInventoryRecord	* AvailableInventoryRecord	An array holding the list of inventory being described	direct

Comments

• Rosetta condition ValidPartyRole is not stated in LinkML: IsValidPartyRole (partyRole, [PartyRoleEnum -> AgentLender, PartyRoleEnum -> BeneficialOwner, PartyRoleEnum -> Borrower, PartyRoleEnum -> Custodian, PartyRoleEnum -> Lender])

Identifier and Mapping Information

Annotations

property	value
rosetta_root_type	true

Schema Source

• from schema: https://w3id.org/lmodel/common-domain-model

Mappings

Mapping Type	Mapped Value
self	common_domain_model:AvailableInventory
native	common_domain_model:AvailableInventory

LinkML Source

Direct

name: AvailableInventory
annotations:
  rosetta_root_type:
    tag: rosetta_root_type
    value: 'true'
description: A data type that can be used to describe the inventory of securities
  that a party holds. The securities are held in the AvailableInventoryRecord, with
  each item in the array being an individual security and its associated criteria.
  Criteria can include the quantity available, the rate at which the security is available
  to borrow at, as well as other details that can affect the decision as to whether
  a party wants to utilise the securities listed.
comments:
- 'Rosetta condition ValidPartyRole is not stated in LinkML: IsValidPartyRole (partyRole,
  [PartyRoleEnum -> AgentLender, PartyRoleEnum -> BeneficialOwner, PartyRoleEnum ->
  Borrower, PartyRoleEnum -> Custodian, PartyRoleEnum -> Lender])'
from_schema: https://w3id.org/lmodel/common-domain-model
attributes:
  availableInventoryType:
    name: availableInventoryType
    description: Defines the purpose of this inventory.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_position
    rank: 1000
    domain_of:
    - AvailableInventory
    range: AvailableInventoryTypeEnum
    required: true
  identifier:
    name: identifier
    description: Unique identifier for this group. This can be used to uniquely identify
      a group of inventory records.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_position
    domain_of:
    - AssetBase
    - AssetIdentifier
    - ProductIdentifier
    - AssignedIdentifier
    - BusinessUnit
    - EntityIdentifier
    - PartyIdentifier
    - PersonIdentifier
    - TransferBase
    - ContractualDefinition
    - FloatingRateIndexMap
    - CompositionStep
    - InstructionComposition
    - LegalAgreementBase
    - NonLegalEntity
    - OtherAgreement
    - AvailableInventory
    - InventoryRecord
    - ClauseLibraryClause
    - ClauseLibraryClauseVariant
    - Clause
    - EligibleCollateralSpecification
    - NonTransferableProduct
    range: AssignedIdentifier
  comment:
    name: comment
    description: Optional comments for this group of inventory records.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_position
    rank: 1000
    domain_of:
    - AvailableInventory
    - AvailableInventoryRecord
    - WorkflowState
    range: string
  messageInformation:
    name: messageInformation
    description: Allows details related to the availability messaging use case to
      be defined
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_position
    rank: 1000
    domain_of:
    - AvailableInventory
    - WorkflowStep
    range: MessageInformation
  party:
    name: party
    description: Defines all parties involved for the list of inventory records in
      this set of inventory. For example, when used to describe securities lending
      availability, this could hold the sender of the availability, the intended recipient,
      the beneficial owner(s), the lender (which may differ from the sender as the
      lender may have the same piece of availability going through multiple agents),
      an agent or a venue.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_position
    domain_of:
    - AssetBase
    - DebtRedemption
    - MarginCallBase
    - Trade
    - UmbrellaAgreementParty
    - UmbrellaAgreementSet
    - AggregationParameters
    - AvailableInventory
    - CounterpartyPosition
    - WorkflowStep
    - WorkflowStepApproval
    - AdditionalObligations
    - AdditionalRepresentationElection
    - CalculationAgentTerms
    - CalculationCurrencyElection
    - CollateralManagementAgreementElection
    - ControlAgreementElections
    - ControlAgreementNecEventElection
    - CreditSupportDocumentElection
    - CreditSupportProviderElection
    - CustodianElection
    - CustodianRiskElection
    - ElectiveAmountElection
    - FrenchLawAddendumElection
    - HoldingAndUsingPostedCollateralElection
    - LegacyExposureScopeElection
    - LegacyIndependentAmountParty
    - MinimumTransferAmountElection
    - NotificationTimeElection
    - PledgeeRepresentativeRider
    - PostingObligationsElection
    - RecalculationOfValueElection
    - RegimeTerms
    - SecuredPartyRightsEventElection
    - SecurityInterestForObligations
    - SecurityProviderRightsEventElection
    - SensitivityMethodologiesPartyElection
    - SinglePostingParty
    - SpecifiedOrAccessConditionPartyElection
    - SubstitutedRegimeElection
    - SubstitutionPartyElection
    - TerminationCurrencyElection
    - ThresholdElection
    - ValuationAgent
    - ValuationCalculationDateLocationElection
    - AdditionalTerminationEventElection
    - AutomaticEarlyTerminationElection
    - CreditEventUponMergerElection
    - PartyTerminationCurrencySelection
    - SpecifiedEntity
    - EventsOfDefaultElection
    - EligibleCollateralSpecification
    range: Party
    multivalued: true
  partyRole:
    name: partyRole
    description: Defines the role(s) that party(ies) may have in relation to the inventory.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_position
    domain_of:
    - AssetBase
    - MarginCallBase
    - PartyChangeInstruction
    - Trade
    - UmbrellaAgreementParty
    - AvailableInventory
    - AvailableInventoryRecord
    - CounterpartyPosition
    - EligibleCollateralSpecification
    range: PartyRole
    multivalued: true
  availableInventoryRecord:
    name: availableInventoryRecord
    description: An array holding the list of inventory being described. Each element
      in the inventoryRecord array represents an individual piece of inventory i.e.
      a security.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_position
    rank: 1000
    domain_of:
    - AvailableInventory
    range: AvailableInventoryRecord
    multivalued: true

Induced

name: AvailableInventory
annotations:
  rosetta_root_type:
    tag: rosetta_root_type
    value: 'true'
description: A data type that can be used to describe the inventory of securities
  that a party holds. The securities are held in the AvailableInventoryRecord, with
  each item in the array being an individual security and its associated criteria.
  Criteria can include the quantity available, the rate at which the security is available
  to borrow at, as well as other details that can affect the decision as to whether
  a party wants to utilise the securities listed.
comments:
- 'Rosetta condition ValidPartyRole is not stated in LinkML: IsValidPartyRole (partyRole,
  [PartyRoleEnum -> AgentLender, PartyRoleEnum -> BeneficialOwner, PartyRoleEnum ->
  Borrower, PartyRoleEnum -> Custodian, PartyRoleEnum -> Lender])'
from_schema: https://w3id.org/lmodel/common-domain-model
attributes:
  availableInventoryType:
    name: availableInventoryType
    description: Defines the purpose of this inventory.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_position
    rank: 1000
    owner: AvailableInventory
    domain_of:
    - AvailableInventory
    range: AvailableInventoryTypeEnum
    required: true
  identifier:
    name: identifier
    description: Unique identifier for this group. This can be used to uniquely identify
      a group of inventory records.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_position
    owner: AvailableInventory
    domain_of:
    - AssetBase
    - AssetIdentifier
    - ProductIdentifier
    - AssignedIdentifier
    - BusinessUnit
    - EntityIdentifier
    - PartyIdentifier
    - PersonIdentifier
    - TransferBase
    - ContractualDefinition
    - FloatingRateIndexMap
    - CompositionStep
    - InstructionComposition
    - LegalAgreementBase
    - NonLegalEntity
    - OtherAgreement
    - AvailableInventory
    - InventoryRecord
    - ClauseLibraryClause
    - ClauseLibraryClauseVariant
    - Clause
    - EligibleCollateralSpecification
    - NonTransferableProduct
    range: AssignedIdentifier
  comment:
    name: comment
    description: Optional comments for this group of inventory records.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_position
    rank: 1000
    owner: AvailableInventory
    domain_of:
    - AvailableInventory
    - AvailableInventoryRecord
    - WorkflowState
    range: string
  messageInformation:
    name: messageInformation
    description: Allows details related to the availability messaging use case to
      be defined
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_position
    rank: 1000
    owner: AvailableInventory
    domain_of:
    - AvailableInventory
    - WorkflowStep
    range: MessageInformation
  party:
    name: party
    description: Defines all parties involved for the list of inventory records in
      this set of inventory. For example, when used to describe securities lending
      availability, this could hold the sender of the availability, the intended recipient,
      the beneficial owner(s), the lender (which may differ from the sender as the
      lender may have the same piece of availability going through multiple agents),
      an agent or a venue.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_position
    owner: AvailableInventory
    domain_of:
    - AssetBase
    - DebtRedemption
    - MarginCallBase
    - Trade
    - UmbrellaAgreementParty
    - UmbrellaAgreementSet
    - AggregationParameters
    - AvailableInventory
    - CounterpartyPosition
    - WorkflowStep
    - WorkflowStepApproval
    - AdditionalObligations
    - AdditionalRepresentationElection
    - CalculationAgentTerms
    - CalculationCurrencyElection
    - CollateralManagementAgreementElection
    - ControlAgreementElections
    - ControlAgreementNecEventElection
    - CreditSupportDocumentElection
    - CreditSupportProviderElection
    - CustodianElection
    - CustodianRiskElection
    - ElectiveAmountElection
    - FrenchLawAddendumElection
    - HoldingAndUsingPostedCollateralElection
    - LegacyExposureScopeElection
    - LegacyIndependentAmountParty
    - MinimumTransferAmountElection
    - NotificationTimeElection
    - PledgeeRepresentativeRider
    - PostingObligationsElection
    - RecalculationOfValueElection
    - RegimeTerms
    - SecuredPartyRightsEventElection
    - SecurityInterestForObligations
    - SecurityProviderRightsEventElection
    - SensitivityMethodologiesPartyElection
    - SinglePostingParty
    - SpecifiedOrAccessConditionPartyElection
    - SubstitutedRegimeElection
    - SubstitutionPartyElection
    - TerminationCurrencyElection
    - ThresholdElection
    - ValuationAgent
    - ValuationCalculationDateLocationElection
    - AdditionalTerminationEventElection
    - AutomaticEarlyTerminationElection
    - CreditEventUponMergerElection
    - PartyTerminationCurrencySelection
    - SpecifiedEntity
    - EventsOfDefaultElection
    - EligibleCollateralSpecification
    range: Party
    multivalued: true
  partyRole:
    name: partyRole
    description: Defines the role(s) that party(ies) may have in relation to the inventory.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_position
    owner: AvailableInventory
    domain_of:
    - AssetBase
    - MarginCallBase
    - PartyChangeInstruction
    - Trade
    - UmbrellaAgreementParty
    - AvailableInventory
    - AvailableInventoryRecord
    - CounterpartyPosition
    - EligibleCollateralSpecification
    range: PartyRole
    multivalued: true
  availableInventoryRecord:
    name: availableInventoryRecord
    description: An array holding the list of inventory being described. Each element
      in the inventoryRecord array represents an individual piece of inventory i.e.
      a security.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_position
    rank: 1000
    owner: AvailableInventory
    domain_of:
    - AvailableInventory
    range: AvailableInventoryRecord
    multivalued: true