Package com.adobe.cq.inbox.api.preferences.domain.view

Interface ViewPreferences

  • @ProviderType
public interface ViewPreferences
    Interface for the AEM Inbox View Preferences

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getSortByProperty()
      Returns the property by which AEM inbox items are sorted or null if property is not present
      String getSortOrder()
      Returns the sort order of AEM inbox items (Ascending/Descending) or null if property is not present
      void setSortByProperty​(String sortByProperty)
      Set the property by which AEM inbox items are sorted or null to clear current property
      void setSortOrder​(String sortOrder)
      Set the sort order of AEM inbox items (Ascending/Descending) or null to clear current property

    • Method Detail

      • getSortByProperty

        @Nullable
String getSortByProperty()
        Returns the property by which AEM inbox items are sorted or null if property is not present
        Returns:
        The property by which AEM inbox items are sorted

      • setSortByProperty

        void setSortByProperty​(@Nullable
                       String sortByProperty)
        Set the property by which AEM inbox items are sorted or null to clear current property
        Parameters:
        sortByProperty - The property by which AEM inbox items are sorted

      • getSortOrder

        @Nullable
String getSortOrder()
        Returns the sort order of AEM inbox items (Ascending/Descending) or null if property is not present
        Returns:
        The sort order of AEM inbox items

      • setSortOrder

        void setSortOrder​(@Nullable
                  String sortOrder)
        Set the sort order of AEM inbox items (Ascending/Descending) or null to clear current property
        Parameters:
        sortOrder - The sort order of AEM inbox items