Package com.aquima.interactions.framework.container.link

Interface ILinkParameters

All Superinterfaces:
Serializable
All Known Implementing Classes:
DocumentLinkParameters, LinkParameters
public interface ILinkParameters extends Serializable
Interface containing the parameters needed for a link container implementation.
Since:
6.5
Author:
O. Kerpershoek

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAssetFormat()
    This method returns the format of the asset that should be used for the display text.
    String
    getAssetName()
    This method returns the name of the asset that should be used for the display text.
    IParameters
    getCustomParameters()
    This method returns an object containing additional parameters that should be included in the link.
    String
    getTypeName()
    This method returns the type of the link (for instance "document").

  • Method Details

    • getTypeName

      String getTypeName()
      This method returns the type of the link (for instance "document").
      Returns:
      the type of the link (for instance "document").

    • getCustomParameters

      IParameters getCustomParameters()
      This method returns an object containing additional parameters that should be included in the link.
      Returns:
      an object containing additional parameters that should be included in the link.

    • getAssetFormat

      String getAssetFormat()
      This method returns the format of the asset that should be used for the display text.
      Returns:
      the format of the asset that should be used for the display text.

    • getAssetName

      String getAssetName()
      This method returns the name of the asset that should be used for the display text.
      Returns:
      the name of the asset that should be used for the display text.