Skip to content
common-domain-model

Class: AvailableInventoryRecord

An individual piece of available inventory. This represents a single security and its associated criteria. The criteria are used to describe any restrictions on the securities.

URI: common_domain_model:AvailableInventoryRecord

 classDiagram
    class AvailableInventoryRecord
    click AvailableInventoryRecord href "../AvailableInventoryRecord/"
      InventoryRecord <|-- AvailableInventoryRecord
        click InventoryRecord href "../InventoryRecord/"
      
      AvailableInventoryRecord : collateral
        
          
    
        
        
        AvailableInventoryRecord --> "*" CollateralProvisions : collateral
        click CollateralProvisions href "../CollateralProvisions/"
    

        
      AvailableInventoryRecord : comment
        
      AvailableInventoryRecord : dividendTerms
        
          
    
        
        
        AvailableInventoryRecord --> "0..1" DividendTerms : dividendTerms
        click DividendTerms href "../DividendTerms/"
    

        
      AvailableInventoryRecord : expirationDateTime
        
      AvailableInventoryRecord : identifier
        
          
    
        
        
        AvailableInventoryRecord --> "1" AssignedIdentifier : identifier
        click AssignedIdentifier href "../AssignedIdentifier/"
    

        
      AvailableInventoryRecord : interestRate
        
          
    
        
        
        AvailableInventoryRecord --> "0..1" Price : interestRate
        click Price href "../Price/"
    

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

        
      AvailableInventoryRecord : quantity
        
          
    
        
        
        AvailableInventoryRecord --> "0..1" Quantity : quantity
        click Quantity href "../Quantity/"
    

        
      AvailableInventoryRecord : security
        
          
    
        
        
        AvailableInventoryRecord --> "1" Security : security
        click Security href "../Security/"

Inheritance

Section titled “Inheritance”

Slots

Section titled “Slots”
Name Cardinality and Range Description Inheritance
expirationDateTime 0..1
Datetime		 There may be a set period/time restriction associated to the security direct
collateral *
CollateralProvisions		 The type of collateral can often be required when determining if the piece of… direct
partyRole *
PartyRole		 An individual security may be held by several agents direct
quantity 0..1
Quantity		 The quantity of the security direct
interestRate 0..1
Price		 An optional element which can be used to hold a rate associated to this piece… direct
dividendTerms 0..1
DividendTerms		 Specifies the dividend requirements if applicable direct
comment 0..1
string		 Optional comment for this specific piece of inventory direct
identifier 1
AssignedIdentifier		 Unique identifier for this record InventoryRecord
security 1
Security		 The security details InventoryRecord

Usages

Section titled “Usages”
used by used in type used
AvailableInventory availableInventoryRecord range AvailableInventoryRecord
SecurityLocate availableInventoryRecord range AvailableInventoryRecord

Comments

Section titled “Comments”
  • Rosetta condition InterestRate is not stated in LinkML: if interestRate exists then interestRate -> priceType = PriceTypeEnum -> InterestRate
  • Rosetta condition ValidPartyRole is not stated in LinkML: IsValidPartyRole (partyRole, [PartyRoleEnum -> AgentLender, PartyRoleEnum -> BeneficialOwner, PartyRoleEnum -> Custodian, PartyRoleEnum -> Lender])

Identifier and Mapping Information

Section titled “Identifier and Mapping Information”

Schema Source

Section titled “Schema Source”

Mappings

Section titled “Mappings”
Mapping Type Mapped Value
self common_domain_model:AvailableInventoryRecord
native common_domain_model:AvailableInventoryRecord

LinkML Source

Section titled “LinkML Source”

Direct

Section titled “Direct”
name: AvailableInventoryRecord
description: An individual piece of available inventory. This represents a single
  security and its associated criteria. The criteria are used to describe any restrictions
  on the securities.
comments:
- 'Rosetta condition InterestRate is not stated in LinkML: if interestRate exists
  then interestRate -> priceType = PriceTypeEnum -> InterestRate'
- 'Rosetta condition ValidPartyRole is not stated in LinkML: IsValidPartyRole (partyRole,
  [PartyRoleEnum -> AgentLender, PartyRoleEnum -> BeneficialOwner, PartyRoleEnum ->
  Custodian, PartyRoleEnum -> Lender])'
from_schema: https://w3id.org/lmodel/common-domain-model
is_a: InventoryRecord
attributes:
  expirationDateTime:
    name: expirationDateTime
    description: There may be a set period/time restriction associated to the security.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_position
    rank: 1000
    domain_of:
    - AvailableInventoryRecord
    range: datetime
  collateral:
    name: collateral
    description: The type of collateral can often be required when determining if
      the piece of availability being described is suitable for a party.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_position
    domain_of:
    - ExecutionInstruction
    - Trade
    - AvailableInventoryRecord
    - ContractBase
    - GlobalMasterSecuritiesLendingAgreement
    - EconomicTerms
    range: CollateralProvisions
    multivalued: true
  partyRole:
    name: partyRole
    description: An individual security may be held by several agents. Including the
      party role at this level allows us to reference the party holding this specific
      item.
    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
  quantity:
    name: quantity
    description: The quantity of the security
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_position
    domain_of:
    - CalculateTransferInstruction
    - ReturnInstruction
    - TransferBase
    - BasketConstituent
    - PriceQuantity
    - AvailableInventoryRecord
    - FutureValueAmount
    - PortfolioReturnTerms
    range: Quantity
  interestRate:
    name: interestRate
    description: An optional element which can be used to hold a rate associated to
      this piece of availability.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_position
    rank: 1000
    domain_of:
    - AvailableInventoryRecord
    range: Price
  dividendTerms:
    name: dividendTerms
    description: Specifies the dividend requirements if applicable.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_position
    rank: 1000
    domain_of:
    - AvailableInventoryRecord
    - AssetPayout
    range: DividendTerms
  comment:
    name: comment
    description: Optional comment for this specific piece of inventory.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_position
    domain_of:
    - AvailableInventory
    - AvailableInventoryRecord
    - WorkflowState
    range: string

Induced

Section titled “Induced”
name: AvailableInventoryRecord
description: An individual piece of available inventory. This represents a single
  security and its associated criteria. The criteria are used to describe any restrictions
  on the securities.
comments:
- 'Rosetta condition InterestRate is not stated in LinkML: if interestRate exists
  then interestRate -> priceType = PriceTypeEnum -> InterestRate'
- 'Rosetta condition ValidPartyRole is not stated in LinkML: IsValidPartyRole (partyRole,
  [PartyRoleEnum -> AgentLender, PartyRoleEnum -> BeneficialOwner, PartyRoleEnum ->
  Custodian, PartyRoleEnum -> Lender])'
from_schema: https://w3id.org/lmodel/common-domain-model
is_a: InventoryRecord
attributes:
  expirationDateTime:
    name: expirationDateTime
    description: There may be a set period/time restriction associated to the security.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_position
    rank: 1000
    owner: AvailableInventoryRecord
    domain_of:
    - AvailableInventoryRecord
    range: datetime
  collateral:
    name: collateral
    description: The type of collateral can often be required when determining if
      the piece of availability being described is suitable for a party.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_position
    owner: AvailableInventoryRecord
    domain_of:
    - ExecutionInstruction
    - Trade
    - AvailableInventoryRecord
    - ContractBase
    - GlobalMasterSecuritiesLendingAgreement
    - EconomicTerms
    range: CollateralProvisions
    multivalued: true
  partyRole:
    name: partyRole
    description: An individual security may be held by several agents. Including the
      party role at this level allows us to reference the party holding this specific
      item.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_position
    owner: AvailableInventoryRecord
    domain_of:
    - AssetBase
    - MarginCallBase
    - PartyChangeInstruction
    - Trade
    - UmbrellaAgreementParty
    - AvailableInventory
    - AvailableInventoryRecord
    - CounterpartyPosition
    - EligibleCollateralSpecification
    range: PartyRole
    multivalued: true
  quantity:
    name: quantity
    description: The quantity of the security
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_position
    owner: AvailableInventoryRecord
    domain_of:
    - CalculateTransferInstruction
    - ReturnInstruction
    - TransferBase
    - BasketConstituent
    - PriceQuantity
    - AvailableInventoryRecord
    - FutureValueAmount
    - PortfolioReturnTerms
    range: Quantity
  interestRate:
    name: interestRate
    description: An optional element which can be used to hold a rate associated to
      this piece of availability.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_position
    rank: 1000
    owner: AvailableInventoryRecord
    domain_of:
    - AvailableInventoryRecord
    range: Price
  dividendTerms:
    name: dividendTerms
    description: Specifies the dividend requirements if applicable.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_position
    rank: 1000
    owner: AvailableInventoryRecord
    domain_of:
    - AvailableInventoryRecord
    - AssetPayout
    range: DividendTerms
  comment:
    name: comment
    description: Optional comment for this specific piece of inventory.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_position
    owner: AvailableInventoryRecord
    domain_of:
    - AvailableInventory
    - AvailableInventoryRecord
    - WorkflowState
    range: string
  identifier:
    name: identifier
    description: Unique identifier for this record. This can be used to uniquely identify
      a specific piece of inventory.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_position
    owner: AvailableInventoryRecord
    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
    required: true
  security:
    name: security
    description: The security details.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_position
    rank: 1000
    owner: AvailableInventoryRecord
    domain_of:
    - InventoryRecord
    - ReferenceObligation
    range: Security
    required: true