com.ibm.jarm.api.meta

Interface RMMarkingItem

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.lang.Integer getConstraintMask()
      Returns a bit mask defining the access permission associated with a given marking.
      java.lang.String getId()
      Returns the repository unique identifier for this marking item.
      java.lang.Integer getMarkingUseGranted()
      Returns a bit mask that identifies which access rights have been granted to the current user with respect to this marking.
      java.lang.String getMarkingValue()
      Specifies the value to use when applying a marking to an object that has a property associated with the corresponding RMMarkingSet.
    • Method Detail

      • getConstraintMask

        java.lang.Integer getConstraintMask()
        Returns a bit mask defining the access permission associated with a given marking.

        If a given user does not have the appropriate rights to perform marking-related operations on the object, the access rights specified in the marking's constraint mask are removed from the user's access rights to the object.

        Returns:
        An Integer.
      • getId

        java.lang.String getId()
        Returns the repository unique identifier for this marking item.
        Returns:
        A String value.
      • getMarkingUseGranted

        java.lang.Integer getMarkingUseGranted()
        Returns a bit mask that identifies which access rights have been granted to the current user with respect to this marking. A user can be granted "Use", "Remove" and "Add" rights. The "Remove" and "Add" rights determine if the current user can remove or add a marking value on an object.

        The primary use of this bit mask is to detect whether the current user has the "Use" right. The "Use" right determines whether the presence of the marking on an object constrains access to that object. If the user has the "Use" right to the marking, access to an associated object is not constrained by the value of the marking's constraint mask. The absence of the "Use" right means that the values in the constraint mask is subtracted from the object's effective access calculation.

        Returns:
        An Integer.
      • getMarkingValue

        java.lang.String getMarkingValue()
        Specifies the value to use when applying a marking to an object that has a property associated with the corresponding RMMarkingSet. In other words, a marking is applied to an object by setting the associated property value to this marking value.
        Returns:
        A String value.

© Copyright IBM Corp. 2010, 2013. All Rights Reserved.