Class: Resource

Describes the resource that contains the media representation of a business event (i.e used for stating the Publicly Available Information). For example, can describe a file or a URL that represents the event. This type is an extended version of a type defined by RIXML (www.rixml.org). Rosetta restricts the FpML implementation by not providing the ability to associated a document in hexadecimalBinary or base64Binary until such time that actual use cases will come up.

URI: common_domain_model:Resource

 classDiagram
    class Resource
    click Resource href "../Resource/"
      Resource : comments
        
      Resource : language
        
      Resource : length
        
          
    
        
        
        Resource --> "0..1" ResourceLength : length
        click ResourceLength href "../ResourceLength/"
    

        
      Resource : mimeType
        
      Resource : name
        
      Resource : resourceId
        
      Resource : resourceType
        
          
    
        
        
        Resource --> "0..1" ResourceTypeEnum : resourceType
        click ResourceTypeEnum href "../ResourceTypeEnum/"
    

        
      Resource : sizeInBytes
        
      Resource : string
        
      Resource : url
        
      

Slots

Name	Cardinality and Range	Description	Inheritance
name	0..1 string	The name of the resource	direct
url	0..1 string	Indicates where the resource can be found, as a URL that references the infor…	direct
resourceId	1 string	The unique identifier of the resource within the event	direct
resourceType	0..1 ResourceTypeEnum	A description of the type of the resource, e	direct
language	0..1 string	Indicates the language of the resource, described using the ISO 639-2/T Code	direct
sizeInBytes	0..1 Decimal	Indicates the size of the resource in bytes	direct
length	0..1 ResourceLength	Indicates the length of the resource	direct
mimeType	0..1 string	Indicates the type of media used to store the content	direct
comments	0..1 string	Any additional comments that are deemed necessary	direct
string	0..1 string	Provides extra information as string	direct

Expressions & Logic

All Of

The class must satisfy all of:

• AnonymousClassExpression({ ‘description’: (’ResourceChoice: Choice rule to represent an FpML choice construct. Note that ’ ’FpML also provides the ability to have hexadecimalBinary or base64Binary, ’ ‘which have not been implemented in Rosetta until we see actual use cases.’), ‘exactly_one_of’: [AnonymousClassExpression({ ‘slot_conditions’: {‘string’: SlotDefinition({‘name’: ‘string’, ‘value_presence’: PresenceEnum(text=‘PRESENT’)})} }), AnonymousClassExpression({ ‘slot_conditions’: {‘url’: SlotDefinition({‘name’: ‘url’, ‘value_presence’: PresenceEnum(text=‘PRESENT’)})} }), AnonymousClassExpression({ ‘all_of’: [AnonymousClassExpression({ ‘slot_conditions’: {‘string’: SlotDefinition({‘name’: ‘string’, ‘value_presence’: PresenceEnum(text=‘ABSENT’)})} }), AnonymousClassExpression({ ‘slot_conditions’: {‘url’: SlotDefinition({‘name’: ‘url’, ‘value_presence’: PresenceEnum(text=‘ABSENT’)})} })] })] })

Usages

used by	used in	type	used
CreditEvent	publiclyAvailableInformation	range	Resource
LegalAgreement	attachment	range	Resource
LegalAgreementBase	attachment	range	Resource

Identifier and Mapping Information

Schema Source

• from schema: https://w3id.org/lmodel/common-domain-model

Mappings

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

LinkML Source

Direct

name: Resource
description: Describes the resource that contains the media representation of a business
  event (i.e used for stating the Publicly Available Information). For example, can
  describe a file or a URL that represents the event. This type is an extended version
  of a type defined by RIXML (www.rixml.org). Rosetta restricts the FpML implementation
  by not providing the ability to associated a document in hexadecimalBinary or base64Binary
  until such time that actual use cases will come up.
from_schema: https://w3id.org/lmodel/common-domain-model
slots:
- name
- url
slot_usage:
  name:
    name: name
    description: The name of the resource. It is specified as a NormalizedString in
      FpML.
    range: string
  url:
    name: url
    description: Indicates where the resource can be found, as a URL that references
      the information on a web server accessible to the message recipient.
    range: string
attributes:
  resourceId:
    name: resourceId
    annotations:
      rosetta_metadata:
        tag: rosetta_metadata
        value: scheme
    description: The unique identifier of the resource within the event. FpML specifies
      this element of type resourceIdScheme but with no specified value.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_legaldocumentation_common
    rank: 1000
    domain_of:
    - Resource
    range: string
    required: true
  resourceType:
    name: resourceType
    annotations:
      rosetta_metadata:
        tag: rosetta_metadata
        value: scheme
    description: A description of the type of the resource, e.g. a confirmation.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_legaldocumentation_common
    rank: 1000
    domain_of:
    - Resource
    range: ResourceTypeEnum
  language:
    name: language
    annotations:
      rosetta_metadata:
        tag: rosetta_metadata
        value: scheme
    description: Indicates the language of the resource, described using the ISO 639-2/T
      Code.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_legaldocumentation_common
    rank: 1000
    domain_of:
    - Resource
    range: string
  sizeInBytes:
    name: sizeInBytes
    description: Indicates the size of the resource in bytes. It could be used by
      the end user to estimate the download time and storage needs.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_legaldocumentation_common
    rank: 1000
    domain_of:
    - Resource
    range: decimal
  length:
    name: length
    description: Indicates the length of the resource. For example, if the resource
      were a PDF file, the length would be in pages.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_legaldocumentation_common
    rank: 1000
    domain_of:
    - Resource
    range: ResourceLength
  mimeType:
    name: mimeType
    annotations:
      rosetta_metadata:
        tag: rosetta_metadata
        value: scheme
    description: Indicates the type of media used to store the content. mimeType is
      used to determine the software product(s) that can read the content. MIME Types
      are described in RFC 2046.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_legaldocumentation_common
    rank: 1000
    domain_of:
    - Resource
    range: string
  comments:
    name: comments
    description: Any additional comments that are deemed necessary. For example, which
      software version is required to open the document? Or, how does this resource
      relate to the others for this event?
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_legaldocumentation_common
    rank: 1000
    domain_of:
    - Resource
    range: string
  string:
    name: string
    description: Provides extra information as string. In case the extra information
      is in XML format, a CDATA section must be placed around the source message to
      prevent its interpretation as XML content.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_legaldocumentation_common
    rank: 1000
    domain_of:
    - Resource
    range: string
all_of:
- description: 'ResourceChoice: Choice rule to represent an FpML choice construct.
    Note that FpML also provides the ability to have hexadecimalBinary or base64Binary,
    which have not been implemented in Rosetta until we see actual use cases.'
  exactly_one_of:
  - slot_conditions:
      string:
        name: string
        value_presence: PRESENT
  - slot_conditions:
      url:
        name: url
        value_presence: PRESENT
  - all_of:
    - slot_conditions:
        string:
          name: string
          value_presence: ABSENT
    - slot_conditions:
        url:
          name: url
          value_presence: ABSENT

Induced

name: Resource
description: Describes the resource that contains the media representation of a business
  event (i.e used for stating the Publicly Available Information). For example, can
  describe a file or a URL that represents the event. This type is an extended version
  of a type defined by RIXML (www.rixml.org). Rosetta restricts the FpML implementation
  by not providing the ability to associated a document in hexadecimalBinary or base64Binary
  until such time that actual use cases will come up.
from_schema: https://w3id.org/lmodel/common-domain-model
slot_usage:
  name:
    name: name
    description: The name of the resource. It is specified as a NormalizedString in
      FpML.
    range: string
  url:
    name: url
    description: Indicates where the resource can be found, as a URL that references
      the information on a web server accessible to the message recipient.
    range: string
attributes:
  resourceId:
    name: resourceId
    annotations:
      rosetta_metadata:
        tag: rosetta_metadata
        value: scheme
    description: The unique identifier of the resource within the event. FpML specifies
      this element of type resourceIdScheme but with no specified value.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_legaldocumentation_common
    rank: 1000
    owner: Resource
    domain_of:
    - Resource
    range: string
    required: true
  resourceType:
    name: resourceType
    annotations:
      rosetta_metadata:
        tag: rosetta_metadata
        value: scheme
    description: A description of the type of the resource, e.g. a confirmation.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_legaldocumentation_common
    rank: 1000
    owner: Resource
    domain_of:
    - Resource
    range: ResourceTypeEnum
  language:
    name: language
    annotations:
      rosetta_metadata:
        tag: rosetta_metadata
        value: scheme
    description: Indicates the language of the resource, described using the ISO 639-2/T
      Code.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_legaldocumentation_common
    rank: 1000
    owner: Resource
    domain_of:
    - Resource
    range: string
  sizeInBytes:
    name: sizeInBytes
    description: Indicates the size of the resource in bytes. It could be used by
      the end user to estimate the download time and storage needs.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_legaldocumentation_common
    rank: 1000
    owner: Resource
    domain_of:
    - Resource
    range: decimal
  length:
    name: length
    description: Indicates the length of the resource. For example, if the resource
      were a PDF file, the length would be in pages.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_legaldocumentation_common
    rank: 1000
    owner: Resource
    domain_of:
    - Resource
    range: ResourceLength
  mimeType:
    name: mimeType
    annotations:
      rosetta_metadata:
        tag: rosetta_metadata
        value: scheme
    description: Indicates the type of media used to store the content. mimeType is
      used to determine the software product(s) that can read the content. MIME Types
      are described in RFC 2046.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_legaldocumentation_common
    rank: 1000
    owner: Resource
    domain_of:
    - Resource
    range: string
  comments:
    name: comments
    description: Any additional comments that are deemed necessary. For example, which
      software version is required to open the document? Or, how does this resource
      relate to the others for this event?
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_legaldocumentation_common
    rank: 1000
    owner: Resource
    domain_of:
    - Resource
    range: string
  string:
    name: string
    description: Provides extra information as string. In case the extra information
      is in XML format, a CDATA section must be placed around the source message to
      prevent its interpretation as XML content.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_legaldocumentation_common
    rank: 1000
    owner: Resource
    domain_of:
    - Resource
    range: string
  name:
    name: name
    description: The name of the resource. It is specified as a NormalizedString in
      FpML.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: Resource
    domain_of:
    - TaxonomyValue
    - BusinessUnit
    - LegalEntity
    - Party
    - IndexBase
    - Resource
    - ClauseLibraryClause
    - ClauseLibraryClauseVariant
    - ClauseLibraryVariableSet
    - CSAMinimumTransferAmountVariableSet
    - CSAThresholdVariableSet
    - CsaAdditionalTerminationEvent
    range: string
  url:
    name: url
    description: Indicates where the resource can be found, as a URL that references
      the information on a web server accessible to the message recipient.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: Resource
    domain_of:
    - Resource
    range: string
all_of:
- description: 'ResourceChoice: Choice rule to represent an FpML choice construct.
    Note that FpML also provides the ability to have hexadecimalBinary or base64Binary,
    which have not been implemented in Rosetta until we see actual use cases.'
  exactly_one_of:
  - slot_conditions:
      string:
        name: string
        value_presence: PRESENT
  - slot_conditions:
      url:
        name: url
        value_presence: PRESENT
  - all_of:
    - slot_conditions:
        string:
          name: string
          value_presence: ABSENT
    - slot_conditions:
        url:
          name: url
          value_presence: ABSENT