Presentable

To be able to render an individual content returned by the simple-search, list-contents & get-content-details services , the domain entity class used by these services must implement the com.hcl.unica.system.model.presentation.Presentable interface and override the getPresentationDetails() method. The com.hcl.unica.system.model.presentation.Presentable$PresentationDetails object returned by the getPresentationDetails() method must provide the TextualPresentation as well as MultimediaPresentation details.

TextualPresentation contains following particulars:

  • Note: The highlighted fields are mandatory. For the other fields, provide details, if available.
  • heading – Title of the content
  • subheadings – List of subheadings for the content
  • summary – Summary or description of the content
  • name – Should be used for filename associated with the content
  • tags – Tags associated with the content (out of the box plugins use this to convey MIME type or category of the content)

Whereas MultimediaPresentation contains following particulars:

  • Note: The highlighted fields are mandatory. For the other fields, provide details, if available.
  • id - Unique identifier of the content
  • folderId - Unique identifier of the folder respective content belongs to
  • mimeType - MIME type of the original content
  • size - Size of original content in bytes
  • resourceUrl - Absolute URL to the original content
  • thumbnailUrl - Absolute URL to the content thumbnail, if available
  • fileName - File name associated with the original content
  • type – Type/category identifier of the content (must be one of the values from supported content types set up using any of the applicable alternatives provided by Content Integration framework)
  • list of variants – Each variant supports almost same details as the primary MultimediaPresentation details except thumbnailUrl (it can only have its own resourceUrl), folderId and variants (variant cannot have any further variants)