Class ActivityPriority


  • @StableMinor(version="14.2",
                 sinceVersion="8.2")
    public class ActivityPriority
    extends Object
    Value object used to specify the priority to be applied to a set of principals for an activity.

    The priority is specified as a decimal value greater than or equal to 0.00 and less than or equal to 1.00.

    The principals to which this priority may be applied are specified by adding ActivityPriority.IncludedEntry instances using addIncludedEntry(). The priority will only be applied to principals that meets all added ActivityPriority.IncludedEntry and that do not belong to the principals added in getExcludedPrincipalIds(). If no IncludedEntry is added, this priority object will be ignored.

    Since:
    8.2.0
    Version:
    $Revision: 24985 $ $Date: 2022-05-02 23:04:30 -0300 (Mon, 02 May 2022) $
    • Constructor Detail

      • ActivityPriority

        public ActivityPriority()
    • Method Detail

      • getPriority

        public double getPriority()
        Returns the priority value.
        Returns:
        the priority value.
        Since:
        8.2.0
      • setPriority

        public void setPriority​(double priority)
        Sets the priority value.
        Parameters:
        priority - the priority value. Must be greater than or equal to 0.00 and less than or equal to 1.00.
        Since:
        8.2.0
      • addIncludedEntry

        public ActivityPriority.IncludedEntry addIncludedEntry()
        Adds a new included entry in this priority, for specifying principals to which it may apply.
        Returns:
        the added included entry.
        Since:
        8.2.0
      • getExcludedPrincipalIds

        public Set<String> getExcludedPrincipalIds()
        Returns the set containing identifiers of principals excluded from being applied this priority. Modify the returned set to add or remove principals.
        Returns:
        set containing identifiers of principals.
        Since:
        8.2.0