Skip to content

Class: CheckEligibilityResult

Result for the CheckEligibilityByDetails and CheckEligibilityForProduct functions

URI: common_domain_model:CheckEligibilityResult

 classDiagram
    class CheckEligibilityResult
    click CheckEligibilityResult href "../CheckEligibilityResult/"
      CheckEligibilityResult : eligibilityQuery





        CheckEligibilityResult --> "1" EligibilityQuery : eligibilityQuery
        click EligibilityQuery href "../EligibilityQuery/"



      CheckEligibilityResult : isEligible

      CheckEligibilityResult : matchingEligibleCriteria





        CheckEligibilityResult --> "*" EligibleCollateralCriteria : matchingEligibleCriteria
        click EligibleCollateralCriteria href "../EligibleCollateralCriteria/"



      CheckEligibilityResult : specification





        CheckEligibilityResult --> "1" EligibleCollateralSpecification : specification
        click EligibleCollateralSpecification href "../EligibleCollateralSpecification/"

Slots

Name Cardinality and Range Description Inheritance
isEligible 1
Boolean		 a simple boolean which is set to true if the asset described in the Eligibili... direct
matchingEligibleCriteria *
EligibleCollateralCriteria		 if there was a match, this will be the one or more criteria that were supplie... direct
eligibilityQuery 1
EligibilityQuery		 a copy of the input query that was checked against the eligible collateral sp... direct
specification 1
EligibleCollateralSpecification		 a copy of the input EligbilityCollateralSpecification that was checked agains... direct

In Subsets

Comments

  • Rosetta func: CheckEligibilityForProduct
  • Rosetta func: CheckEligibilityByDetails — This function when presented with a set of Asset and Issuer details to be potentially posted as collateral, will check against a set of given Eligibility Criteria or Basket (EligibleCollateralSpecification) to determine which collateral meets the eligibility and can be used/posted for delivery.

Identifier and Mapping Information

Annotations

property value
rosetta_functions [{"name":"CheckEligibilityForProduct","inputs":[{"name":"specifications","type":"EligibleCollateralSpecification","cardinality":"1..*"},{"name":"product","type":"TransferableProduct","cardinality":"0..1"}],"output":{"name":"eligibilityResult","type":"CheckEligibilityResult","cardinality":"0..1"},"code_implementation":true},{"name":"CheckEligibilityByDetails","description":"This function when presented with a set of Asset and Issuer details to be potentially posted as collateral, will check against a set of given Eligibility Criteria or Basket (EligibleCollateralSpecification) to determine which collateral meets the eligibility and can be used/posted for delivery.","inputs":[{"name":"specification","type":"EligibleCollateralSpecification","cardinality":"1..1"},{"name":"query","type":"EligibilityQuery","cardinality":"1..1"}],"output":{"name":"eligibilityResult","type":"CheckEligibilityResult","cardinality":"1..1"}}]

Schema Source

Mappings

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

LinkML Source

Direct

name: CheckEligibilityResult
annotations:
  rosetta_functions:
    tag: rosetta_functions
    value: '[{"name":"CheckEligibilityForProduct","inputs":[{"name":"specifications","type":"EligibleCollateralSpecification","cardinality":"1..*"},{"name":"product","type":"TransferableProduct","cardinality":"0..1"}],"output":{"name":"eligibilityResult","type":"CheckEligibilityResult","cardinality":"0..1"},"code_implementation":true},{"name":"CheckEligibilityByDetails","description":"This
      function when presented with a set of Asset and Issuer details to be potentially
      posted as collateral, will check against a set of given Eligibility Criteria
      or Basket (EligibleCollateralSpecification) to determine which collateral meets
      the eligibility and can be used/posted for delivery.","inputs":[{"name":"specification","type":"EligibleCollateralSpecification","cardinality":"1..1"},{"name":"query","type":"EligibilityQuery","cardinality":"1..1"}],"output":{"name":"eligibilityResult","type":"CheckEligibilityResult","cardinality":"1..1"}}]'
description: Result for the CheckEligibilityByDetails and CheckEligibilityForProduct
  functions
comments:
- 'Rosetta func: CheckEligibilityForProduct'
- 'Rosetta func: CheckEligibilityByDetails — This function when presented with a set
  of Asset and Issuer details to be potentially posted as collateral, will check against
  a set of given Eligibility Criteria or Basket (EligibleCollateralSpecification)
  to determine which collateral meets the eligibility and can be used/posted for delivery.'
in_subset:
- cdm_product_collateral
from_schema: https://w3id.org/lmodel/common-domain-model
slots:
- isEligible
- matchingEligibleCriteria
- eligibilityQuery
- specification

Induced

name: CheckEligibilityResult
annotations:
  rosetta_functions:
    tag: rosetta_functions
    value: '[{"name":"CheckEligibilityForProduct","inputs":[{"name":"specifications","type":"EligibleCollateralSpecification","cardinality":"1..*"},{"name":"product","type":"TransferableProduct","cardinality":"0..1"}],"output":{"name":"eligibilityResult","type":"CheckEligibilityResult","cardinality":"0..1"},"code_implementation":true},{"name":"CheckEligibilityByDetails","description":"This
      function when presented with a set of Asset and Issuer details to be potentially
      posted as collateral, will check against a set of given Eligibility Criteria
      or Basket (EligibleCollateralSpecification) to determine which collateral meets
      the eligibility and can be used/posted for delivery.","inputs":[{"name":"specification","type":"EligibleCollateralSpecification","cardinality":"1..1"},{"name":"query","type":"EligibilityQuery","cardinality":"1..1"}],"output":{"name":"eligibilityResult","type":"CheckEligibilityResult","cardinality":"1..1"}}]'
description: Result for the CheckEligibilityByDetails and CheckEligibilityForProduct
  functions
comments:
- 'Rosetta func: CheckEligibilityForProduct'
- 'Rosetta func: CheckEligibilityByDetails — This function when presented with a set
  of Asset and Issuer details to be potentially posted as collateral, will check against
  a set of given Eligibility Criteria or Basket (EligibleCollateralSpecification)
  to determine which collateral meets the eligibility and can be used/posted for delivery.'
in_subset:
- cdm_product_collateral
from_schema: https://w3id.org/lmodel/common-domain-model
attributes:
  isEligible:
    name: isEligible
    description: a simple boolean which is set to true if the asset described in the
      EligibilityQuery input is eligible
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: CheckEligibilityResult
    domain_of:
    - CheckEligibilityResult
    range: boolean
    required: true
  matchingEligibleCriteria:
    name: matchingEligibleCriteria
    description: if there was a match, this will be the one or more criteria that
      were supplied in the EligbilityCollateralSpecification which matched with the
      query input
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: CheckEligibilityResult
    domain_of:
    - CheckEligibilityResult
    range: EligibleCollateralCriteria
    multivalued: true
    inlined: true
    inlined_as_list: true
  eligibilityQuery:
    name: eligibilityQuery
    description: a copy of the input query that was checked against the eligible collateral
      specification
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: CheckEligibilityResult
    domain_of:
    - CheckEligibilityResult
    range: EligibilityQuery
    required: true
  specification:
    name: specification
    description: a copy of the input EligbilityCollateralSpecification that was checked
      against the query
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: CheckEligibilityResult
    domain_of:
    - CheckEligibilityResult
    range: EligibleCollateralSpecification
    required: true