Class: Cash

name: Cash
annotations:
  rosetta_functions:
    tag: rosetta_functions
    value: '[{"name":"GetCashCurrency","description":"Returns the enumerated Currency
      Code of a Cash asset.","inputs":[{"name":"cash","type":"Cash","cardinality":"1..1"}],"output":{"name":"currencyEnum","type":"CurrencyCodeEnum","cardinality":"1..1"}},{"name":"SetCashCurrency","description":"Sets
      (or updates) the string identifier of a Cash asset using an enumerated Currency
      Code.","inputs":[{"name":"cash","type":"Cash","cardinality":"0..1"},{"name":"currency","type":"CurrencyCodeEnum","cardinality":"1..1"}],"output":{"name":"cashOutput","type":"Cash","cardinality":"1..1"}}]'
description: An Asset that consists solely of a monetary holding in a currency. The
  currency of the Cash asset is held in the string Identifier (from AssetBase) and
  the AssetIdTypeEnum must be set to define that a CurrencyCode is set.  The function
  SetCashCurrency can be used to create (or update) a Cash object and the function
  GetCashCurrency can be used to retrieve the currency of a Cash object.
comments:
- 'Rosetta condition: CurrencyExists — AssetIdentifierByType(identifier, AssetIdTypeEnum
  -> CurrencyCode) count = 1 and AssetIdentifierByType(identifier, AssetIdTypeEnum
  -> CurrencyCode) -> identifier first to-enum CurrencyCodeEnum exists'
- 'Rosetta condition: NoTaxonomy — taxonomy is absent'
- 'Rosetta condition: NoExchange — exchange is absent and isExchangeListed is absent'
- 'Rosetta condition: AssetType — assetType = Cash'
- 'Rosetta func: GetCashCurrency — Returns the enumerated Currency Code of a Cash
  asset.'
- 'Rosetta func: SetCashCurrency — Sets (or updates) the string identifier of a Cash
  asset using an enumerated Currency Code.'
in_subset:
- cdm_base_staticdata_asset_common
from_schema: https://w3id.org/lmodel/common-domain-model
close_mappings:
- gist:Magnitude
is_a: AssetBase
rules:
- postconditions:
    slot_conditions:
      taxonomy:
        name: taxonomy
        required: false
  description: Taxonomy is not applicable for a Cash asset.
- postconditions:
    slot_conditions:
      exchange:
        name: exchange
        required: false
      isExchangeListed:
        name: isExchangeListed
        required: false
  description: Cash cannot be a listed Asset.
- postconditions:
    slot_conditions:
      assetType:
        name: assetType
        equals_string: Cash
  description: AssetType must be cash.

name: Cash
annotations:
  rosetta_functions:
    tag: rosetta_functions
    value: '[{"name":"GetCashCurrency","description":"Returns the enumerated Currency
      Code of a Cash asset.","inputs":[{"name":"cash","type":"Cash","cardinality":"1..1"}],"output":{"name":"currencyEnum","type":"CurrencyCodeEnum","cardinality":"1..1"}},{"name":"SetCashCurrency","description":"Sets
      (or updates) the string identifier of a Cash asset using an enumerated Currency
      Code.","inputs":[{"name":"cash","type":"Cash","cardinality":"0..1"},{"name":"currency","type":"CurrencyCodeEnum","cardinality":"1..1"}],"output":{"name":"cashOutput","type":"Cash","cardinality":"1..1"}}]'
description: An Asset that consists solely of a monetary holding in a currency. The
  currency of the Cash asset is held in the string Identifier (from AssetBase) and
  the AssetIdTypeEnum must be set to define that a CurrencyCode is set.  The function
  SetCashCurrency can be used to create (or update) a Cash object and the function
  GetCashCurrency can be used to retrieve the currency of a Cash object.
comments:
- 'Rosetta condition: CurrencyExists — AssetIdentifierByType(identifier, AssetIdTypeEnum
  -> CurrencyCode) count = 1 and AssetIdentifierByType(identifier, AssetIdTypeEnum
  -> CurrencyCode) -> identifier first to-enum CurrencyCodeEnum exists'
- 'Rosetta condition: NoTaxonomy — taxonomy is absent'
- 'Rosetta condition: NoExchange — exchange is absent and isExchangeListed is absent'
- 'Rosetta condition: AssetType — assetType = Cash'
- 'Rosetta func: GetCashCurrency — Returns the enumerated Currency Code of a Cash
  asset.'
- 'Rosetta func: SetCashCurrency — Sets (or updates) the string identifier of a Cash
  asset using an enumerated Currency Code.'
in_subset:
- cdm_base_staticdata_asset_common
from_schema: https://w3id.org/lmodel/common-domain-model
close_mappings:
- gist:Magnitude
is_a: AssetBase
attributes:
  identifier:
    name: identifier
    description: Asset Identifiers are used to uniquely identify an Asset, using a
      specified Asset Identifier Type.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:AssetBase.identifier
    rank: 1000
    owner: Cash
    domain_of:
    - AssetBase
    - AssetIdentifier
    - ProductIdentifier
    - AssignedIdentifier
    - BusinessUnit
    - PartyIdentifier
    - EntityIdentifier
    - PersonIdentifier
    - TransferBase
    - OtherAgreement
    - LegalAgreementBase
    - NonLegalEntity
    - MasterAgreementClauseVariant
    - Clause
    - ContractualDefinition
    - FloatingRateIndexMap
    - EligibleCollateralSpecification
    - NonTransferableProduct
    range: AssetIdentifier
    required: true
    multivalued: true
  taxonomy:
    name: taxonomy
    description: Defines the taxonomy of an object by combining a taxonomy source
      (i.e. the rules to classify the object) and a value (i.e. the output of those
      rules on the object.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:AssetBase.taxonomy
    rank: 1000
    owner: Cash
    domain_of:
    - AssetBase
    - NonTransferableProduct
    range: Taxonomy
    multivalued: true
    inlined: true
    inlined_as_list: true
  isExchangeListed:
    name: isExchangeListed
    description: Defines whether the Asset is listed on a public exchange.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:AssetBase.isExchangeListed
    rank: 1000
    owner: Cash
    domain_of:
    - AssetBase
    range: boolean
  exchange:
    name: exchange
    description: If the Asset is listed, defines the public exchange of the listing.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:AssetBase.exchange
    rank: 1000
    owner: Cash
    domain_of:
    - AssetBase
    - ListingExchange
    range: LegalEntity
  relatedExchange:
    name: relatedExchange
    description: Provides the related Exchanges, if applicable.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:AssetBase.relatedExchange
    rank: 1000
    owner: Cash
    domain_of:
    - AssetBase
    range: LegalEntity
    multivalued: true
    inlined: true
    inlined_as_list: true
  assetType:
    name: assetType
    description: Specifies the type of asset.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:AssetBase.assetType
    rank: 1000
    owner: Cash
    domain_of:
    - AssetBase
    - AssetType
    range: AssetTypeEnum
    required: true
rules:
- postconditions:
    slot_conditions:
      taxonomy:
        name: taxonomy
        required: false
  description: Taxonomy is not applicable for a Cash asset.
- postconditions:
    slot_conditions:
      exchange:
        name: exchange
        required: false
      isExchangeListed:
        name: isExchangeListed
        required: false
  description: Cash cannot be a listed Asset.
- postconditions:
    slot_conditions:
      assetType:
        name: assetType
        equals_string: Cash
  description: AssetType must be cash.