Package org.ametys.plugins.pagesubscription

Class Subscription

java.lang.Object

org.ametys.plugins.repository.AbstractAmetysObject

org.ametys.plugins.repository.jcr.SimpleAmetysObject<SubscriptionFactory>

org.ametys.plugins.pagesubscription.Subscription

All Implemented Interfaces:

AmetysObject, DataHolder, ModifiableDataHolder, JCRAmetysObject, MetadataAwareAmetysObject, ModifiableMetadataAwareAmetysObject, ModifiableAmetysObject, RemovableAmetysObject

public class Subscription
extends SimpleAmetysObject<SubscriptionFactory>

Object representing an subscription

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACTIVITY_ID_KEY	key used to store the activity id when serialized
static final String	ACTIVITY_NAME_KEY	key used to store the activity name when serialized

Constructor Summary

Constructors

Constructor	Description
Subscription(javax.jcr.Node node, String parentPath, SubscriptionFactory factory)	Creates an Subscription.

Method Summary

Modifier and Type	Method	Description
List<BroadcastChannelHelper.BroadcastChannel>	getBroadcastChannels()	Get the list of broadcast channel of the subscription
ZonedDateTime	getDate()	Get the date of the subscription.
SubscriptionType.FrequencyTiming	getForceFrequencyTiming()	Get the frequency timing hour if the subscription is forced.
FrequencyHelper.Frequency	getFrequency()	Get the frequency of the subscription
Site	getSite()	Get the site of the subscription
Optional<UserIdentity>	getSubscriber()	Get the subscriber of the subscription
Optional<GroupIdentity>	getSubscribersGroup()	Get the subscribers group of the subscription
SubscriptionType	getSubscriptionType()	Get the type of the subscription
boolean	isForced()	true if the subscription is forced

Methods inherited from class org.ametys.plugins.repository.jcr.SimpleAmetysObject

_getFactory, _invalidateName, _invalidateParentPath, getComposite, getComposite, getDataHolder, getId, getMetadataHolder, getName, getNode, getParent, getParentDataHolder, getParentPath, getPath, getRepositoryData, getRootDataHolder, needsSave, remove, removeValue, rename, revertChanges, saveChanges, setValue, setValue, synchronizeValues

Methods inherited from class org.ametys.plugins.repository.AbstractAmetysObject

dataToJSON, dataToJSON, dataToSAX, dataToSAX, equals, getDataNames, getModelItemTypeExtensionPoint, getType, getValue, getValueOfType, getValueOfTypeOrDefault, getValueOrDefault, hasDifferences, hashCode, hasValue, hasValue, hasValueOrEmpty, isMultiple, isMultiple, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.ametys.plugins.repository.AmetysObject

equals, hashCode

Methods inherited from interface org.ametys.plugins.repository.data.holder.DataHolder

copyTo, copyTo, dataToJSON, dataToJSON, dataToJSON, dataToJSON, dataToSAX, dataToSAX, dataToSAX, dataToSAX, getDataNames, getModelItemTypeExtensionPoint, getType, getValue, getValueOfType, getValueOfTypeOrDefault, getValueOrDefault, hasDifferences, hasValue, hasValue, hasValueOrEmpty, isMultiple, isMultiple

Field Details

ACTIVITY_ID_KEY

public static final String ACTIVITY_ID_KEY

key used to store the activity id when serialized

See Also:

• Constant Field Values

ACTIVITY_NAME_KEY

public static final String ACTIVITY_NAME_KEY

key used to store the activity name when serialized

See Also:

• Constant Field Values

Constructor Details

Subscription

public Subscription(javax.jcr.Node node,
 String parentPath,
 SubscriptionFactory factory)

Creates an Subscription.

Parameters:

node - the node backing this Subscription

parentPath - the parentPath in the Ametys hierarchy

factory - the factory which created the activity

Method Details

getSubscriptionType

public SubscriptionType getSubscriptionType()

Get the type of the subscription

Returns:

the subscription type

getSubscriber

public Optional<UserIdentity> getSubscriber()

Get the subscriber of the subscription

Returns:

the subscriber subscription

getSubscribersGroup

public Optional<GroupIdentity> getSubscribersGroup()

Get the subscribers group of the subscription

Returns:

the subscribers group subscription

getBroadcastChannels

public List<BroadcastChannelHelper.BroadcastChannel> getBroadcastChannels()

Get the list of broadcast channel of the subscription

Returns:

the list of broadcast channel

getFrequency

public FrequencyHelper.Frequency getFrequency()

Get the frequency of the subscription

Returns:

the frequency

isForced

public boolean isForced()

true if the subscription is forced

Returns:

true if the subscription is forced

getForceFrequencyTiming

public SubscriptionType.FrequencyTiming getForceFrequencyTiming()

Get the frequency timing hour if the subscription is forced.

Returns:

the frequency timing

getDate

public ZonedDateTime getDate()

Get the date of the subscription.

Returns:

the date of the subscription.

getSite

public Site getSite()

Get the site of the subscription

Returns:

the site