Package org.isda.cdm

Class Resource


  • @RosettaClass
    @RosettaSynonym(value="Resource",
                    source="FpML_5_10")
    public class Resource
    extends com.rosetta.model.lib.RosettaModelObject
    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.
    Version:
    2.5.4
    • Method Detail

      • getComments

        @RosettaSynonym(value="comments",source="FpML_5_10") @RosettaSynonym(value="comments",source="CME_SubmissionIRS_1_0") @RosettaSynonym(value="comments",source="DTCC_11_0") @RosettaSynonym(value="comments",source="DTCC_9_0") @RosettaSynonym(value="comments",source="CME_ClearedConfirm_1_17")
        public final java.lang.String getComments()
        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?
      • getLanguage

        @RosettaSynonym(value="language",source="FpML_5_10") @RosettaSynonym(value="language",source="CME_SubmissionIRS_1_0") @RosettaSynonym(value="language",source="DTCC_11_0") @RosettaSynonym(value="language",source="DTCC_9_0") @RosettaSynonym(value="language",source="CME_ClearedConfirm_1_17")
        public final FieldWithMetaString getLanguage()
        Indicates the language of the resource, described using the ISO 639-2/T Code.
      • getLength

        @RosettaSynonym(value="length",source="FpML_5_10") @RosettaSynonym(value="length",source="CME_SubmissionIRS_1_0") @RosettaSynonym(value="length",source="DTCC_11_0") @RosettaSynonym(value="length",source="DTCC_9_0") @RosettaSynonym(value="length",source="CME_ClearedConfirm_1_17")
        public final ResourceLength getLength()
        Indicates the length of the resource. For example, if the resource were a PDF file, the length would be in pages.
      • getMimeType

        @RosettaSynonym(value="mimeType",source="FpML_5_10") @RosettaSynonym(value="mimeType",source="CME_SubmissionIRS_1_0") @RosettaSynonym(value="mimeType",source="DTCC_11_0") @RosettaSynonym(value="mimeType",source="DTCC_9_0") @RosettaSynonym(value="mimeType",source="CME_ClearedConfirm_1_17")
        public final FieldWithMetaString getMimeType()
        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.
      • getName

        @RosettaSynonym(value="name",source="FpML_5_10") @RosettaSynonym(value="name",source="CME_SubmissionIRS_1_0") @RosettaSynonym(value="name",source="DTCC_11_0") @RosettaSynonym(value="name",source="DTCC_9_0") @RosettaSynonym(value="name",source="CME_ClearedConfirm_1_17")
        public final java.lang.String getName()
        The name of the resource. It is specified as a NormalizedString in FpML.
      • getResourceId

        @RosettaSynonym(value="resourceId",source="FpML_5_10") @RosettaSynonym(value="resourceId",source="CME_SubmissionIRS_1_0") @RosettaSynonym(value="resourceId",source="DTCC_11_0") @RosettaSynonym(value="resourceId",source="DTCC_9_0") @RosettaSynonym(value="resourceId",source="CME_ClearedConfirm_1_17")
        public final FieldWithMetaString getResourceId()
        The unique identifier of the resource within the event. FpML specifies this element of type resourceIdScheme but with no specified value.
      • getResourceType

        @RosettaSynonym(value="resourceType",source="FpML_5_10") @RosettaSynonym(value="resourceType",source="CME_SubmissionIRS_1_0") @RosettaSynonym(value="resourceType",source="DTCC_11_0") @RosettaSynonym(value="resourceType",source="DTCC_9_0") @RosettaSynonym(value="resourceType",source="CME_ClearedConfirm_1_17")
        public final FieldWithMetaResourceTypeEnum getResourceType()
        A description of the type of the resource, e.g. a confirmation.
      • getSizeInBytes

        @RosettaSynonym(value="sizeInBytes",source="FpML_5_10") @RosettaSynonym(value="sizeInBytes",source="CME_SubmissionIRS_1_0") @RosettaSynonym(value="sizeInBytes",source="DTCC_11_0") @RosettaSynonym(value="sizeInBytes",source="DTCC_9_0") @RosettaSynonym(value="sizeInBytes",source="CME_ClearedConfirm_1_17")
        public final java.math.BigDecimal getSizeInBytes()
        Indicates the size of the resource in bytes. It could be used by the end user to estimate the download time and storage needs.
      • getString

        @RosettaSynonym(value="string",source="FpML_5_10") @RosettaSynonym(value="string",source="CME_SubmissionIRS_1_0") @RosettaSynonym(value="string",source="DTCC_11_0") @RosettaSynonym(value="string",source="DTCC_9_0") @RosettaSynonym(value="string",source="CME_ClearedConfirm_1_17")
        public final java.lang.String getString()
        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.
      • getUrl

        @RosettaSynonym(value="url",source="FpML_5_10") @RosettaSynonym(value="url",source="CME_SubmissionIRS_1_0") @RosettaSynonym(value="url",source="DTCC_11_0") @RosettaSynonym(value="url",source="DTCC_9_0") @RosettaSynonym(value="url",source="CME_ClearedConfirm_1_17")
        public final java.lang.String getUrl()
        Indicates where the resource can be found, as a URL that references the information on a web server accessible to the message recipient.
      • metaData

        public com.rosetta.model.lib.meta.RosettaMetaData<? extends Resource> metaData()
        Specified by:
        metaData in class com.rosetta.model.lib.RosettaModelObject
      • toBuilder

        public Resource.ResourceBuilder toBuilder()
        Specified by:
        toBuilder in class com.rosetta.model.lib.RosettaModelObject
      • process

        public void process​(com.rosetta.model.lib.path.RosettaPath path,
                            com.rosetta.model.lib.process.Processor processor)
        Specified by:
        process in class com.rosetta.model.lib.RosettaModelObject
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object