Package com.day.cq.personalization.ui.groupedservicesselector

Interface GroupedServicesSelector

  • @ProviderType
public interface GroupedServicesSelector
    Represents an interface for the GroupedServicesSelector component providing methods used by the UI.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.List<java.util.Map<java.lang.String,​java.lang.Object>> getAllGroups()
      Returns all available groups.
      java.util.List<java.util.Map<java.lang.String,​java.lang.Object>> getGroupsForResource()
      Returns the groups/services which are stored in a property of the content node of the current Page resource.
      java.lang.String getInheritedPath()
      Returns the path of the resource of type cq:Page from where the services are inherited or null if values are not inherited.
      boolean isInherited()
      Checks if the services are inherited.
      boolean isWriteAllowed()
      Checks if the user bound to the current request is allowed to write the property this widget is storing its state to.

    • Method Detail

      • getAllGroups

        java.util.List<java.util.Map<java.lang.String,​java.lang.Object>> getAllGroups()
        Returns all available groups. The list of groups contains maps with the following keys. 
          
 {
   title: 'My Group',
   description: 'Sample group',
   path: '/path/to/group',
   services: [{
     title: 'My service',
     description: 'Sample service',
     path: '/path/to/service'
   }]
 }
        Returns:
        List of all available groups.

      • getGroupsForResource

        java.util.List<java.util.Map<java.lang.String,​java.lang.Object>> getGroupsForResource()
        Returns the groups/services which are stored in a property of the content node of the current Page resource. The list of groups contains maps with the following keys. 
          
 {
   title: 'My Group',
   description: 'Sample group',
   path: '/path/to/group',
   inherited: false,
   services: [{
     title: 'My service',
     description: 'Sample service',
     path: '/path/to/service',
     selected: false
   }]
 }
        Returns:
        List of groups for current page.

      • isInherited

        boolean isInherited()
        Checks if the services are inherited.
        Returns:
        true if services are inherited, false otherwise.

      • getInheritedPath

        java.lang.String getInheritedPath()
        Returns the path of the resource of type cq:Page from where the services are inherited or null if values are not inherited.
        Returns:
        Path of the inheritance source or null

      • isWriteAllowed

        boolean isWriteAllowed()
        Checks if the user bound to the current request is allowed to write the property this widget is storing its state to. If the user is allowed to write, true will be returned otherwise false.
        Returns:
        true if user is allowed to write, false otherwise.