Package lumis.portal.activitystream
Class ActivityPriority
- java.lang.Object
-
- lumis.portal.activitystream.ActivityPriority
-
@StableMinor(version="14.0", 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 usingaddIncludedEntry()
. The priority will only be applied to principals that meets all addedActivityPriority.IncludedEntry
and that do not belong to the principals added ingetExcludedPrincipalIds()
. If noIncludedEntry
is added, this priority object will be ignored.- Since:
- 8.2.0
- Version:
- $Revision: 24477 $ $Date: 2021-04-28 11:30:36 -0300 (Wed, 28 Apr 2021) $
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ActivityPriority.IncludedEntry
An access control specifies which principals anActivityPriority
applies to.
-
Constructor Summary
Constructors Constructor Description ActivityPriority()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ActivityPriority.IncludedEntry
addIncludedEntry()
Adds a new included entry in this priority, for specifying principals to which it may apply.Set<String>
getExcludedPrincipalIds()
Returns the set containing identifiers of principals excluded from being applied this priority.double
getPriority()
Returns the priority value.void
setPriority(double priority)
Sets the priority value.
-
-
-
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
-
-