Package cdm.legaldocumentation.common

Interface Resource

All Superinterfaces:
com.rosetta.model.lib.RosettaModelObject
All Known Subinterfaces:
Resource.ResourceBuilder
All Known Implementing Classes:
Resource.ResourceBuilderImpl, Resource.ResourceImpl
@RosettaDataType(value="Resource", builder=ResourceBuilderImpl.class, version="5.30.0") @RuneDataType(value="Resource", model="cdm", builder=ResourceBuilderImpl.class, version="5.30.0") public interface 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:
5.30.0

  • Field Details

  • Method Details

    • getResourceId

      FieldWithMetaString getResourceId()
      The unique identifier of the resource within the event. FpML specifies this element of type resourceIdScheme but with no specified value.

    • getResourceType

      FieldWithMetaResourceTypeEnum getResourceType()
      A description of the type of the resource, e.g. a confirmation.

    • getLanguage

      FieldWithMetaString getLanguage()
      Indicates the language of the resource, described using the ISO 639-2/T Code.

    • getSizeInBytes

      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.

    • getLength

      ResourceLength getLength()
      Indicates the length of the resource. For example, if the resource were a PDF file, the length would be in pages.

    • getMimeType

      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

      String getName()
      The name of the resource. It is specified as a NormalizedString in FpML.

    • getComments

      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?

    • getString

      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

      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.

    • build

      Resource build()
      Build Methods
      Specified by:
      build in interface com.rosetta.model.lib.RosettaModelObject

    • toBuilder

      Resource.ResourceBuilder toBuilder()
      Specified by:
      toBuilder in interface com.rosetta.model.lib.RosettaModelObject

    • builder

      static Resource.ResourceBuilder builder()

    • metaData

      default com.rosetta.model.lib.meta.RosettaMetaData<? extends Resource> metaData()
      Utility Methods
      Specified by:
      metaData in interface com.rosetta.model.lib.RosettaModelObject

    • getType

      @RuneAttribute("@type") default Class<? extends Resource> getType()
      Specified by:
      getType in interface com.rosetta.model.lib.RosettaModelObject

    • process

      default void process(com.rosetta.model.lib.path.RosettaPath path, com.rosetta.model.lib.process.Processor processor)
      Specified by:
      process in interface com.rosetta.model.lib.RosettaModelObject