Package com.day.cq.preferences

Interface PreferencesService

public interface PreferencesService
Deprecated.
cq 5.5
Allows access and removal of user specific settings.
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    Preferences
    get()
    Deprecated.
    Access the Preferences of the User which session is given as argument
    Preferences
    get(String authorizableId)
    Deprecated.
    Acquire the Preferences fo a given authorizable.
    If access rights are sufficient, implementations have to return a Preferences object.
    boolean
    remove()
    Deprecated.
    Remove all Preferences for the User of the given session.
    boolean
    remove(String authorizableId)
    Deprecated.
    Remove all Preferences of the Authorizable the given ID identifies.

  • Method Details

    • get

      Preferences get()
      Deprecated.
      Access the Preferences of the User which session is given as argument
      Returns:
      Preferences of User

    • get

      Preferences get(String authorizableId) throws NoSuchAuthorizableException
      Deprecated.
      Acquire the Preferences fo a given authorizable.
      If access rights are sufficient, implementations have to return a Preferences object.
      Parameters:
      authorizableId - the Id of the Authorizable to access the Preferences for
      Returns:
      Preferences
      Throws:
      NoSuchAuthorizableException - if there is no Authorizable with the given ID;

    • remove

      boolean remove()
      Deprecated.
      Remove all Preferences for the User of the given session.
      Returns:
      if the Preferences existed and have been removed

    • remove

      boolean remove(String authorizableId) throws NoSuchAuthorizableException
      Deprecated.
      Remove all Preferences of the Authorizable the given ID identifies. Take the Privileges of the session given for this operation
      Parameters:
      authorizableId - to remove the Preferences for
      Returns:
      true if the Preferences existed and have been removed
      Throws:
      NoSuchAuthorizableException - if the given ID does not point to an existing Authorizable