ActivityPriority

java.lang.Object
- lumis.portal.activitystream.ActivityPriority

```
@StableMinor(version="17.0",
             sinceVersion="8.2")
public class ActivityPriority
extends java.lang.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$ $Date$

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class ActivityPriority.IncludedEntry
An access control specifies which principals an ActivityPriority 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.
`java.util.Set<java.lang.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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 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 java.util.Set<java.lang.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