Interface IBmRightsIndexProvider

All Known Implementing Classes:
BmRightsIndexProvider

public interface IBmRightsIndexProvider
Service that manages the rights index lifecycle.
See Also:
  • Method Details

    • clearIndexForRole

      void clearIndexForRole(long roleBmId)
      Clears index from obsolete data for the role.
      Parameters:
      roleBmId - the role BM Id to remove index for
    • clearIndexForObject

      void clearIndexForObject(long bmObjectId)
      Clears index from obsolete data for the object that supports rights.
      Parameters:
      bmObjectId - the object BM Id to remove index for
    • getRoleIndex

      IRightsDescription getRoleIndex(org.eclipse.emf.ecore.EObject role)
      Gets the rights index for the given role.
      Parameters:
      role - the given role, can not be null
      Returns:
      the role rights descriptor, may be null
    • getFullRightsIndex

      Iterable<IRightsDescription> getFullRightsIndex()
      Gets the full rights index for all roles.
      Returns:
      the iterable set of rights index items, can not be null
    • updateIndexForRole

      void updateIndexForRole(org.eclipse.emf.ecore.EObject role, IRightsDescription updatedRightsIndex)
      Updates rights index for the given role.
      Parameters:
      role - the given role, can not be null
      updatedRightsIndex - the updated rights index, can not be null
    • updateIndexForObject

      void updateIndexForObject(org.eclipse.emf.ecore.EObject object, org.eclipse.emf.ecore.EObject role, IRightsDescription updatedRightsIndex)
      Updates rights index for the given role and object that supports rights.
      Parameters:
      object - the given object, can not be null
      role - the given role, can not be null
      updatedRightsIndex - the updated rights index, can not be null
    • getRightsDescriptorForRole

      IRightsDescription getRightsDescriptorForRole(long bmRoleId)
      Gets the BM object-related rights descriptor for a role.
      Parameters:
      bmRoleId - the BM role Id to get rights descriptor for
      Returns:
      the rights descriptor, may be null