Skip to content

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 : identifer





        AvailableInventoryRecord --> "1" AssignedIdentifier : identifer
        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

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
identifer 1
AssignedIdentifier		 Unique identifier for this record InventoryRecord
security 1
Security		 The security details InventoryRecord

Usages

used by used in type used
AvailableInventory availableInventoryRecord range AvailableInventoryRecord
SecurityLocate availableInventoryRecord range AvailableInventoryRecord

In Subsets

Comments

  • Rosetta condition: InterestRate — if interestRate exists then interestRate -> priceType = PriceTypeEnum -> InterestRate
  • Rosetta condition: ValidPartyRole — IsValidPartyRole( partyRole, [PartyRoleEnum -> AgentLender, PartyRoleEnum -> BeneficialOwner, PartyRoleEnum -> Custodian, PartyRoleEnum -> Lender] )

Identifier and Mapping Information

Schema Source

Mappings

Mapping Type Mapped Value
self common_domain_model:AvailableInventoryRecord
native common_domain_model:AvailableInventoryRecord
close fpml_5_10:AvailableInventoryRecord

LinkML Source

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 — if interestRate exists then interestRate -> priceType
  = PriceTypeEnum -> InterestRate'
- 'Rosetta condition: ValidPartyRole — IsValidPartyRole( partyRole, [PartyRoleEnum
  -> AgentLender, PartyRoleEnum -> BeneficialOwner, PartyRoleEnum -> Custodian, PartyRoleEnum
  -> Lender] )'
in_subset:
- cdm_event_position
from_schema: https://w3id.org/lmodel/common-domain-model
close_mappings:
- fpml_5_10:AvailableInventoryRecord
is_a: InventoryRecord
slots:
- expirationDateTime
- collateral
- partyRole
- quantity
- interestRate
- dividendTerms
- comment
slot_usage:
  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.
    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.
    multivalued: true
  quantity:
    name: quantity
    description: The quantity of the security
  comment:
    name: comment
    description: Optional comment for this specific piece of inventory.

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 — if interestRate exists then interestRate -> priceType
  = PriceTypeEnum -> InterestRate'
- 'Rosetta condition: ValidPartyRole — IsValidPartyRole( partyRole, [PartyRoleEnum
  -> AgentLender, PartyRoleEnum -> BeneficialOwner, PartyRoleEnum -> Custodian, PartyRoleEnum
  -> Lender] )'
in_subset:
- cdm_event_position
from_schema: https://w3id.org/lmodel/common-domain-model
close_mappings:
- fpml_5_10:AvailableInventoryRecord
is_a: InventoryRecord
slot_usage:
  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.
    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.
    multivalued: true
  quantity:
    name: quantity
    description: The quantity of the security
  comment:
    name: comment
    description: Optional comment for this specific piece of inventory.
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
    close_mappings:
    - fpml_5_10:AvailableInventoryRecord.expirationDateTime
    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
    rank: 1000
    owner: AvailableInventoryRecord
    domain_of:
    - ExecutionInstruction
    - Trade
    - ContractBase
    - AvailableInventoryRecord
    - 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
    rank: 1000
    owner: AvailableInventoryRecord
    domain_of:
    - PartyChangeInstruction
    - Trade
    - MarginCallBase
    - CounterpartyPosition
    - AvailableInventory
    - AvailableInventoryRecord
    - UmbrellaAgreementParty
    - EligibleCollateralSpecification
    range: PartyRole
    multivalued: true
  quantity:
    name: quantity
    description: The quantity of the security
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:CalculateTransferInstruction.quantity
    rank: 1000
    owner: AvailableInventoryRecord
    domain_of:
    - CalculateTransferInstruction
    - ReturnInstruction
    - AvailableInventoryRecord
    - PriceQuantity
    - BasketConstituent
    - FutureValueAmount
    - AssetFlowBase
    - 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
    close_mappings:
    - fpml_5_10:AvailableInventoryRecord.interestRate
    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
    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
    rank: 1000
    owner: AvailableInventoryRecord
    domain_of:
    - AvailableInventory
    - AvailableInventoryRecord
    - WorkflowState
    range: string
  identifer:
    name: identifer
    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
    rank: 1000
    owner: AvailableInventoryRecord
    domain_of:
    - InventoryRecord
    - AvailableInventory
    - MasterAgreementClause
    range: AssignedIdentifier
    required: true
  security:
    name: security
    description: The security details.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: AvailableInventoryRecord
    domain_of:
    - InventoryRecord
    - ReferenceObligation
    range: Security
    required: true