Package lumis.portal.activitystream

Interface ActivityDocument.IActivityDocumentPriority

Enclosing class:

ActivityDocument

@StableMinor(version="17.0",
             sinceVersion="8.2")
public static interface ActivityDocument.IActivityDocumentPriority

Contains information about a priority to be applied to different principals, stored in a ActivityDocument .

Since:

8.2.0

Version:

$Revision$ $Date$

See Also:

ActivityPriority

Method Summary

Modifier and Type	Method	Description
void	addExcludedPrincipalIds(java.lang.String... principalIds)	Adds principals this priority must not be applied to.
void	addExcludedPrincipalIds(java.util.Collection<java.lang.String> principalIds)	Adds principals this priority must not be applied to.
ActivityDocument.IActivityDocumentPriorityIncludedEntry	addIncludedEntry()	Adds an entry for specifying the principals this priority applies to.
java.util.Collection<java.lang.String>	getExcludedPrincipalIds()	Returns the identifiers of principals this priority must not be applied to.
java.util.Collection<ActivityDocument.IActivityDocumentPriorityIncludedEntry>	getIncludedEntries()	Returns the entries specifying the principals this priority applies to.
double	getPriority()	The priority value.
void	setPriority(double priority)	Sets the priority value.

Method Detail

getPriority

double getPriority()

The priority value.

Returns:

the priority value.

Since:

8.2.0

setPriority

void setPriority(double priority)

Sets the priority value.

Parameters:

priority - the priority value.

Since:

8.2.0

getExcludedPrincipalIds

java.util.Collection<java.lang.String> getExcludedPrincipalIds()

Returns the identifiers of principals this priority must not be applied to.

Returns:

the identifiers of principals this priority must not be applied to.

Since:

8.2.0

See Also:

ActivityPriority.getExcludedPrincipalIds()

addExcludedPrincipalIds

void addExcludedPrincipalIds(java.lang.String... principalIds)

Adds principals this priority must not be applied to.

Parameters:

principalIds - identifiers of the principals.

Since:

8.2.0

See Also:

ActivityPriority.getExcludedPrincipalIds()

addExcludedPrincipalIds

void addExcludedPrincipalIds(java.util.Collection<java.lang.String> principalIds)

Adds principals this priority must not be applied to.

Parameters:

principalIds - identifiers of the principals.

Since:

8.2.0

See Also:

ActivityPriority.getExcludedPrincipalIds()

getIncludedEntries

java.util.Collection<ActivityDocument.IActivityDocumentPriorityIncludedEntry> getIncludedEntries()

Returns the entries specifying the principals this priority applies to.

Returns:

the included entries for this priority.

Since:

8.2.0

addIncludedEntry

ActivityDocument.IActivityDocumentPriorityIncludedEntry addIncludedEntry()

Adds an entry for specifying the principals this priority applies to.

Returns:

the added included entry.

Since:

8.2.0