com.sapportals.wcm.repository.service.subscription

Interface ISubscriptionConditionRecursionLevel

All Superinterfaces:

Comparable

public interface ISubscriptionConditionRecursionLevel
extends Comparable

A Recursion level defines which hierarchy level is relevant for a subscription on a collection.
An ISubscriptionConditionRecursionLevel is attached to an ISubscriptionCondition.

Parameters attached to an ISubscriptionConditionRecursionLevel:
- description with detailed information about the recursion level
- depth of the hierarchy level that is relevant for a subscription to a collection
- system ID associated with this recursion level

A recursion level defines the depth of a search for valid resources of a subscription.
Example: Let document d and folder f be in a common folder c, and let x be a document in folder f.

Let there also be a subscription for c and consider an event sent for c/f/x. Now if the subscription condition has a recursion level lower than "2" (which means that c on level 0 or c/d and c/f on level "1" are checked), no notification is generated. If the recursion level is greater than or equal to "2" (which means that c/f/x is checked), a notification is generated.

Copyright (c) SAP AG

See Also:

ISubscriptionCondition, ISubscription

Method Summary

Modifier and Type	Method and Description
int	getDepth() Gets an int equivalent for this recursion level.
String	getDescription() Gets a display name for the condition's recursion level.
String	getDescription(Locale locale) Gets a display name for the condition's recursion level.
String	getID() Gets the unique ID of this ISubscriptionConditionRecursionLevel.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getID

String getID()

Gets the unique ID of this ISubscriptionConditionRecursionLevel.

Returns:

a String with the recursion level

getDescription

String getDescription()

Gets a display name for the condition's recursion level.

Returns:

a String with the recursion level's name

getDescription

String getDescription(Locale locale)

Gets a display name for the condition's recursion level.

Parameters:

locale - a Locale to get the name for

Returns:

a String with the recursion level's name

getDepth

int getDepth()

Gets an int equivalent for this recursion level.

Returns:

an int with the hierarchy depth for this level