Package de.hybris.platform.cockpit.model.collection

Interface ObjectCollection

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getDescription()
      Gets the description of the collection.
      java.util.List<TypedObject> getElements()
      Gets the elements of the collection in the order they were added to the collection.
      java.lang.String getLabel()
      Gets the label that is the string that is displayed as a collection name in the cockpit.
      java.lang.String getLabel​(java.lang.String iso)
      Gets the label for the specified language code.
      PK getPK()
      Gets the pK.
      java.lang.String getQualifier()
      Gets the qualifier of the collection.
      int getTotalCount()
      Gets the total count of the collection.
      java.lang.String getType()
      Gets the type of the collection which is a descriptive string (quickcollection, blacklist, clipboard).
      UserModel getUser()
      Gets the user that created this collection.

    • Method Detail

      • getLabel

        java.lang.String getLabel()
        Gets the label that is the string that is displayed as a collection name in the cockpit.
        Returns:
        the label

      • getLabel

        java.lang.String getLabel​(java.lang.String iso)
        Gets the label for the specified language code.
        Parameters:
        iso - the iso
        Returns:
        the label

      • getDescription

        java.lang.String getDescription()
        Gets the description of the collection. Is not displayed anywhere for this moment.
        Returns:
        the description

      • getTotalCount

        int getTotalCount()
        Gets the total count of the collection. It is displayed in the parentheses after the collection label in the cockpit.
        Returns:
        the total count

      • getUser

        UserModel getUser()
        Gets the user that created this collection.
        Returns:
        the user

      • getElements

        java.util.List<TypedObject> getElements()
        Gets the elements of the collection in the order they were added to the collection.
        Returns:
        the elements

      • getQualifier

        java.lang.String getQualifier()
        Gets the qualifier of the collection.
        Returns:
        the qualifier

      • getPK

        PK getPK()
        Gets the pK.
        Returns:
        the pK

      • getType

        java.lang.String getType()
        Gets the type of the collection which is a descriptive string (quickcollection, blacklist, clipboard).
        Returns:
        the type