com.sapportals.wcm.repository.service.subscription

Interface ISubscriptionCondition

public interface ISubscriptionCondition

Defines the conditions for which events lead to a notification.

Conditions covered by an ISubscriptionCondition are:
- event that is relevant for the subscription, for example, deletion
- follow links defines the handling of a subscribed link
- interval at which resources are checked for changes
- recursion level for a subscribed collection, this condition
specifies how many levels of hierarchy (recursion level) are relevant for the subscription
- rid tracking defines what the subscription is related to (RID or resource)

The conditions define which ISubscriptionConditionEvent for a IResource leads to a subscription notification.br> Such a condition can be thought of as the attribute for the subscription/resource relation of a subscription. The attribute of the subscription itself goes in ISubscriptionAttributes or ISubscription.

Copyright (c) SAP AG

See Also:

ISubscriptionConditionEvent, ISubscriptionConditionInterval, ISubscriptionConditionRecursionLevel, ISubscriptionAttributes, IResource, RID

Method Summary

ISubscriptionConditionEvent	getEvent() Gets the event type that causes the subscription notification to be sent.
int	getFollowLinks() Gets the follow links behavior of the subscription.
ISubscriptionConditionInterval	getInterval() Gets the notification interval that defines when notifications are sent.
ISubscriptionConditionRecursionLevel	getRecursionLevel() Gets the recursion level of the subscription.
int	getRidTracking() Gets the RID tracking behavior of the subscription.
void	setEvent(int eventid, IResource resource) Sets the event type that causes the subscription notification to be sent.
void	setEvent(ISubscriptionConditionEvent event) Sets the event type that causes the subscription notification to be sent.
void	setFollowLinks(int followLinks) Sets the follow links property of the subscription.
void	setInterval(ISubscriptionConditionInterval interval) Sets the notification interval that defines when notifications are sent.
void	setInterval(String intervalid) Sets the notification interval that defines when notifications are sent.
void	setRecursionLevel(ISubscriptionConditionRecursionLevel level) Sets the recursion level of the subscription.
void	setRecursionLevel(String levelid) Sets the recursion level of the subscription.
void	setRidTracking(int ridtracking) Sets the RID tracking property of the subscription.

Method Detail

getEvent

public ISubscriptionConditionEvent getEvent()

Gets the event type that causes the subscription notification to be sent.

Returns:

a ISubscriptionConditionEvent with the template of the subscribed event

setEvent

public void setEvent(int eventid,
                     IResource resource)
              throws WcmException

Sets the event type that causes the subscription notification to be sent.

Parameters:

resource - an IResource with a resource to define the event

Throws:

WcmException

See Also:

IEvent.isLike(com.sapportals.wcm.util.events.IEvent)

setEvent

public void setEvent(ISubscriptionConditionEvent event)

Sets the event type that causes the subscription notification to be sent.

Parameters:

event - a ISubscriptionConditionEvent with a template of the event to subscribe to

See Also:

IEvent.isLike(com.sapportals.wcm.util.events.IEvent)

getInterval

public ISubscriptionConditionInterval getInterval()

Gets the notification interval that defines when notifications are sent.

Defines whether a subscription acts on repository events or if the subscription polls its resources from time to time

Returns:

a ISubscriptionInterval with the interval at which notifications are sent (monthly, daily, and so on)

setInterval

public void setInterval(String intervalid)
                 throws WcmException

Sets the notification interval that defines when notifications are sent.

Defines whether a subscription acts on repository events or if the subscription polls its resources from time to time

Throws:

WcmException

setInterval

public void setInterval(ISubscriptionConditionInterval interval)

Sets the notification interval that defines when notifications are sent.

Defines whether a subscription acts on repository events or if the subscription polls its resources from time to time

Parameters:

interval - a ISubscriptionInterval with the interval at which notifications are sent (monthly, daily, and so on)

getRecursionLevel

public ISubscriptionConditionRecursionLevel getRecursionLevel()

Gets the recursion level of the subscription.

The recursion level defines the level in the hierarchy at which an event causes a notification.

Returns:

a ISubscriptionConditionRecursionLevel with the depth in the hierarchy at which events generate a notification

See Also:

ISubscriptionConditionRecursionLevel

setRecursionLevel

public void setRecursionLevel(String levelid)
                       throws WcmException

Sets the recursion level of the subscription.

The recursion level defines the level in the hierarchy at which an event causes notification

Throws:

WcmException

See Also:

ISubscriptionConditionRecursionLevel

setRecursionLevel

public void setRecursionLevel(ISubscriptionConditionRecursionLevel level)

Sets the recursion level of the subscription.

The recursion level defines the level in the hierarchy at which an event causes a notification.

Parameters:

level - a ISubscriptionConditionRecursionLevel with the depth in the hierarchy at which events generate a notification.

See Also:

ISubscriptionConditionRecursionLevel

setFollowLinks

public void setFollowLinks(int followLinks)

Sets the follow links property of the subscription.

The follow links property defines how subscriptions to links should be handled.
Links can be recursively resolved at creation of the subscription,
so that the subscription actually points to the target resource of the link (as it was at creation time).
The link itself can be subscribed to, or
the subscription can always point to the target of the link, even if the target changes.

Parameters:

followLinks - a int that defines how links are handled by subscriptions

getFollowLinks

public int getFollowLinks()

Gets the follow links behavior of the subscription.

Links can be recursively resolved at creation of the subscription,
so that the subscription actually points to the target resource of the link (as it was at creation time).
The link itself can be subscribed to, or
the subscription can always point to the target of the link, even if the target changes.

Returns:

a int that defines how links are handled by subscriptions

setRidTracking

public void setRidTracking(int ridtracking)

Sets the RID tracking property of the subscription.

The RID tracking property defines whether subscriptions are set on resources or on RIDs.
A subscription can point to an RID so that the resource behind it can change (e.g. move) and the subscription still points to the RID
(as the subscription is based on the RID).
A subscription can also point to a resource, in which case if the resource changes its RID (e.g. moves), the subscription on the resource remains
(as the subscription is based on the resource).

getRidTracking

public int getRidTracking()

Gets the RID tracking behavior of the subscription.

A subscription can point to an RID so that the resource behind it can change (e.g. move) and the subscription still points to the RID
(as the subscription is based on the RID).
A subscription can also point to a resource, in which case, if the resource changes its RID (e.g. moves) the subscription to the resource remains
(as the subscription is based on the resource).

Returns:

a int with the RID tracking behavior of the subscription