Interface IRightsDescription

All Known Implementing Classes:
BaseRightsDescription, InvertedRightsDescription, RightsDescription, SingleObjectRightsDescription

public interface IRightsDescription
An abstract description of rights for a role.
  • Method Summary

    Modifier and Type
    Method
    Description
    int
    Returns the number of custom rights among child objects of the specified top object for which the default right value is determined by "Set rights for attributes and tabular sections by default" flag.
    int
    Returns the number of custom rights among child objects (include the specified top object) of the specified top object for which the default right value is determined by "Set rights for new objects" flag.
    int
    getNumberOfSetRights(long topObjectId)
    Returns the number of set rights among child objects of the specified top object for which the default right value is not determined by "Set rights for new objects" flag or "Set rights for attributes and tabular sections by default" flag.
    Gets the set of object ids the rights specified for.
    getRights(long objectId)
    Gets the rights of the object.
    Gets top objects ids with own non default rights or having descendants with non default rights.
    boolean
    hasTopObjectsRls(long topObjectId)
    Determines whether the object with the given id has at least one Rls.
    boolean
    Gets the value of the 'independentRightsOfChildObjects' flag.
    boolean
    Gets the value of the 'setForAttributesByDefault' flag.
    boolean
    Gets the value of the 'setForNewObjects' flag.
  • Method Details

    • getRights

      Map<String,Boolean> getRights(long objectId)
      Gets the rights of the object.
      Parameters:
      objectId - the unique identifier of the object rights get for
      Returns:
      the object rights, may be null
    • getObjectIds

      Set<Long> getObjectIds()
      Gets the set of object ids the rights specified for.
      Returns:
      the set of object ids, can not be null
    • getTopObjectsWithNonDefaultRights

      Set<Long> getTopObjectsWithNonDefaultRights()
      Gets top objects ids with own non default rights or having descendants with non default rights.
      Returns:
      the set of top object ids with non default rights, can not be null
    • getNumberOfCustomRightsSetForNewObjects

      int getNumberOfCustomRightsSetForNewObjects(long topObjectId)
      Returns the number of custom rights among child objects (include the specified top object) of the specified top object for which the default right value is determined by "Set rights for new objects" flag.
      Parameters:
      topObjectId - the top object id to get the number of custom rights among child objects
      Returns:
      the number of custom rights among child objects for which the default right value is determined by "Set rights for new objects" flag
    • getNumberOfCustomRightsSetForAttributesByDefault

      int getNumberOfCustomRightsSetForAttributesByDefault(long topObjectId)
      Returns the number of custom rights among child objects of the specified top object for which the default right value is determined by "Set rights for attributes and tabular sections by default" flag.
      Parameters:
      topObjectId - the top object id to get the number of custom rights among child objects
      Returns:
      the number of custom rights among child objects for which the default right value is determined by "Set rights for attributes and tabular sections by default" flag
    • getNumberOfSetRights

      int getNumberOfSetRights(long topObjectId)
      Returns the number of set rights among child objects of the specified top object for which the default right value is not determined by "Set rights for new objects" flag or "Set rights for attributes and tabular sections by default" flag.
      Parameters:
      topObjectId - the top object id to get the number of set rights among child objects
      Returns:
      the number of set rights among child objects of the specified top object for which the default right value is not determined by "Set rights for new objects" flag or "Set rights for attributes and tabular sections by default" flag
    • hasTopObjectsRls

      boolean hasTopObjectsRls(long topObjectId)
      Determines whether the object with the given id has at least one Rls.
      Parameters:
      topObjectId - the unique identifier of the object the 'Has Rls' condition is checked for
      Returns:
      true if the object has at least one Rls and false otherwise
    • isSetForNewObjects

      boolean isSetForNewObjects()
      Gets the value of the 'setForNewObjects' flag.
      Returns:
      true if the 'setForNewObjects' flag is set and false otherwise
    • isSetForAttributesByDefault

      boolean isSetForAttributesByDefault()
      Gets the value of the 'setForAttributesByDefault' flag.
      Returns:
      true if the 'setForAttributesByDefault' flag is set and false otherwise
    • isIndependentRightsOfChildObjects

      boolean isIndependentRightsOfChildObjects()
      Gets the value of the 'independentRightsOfChildObjects' flag.
      Returns:
      true if the 'independentRightsOfChildObjects' flag is set and false otherwise