Package de.aristaflow.adept2.core.globalprovider

Interface IconProvider

  • public interface IconProvider
    This interface provides icons (images in PNG-format) at runtime to the appropriate clients for displaying specific icons for process steps. Icons can be retrieved in different dimensions. Internally an appropriate image will be chosen and scaled appropriately.
    Author:
    Ulrich Kreher

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      byte[] getIcon​(SessionToken session, IconDescriptor iconDescriptor)
      Gets the the icon (in PNG-format) identified by the icon descriptor.
      byte[] getIcon​(SessionToken session, IconDescriptor iconDescriptor, int width, int height)
      Gets the the icon (in PNG-format) identified by the icon descriptor.
      byte[] getIcon​(SessionToken session, UUID iconID)
      Gets the (latest revision of the) designated icon (in PNG-format) or null in case no icon with the designated ID exists.
      byte[] getIcon​(SessionToken session, UUID iconID, int width, int height)
      Gets the (latest revision of the) designated icon (in PNG-format) with the designated dimensions or null in case no icon with the designated ID exists.
      IconDescriptor getIconDescriptor​(SessionToken session, UUID iconID)
      Gets the latest revision of the designated icon descriptor or null in case no icon descriptor with the designated ID exists.

    • Method Detail

      • getIconDescriptor

        IconDescriptor getIconDescriptor​(SessionToken session,
                                 UUID iconID)
        Gets the latest revision of the designated icon descriptor or null in case no icon descriptor with the designated ID exists.
        Parameters:
        session - The session which is used to check for access rights on this method.
        iconID - The ID of the icon descriptor of which to retrieve the latest revision.
        Returns:
        The latest revision of the icon descriptor having the designated ID or null in case the corresponding icon descriptor does not exist.

      • getIcon

        byte[] getIcon​(SessionToken session,
               UUID iconID)
        Gets the (latest revision of the) designated icon (in PNG-format) or null in case no icon with the designated ID exists. The returned icon will be the one with the biggest dimension available.
        Parameters:
        session - The session which is used to check for access rights on this method.
        iconID - The ID of the icon of which to retrieve the latest revision.
        Returns:
        The latest revision of the icon (in PNG-format) having the designated ID or null in case the corresponding icon does not exist.

      • getIcon

        byte[] getIcon​(SessionToken session,
               UUID iconID,
               int width,
               int height)
        Gets the (latest revision of the) designated icon (in PNG-format) with the designated dimensions or null in case no icon with the designated ID exists.
        The icon will be scaled appropriately based on the best matching dimension available.
        Parameters:
        session - The session which is used to check for access rights on this method.
        iconID - The ID of the icon of which to retrieve the latest revision with the designated dimensions.
        width - The width (in pixel) of the icon to retrieve.
        height - The height (in pixel) of the icon to retrieve.
        Returns:
        The latest revision of the icon (in PNG-format) with the designated dimensions having the designated ID or null in case the corresponding icon does not exist.

      • getIcon

        byte[] getIcon​(SessionToken session,
               IconDescriptor iconDescriptor)
        Gets the the icon (in PNG-format) identified by the icon descriptor. Note that this considers the revision of the designated icon (descriptor)! The returned icon will be the one with the biggest dimension available.
        Parameters:
        session - The session which is used to check for access rights on this method.
        iconDescriptor - The descriptor providing the icon ID as well as the revision for which to retrieve code.
        Returns:
        The icon (in PNG-format) belonging to the designated icon descriptor (icon ID and revision).
        Throws:
        IllegalArgumentException - If the designated icon descriptor is invalid, for instance it has an invalid icon ID or revision, an IllegalArgumentException will be thrown.

      • getIcon

        byte[] getIcon​(SessionToken session,
               IconDescriptor iconDescriptor,
               int width,
               int height)
        Gets the the icon (in PNG-format) identified by the icon descriptor. Note that this considers the revision of the designated icon (descriptor)!
        The icon will be scaled appropriately based on the best matching dimension available.
        Parameters:
        session - The session which is used to check for access rights on this method.
        iconDescriptor - The descriptor providing the icon ID as well as the revision for which to retrieve code.
        width - The width (in pixel) of the icon to retrieve.
        height - The height (in pixel) of the icon to retrieve.
        Returns:
        The icon (in PNG-format) belonging to the designated icon descriptor (icon ID and revision).
        Throws:
        IllegalArgumentException - If the designated icon descriptor is invalid, for instance it has an invalid icon ID or revision, an IllegalArgumentException will be thrown.