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

Interface ObjectCollection

All Known Subinterfaces:
PageableObjectCollection
All Known Implementing Classes:
ObjectCollectionImpl
public interface ObjectCollection
ObjectCollection is a wrapper class for elements of type CockpitObjectCollectionModel used by the cockpit.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    Gets the description of the collection.
    List<TypedObject>
    getElements()
    Gets the elements of the collection in the order they were added to the collection.
    String
    getLabel()
    Gets the label that is the string that is displayed as a collection name in the cockpit.
    String
    getLabel(String iso)
    Gets the label for the specified language code.
    PK
    getPK()
    Gets the pK.
    String
    getQualifier()
    Gets the qualifier of the collection.
    int
    getTotalCount()
    Gets the total count of the collection.
    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 Details

    • getLabel

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

    • getLabel

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

    • getDescription

      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

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

    • getQualifier

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

    • getPK

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

    • getType

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