Package de.hybris.platform.cockpit.services.security

Interface UIAccessRightService

All Known Implementing Classes:
BundleUIAccessRightService, CMSCockpitUIAccessRightService, DefaultUIAccessRightService
public interface UIAccessRightService
A UIAccessRightService provides a set of methods for dealing with users' read and write access throughout a Cockpit application.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canRead(UserModel user, String componentCode)
    Returns whether a specific user has read access to a specific Cockpit component or not.
    boolean
    canWrite(UserModel user, CatalogVersionModel catVersion)
    Returns whether a specific user has write access to a specific catalog version or not.
    boolean
    canWrite(UserModel user, String componentCode)
    Returns whether a specific user has write access to a specific Cockpit component or not.
    boolean
    isReadable(ObjectType type)
    Returns whether the current user has read access to the specified type.
    boolean
    isReadable(ObjectType type, PropertyDescriptor propDescr, boolean creationMode)
    Returns whether the current user has read access to the specified property.
    boolean
    isWritable(ObjectType type)
    Returns whether the current user has write access to the specified type.
    boolean
    isWritable(ObjectType type, PropertyDescriptor propDescr, boolean creationMode)
    Returns whether the current user has write access to the specified item property.
    boolean
    isWritable(ObjectType type, TypedObject item)
    Returns whether the current user has write access to the specified item.
    boolean
    isWritable(ObjectType type, TypedObject item, PropertyDescriptor propDescr, boolean creationMode)
    Returns whether the current user has write access to the specified item property.

  • Method Details

    • canRead

      boolean canRead(UserModel user, String componentCode)
      Returns whether a specific user has read access to a specific Cockpit component or not.
      Parameters:
      user - the user to check access for
      componentCode - the unique code of the component
      Returns:
      true if the user has read access to the specified component, otherwise false

    • canWrite

      boolean canWrite(UserModel user, String componentCode)
      Returns whether a specific user has write access to a specific Cockpit component or not.
      Parameters:
      user - the user to check access for
      componentCode - the unique code of the component
      Returns:
      true if the user has write access to the specified component, otherwise false

    • canWrite

      boolean canWrite(UserModel user, CatalogVersionModel catVersion)
      Returns whether a specific user has write access to a specific catalog version or not.
      Parameters:
      user - the user to check access for
      catVersion - the catalog version
      Returns:
      true if the user has write access, false otherwise

    • isReadable

      boolean isReadable(ObjectType type)
      Returns whether the current user has read access to the specified type.
      Parameters:
      type - the type to check access for
      Returns:
      true if user has read access, false otherwise

    • isReadable

      boolean isReadable(ObjectType type, PropertyDescriptor propDescr, boolean creationMode)
      Returns whether the current user has read access to the specified property.
      Parameters:
      type - item type
      propDescr - item attribute to check access for
      creationMode - creation mode or not
      Returns:
      true if user has read access, false otherwise

    • isWritable

      boolean isWritable(ObjectType type)
      Returns whether the current user has write access to the specified type.
      Parameters:
      type - the type to check access for
      Returns:
      true if user has write access, false otherwise

    • isWritable

      boolean isWritable(ObjectType type, TypedObject item)
      Returns whether the current user has write access to the specified item.
      Parameters:
      type - item type
      item - the item instance to check access for
      Returns:
      true if user has write access, false otherwise

    • isWritable

      boolean isWritable(ObjectType type, PropertyDescriptor propDescr, boolean creationMode)
      Returns whether the current user has write access to the specified item property.
      Parameters:
      type - item type
      propDescr - item attribute to check access for
      creationMode - creation mode or not
      Returns:
      true if user has write access, false otherwise

    • isWritable

      boolean isWritable(ObjectType type, TypedObject item, PropertyDescriptor propDescr, boolean creationMode)
      Returns whether the current user has write access to the specified item property.
      Parameters:
      type - item type
      item - item instance
      propDescr - item attribute to check access for
      creationMode - creation mode or not
      Returns:
      true if user has write access, false otherwise