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





        AvailableInventory --> "0..1" AssignedIdentifier : identifer
        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

Class Properties

Property	Value
Tree Root	Yes

Slots

Name	Cardinality and Range	Description	Inheritance
availableInventoryType	1 AvailableInventoryTypeEnum	Defines the purpose of this inventory	direct
identifer	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

In Subsets

CdmEventPosition

Comments

Rosetta condition: ValidPartyRole — IsValidPartyRole( partyRole, [PartyRoleEnum -> AgentLender, PartyRoleEnum -> BeneficialOwner, PartyRoleEnum -> Borrower, PartyRoleEnum -> Custodian, PartyRoleEnum -> Lender] )

Identifier and Mapping Information

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
close	fpml_5_10:AvailableInventory

LinkML Source

Direct

name: AvailableInventory
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 — IsValidPartyRole( partyRole, [PartyRoleEnum
  -> AgentLender, PartyRoleEnum -> BeneficialOwner, PartyRoleEnum -> Borrower, PartyRoleEnum
  -> Custodian, PartyRoleEnum -> Lender] )'
in_subset:
- cdm_event_position
from_schema: https://w3id.org/lmodel/common-domain-model
close_mappings:
- fpml_5_10:AvailableInventory
slots:
- availableInventoryType
- identifer
- comment
- messageInformation
- party
- partyRole
- availableInventoryRecord
slot_usage:
  identifer:
    name: identifer
    description: Unique identifier for this group. This can be used to uniquely identify
      a group of inventory records.
    required: false
  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.
    range: Party
    multivalued: true
  partyRole:
    name: partyRole
    description: Defines the role(s) that party(ies) may have in relation to the inventory.
    multivalued: true
tree_root: true

Induced

name: AvailableInventory
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 — IsValidPartyRole( partyRole, [PartyRoleEnum
  -> AgentLender, PartyRoleEnum -> BeneficialOwner, PartyRoleEnum -> Borrower, PartyRoleEnum
  -> Custodian, PartyRoleEnum -> Lender] )'
in_subset:
- cdm_event_position
from_schema: https://w3id.org/lmodel/common-domain-model
close_mappings:
- fpml_5_10:AvailableInventory
slot_usage:
  identifer:
    name: identifer
    description: Unique identifier for this group. This can be used to uniquely identify
      a group of inventory records.
    required: false
  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.
    range: Party
    multivalued: true
  partyRole:
    name: partyRole
    description: Defines the role(s) that party(ies) may have in relation to the inventory.
    multivalued: true
attributes:
  availableInventoryType:
    name: availableInventoryType
    description: Defines the purpose of this inventory.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:AvailableInventory.availableInventoryType
    rank: 1000
    owner: AvailableInventory
    domain_of:
    - AvailableInventory
    range: AvailableInventoryTypeEnum
    required: true
  identifer:
    name: identifer
    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
    rank: 1000
    owner: AvailableInventory
    domain_of:
    - InventoryRecord
    - AvailableInventory
    - MasterAgreementClause
    range: AssignedIdentifier
    required: false
  comment:
    name: comment
    description: Optional comments for this group of inventory records.
    from_schema: https://w3id.org/lmodel/common-domain-model
    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
    close_mappings:
    - fpml_5_10:AvailableInventory.messageInformation
    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
    rank: 1000
    owner: AvailableInventory
    domain_of:
    - DebtRedemption
    - Trade
    - MarginCallBase
    - CounterpartyPosition
    - AggregationParameters
    - AvailableInventory
    - WorkflowStepApproval
    - WorkflowStep
    - UmbrellaAgreementParty
    - UmbrellaAgreementSet
    - AdditionalRepresentationElection
    - CalculationAgentTerms
    - CalculationCurrencyElection
    - ValuationCalculationDateLocationElection
    - CollateralManagementAgreementElection
    - ControlAgreementElections
    - ControlAgreementNecEventElection
    - CustodianElection
    - CustodianRiskElection
    - ElectiveAmountElection
    - FrenchLawAddendumElection
    - HoldingAndUsingPostedCollateralElection
    - NotificationTimeElection
    - PostingObligationsElection
    - RecalculationOfValueElection
    - RegimeTerms
    - PledgeeRepresentativeRider
    - SecuredPartyRightsEventElection
    - SecurityProviderRightsEventElection
    - SensitivityMethodologiesPartyElection
    - SubstitutedRegimeTerms
    - SubstitutionPartyElection
    - TerminationCurrencyElection
    - AdditionalObligations
    - SecurityInterestForObligations
    - SinglePostingParty
    - ThresholdElection
    - MinimumTransferAmountElection
    - ValuationAgent
    - LegacyExposureScopeElection
    - CreditSupportDocumentElection
    - CreditSupportProviderElection
    - SpecifiedOrAccessConditionPartyElection
    - LegacyIndependentAmountParty
    - AutomaticEarlyTerminationElection
    - 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
    rank: 1000
    owner: AvailableInventory
    domain_of:
    - PartyChangeInstruction
    - Trade
    - MarginCallBase
    - CounterpartyPosition
    - AvailableInventory
    - AvailableInventoryRecord
    - UmbrellaAgreementParty
    - 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
    close_mappings:
    - fpml_5_10:AvailableInventory.availableInventoryRecord
    rank: 1000
    owner: AvailableInventory
    domain_of:
    - AvailableInventory
    range: AvailableInventoryRecord
    multivalued: true
    inlined: true
    inlined_as_list: true
tree_root: true