Package org.ametys.plugins.pagesubscription

Class SubscriptionFactory

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.plugins.repository.jcr.SimpleAmetysObjectFactory

org.ametys.plugins.pagesubscription.SubscriptionFactory

All Implemented Interfaces:

AmetysObjectFactory<SimpleAmetysObject>, JCRAmetysObjectFactory<SimpleAmetysObject>, Component, Configurable, LogEnabled, Serviceable

public class SubscriptionFactory
extends SimpleAmetysObjectFactory

AmetysObject factory associated with Subscription

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BROADCAST_CHANNEL	Data name for the broadcast channel of the subscription
static final String	DATE	Data name for the date of the subscription
static final String	FORCED_DAY	Data name for the day of the subscription if it's forced
static final String	FORCED_HOUR	Data name for the hour of the subscription if it's forced
static final String	FREQUENCY	Data name for the frequency of the subscription
static final String	IS_FORCED	Data name to determine if the subscription is forced or not
static final String	MODEL_ITEM_TYPE_EXTENSION_ROLE	Avalon Role for subscription data types
static final String	NODE_TYPE	Subscription node type name.
static final String	SUBSCRIBER	Data name for the subscriber
static final String	SUBSCRIBERS_GROUP	Data name for the subscribers group
static final String	SUBSCRIPTION_TYPE_ID	Data name for the subscription type id

Fields inherited from class org.ametys.plugins.repository.jcr.SimpleAmetysObjectFactory

_ametysFactoryExtensionPoint, _manager, _nodetype, _repository, _resolver, _scheme

Constructor Summary

Constructors

Constructor	Description
SubscriptionFactory()

Method Summary

Modifier and Type	Method	Description
Subscription	getAmetysObject(javax.jcr.Node node, String parentPath)	Creates a AmetysObject from a persistent JCR node.
ModelItemTypeExtensionPoint	getElementTypesExtensionPoint()	Retrieves the extension point with available modelItem types for Subscription
SubscriptionType	getSubscriptionType(String subscriptionTypeId)	Retrieve an SubscriptionType
void	service(ServiceManager serviceManager)

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

configure, getAmetysObjectById, getAmetysObjectById, getNode, getNodetypes, getParent, getScheme, getWorkspaceNode, hasAmetysObjectForId

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MODEL_ITEM_TYPE_EXTENSION_ROLE

public static final String MODEL_ITEM_TYPE_EXTENSION_ROLE

Avalon Role for subscription data types

NODE_TYPE

public static final String NODE_TYPE

Subscription node type name.

See Also:

• Constant Field Values

SUBSCRIPTION_TYPE_ID

public static final String SUBSCRIPTION_TYPE_ID

Data name for the subscription type id

See Also:

• Constant Field Values

SUBSCRIBER

public static final String SUBSCRIBER

Data name for the subscriber

See Also:

• Constant Field Values

SUBSCRIBERS_GROUP

public static final String SUBSCRIBERS_GROUP

Data name for the subscribers group

See Also:

• Constant Field Values

DATE

public static final String DATE

Data name for the date of the subscription

See Also:

• Constant Field Values

FREQUENCY

public static final String FREQUENCY

Data name for the frequency of the subscription

See Also:

• Constant Field Values

BROADCAST_CHANNEL

public static final String BROADCAST_CHANNEL

Data name for the broadcast channel of the subscription

See Also:

• Constant Field Values

IS_FORCED

public static final String IS_FORCED

Data name to determine if the subscription is forced or not

See Also:

• Constant Field Values

FORCED_DAY

public static final String FORCED_DAY

Data name for the day of the subscription if it's forced

See Also:

• Constant Field Values

FORCED_HOUR

public static final String FORCED_HOUR

Data name for the hour of the subscription if it's forced

See Also:

• Constant Field Values

Constructor Details

SubscriptionFactory

public SubscriptionFactory()

Method Details

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class SimpleAmetysObjectFactory

Throws:

ServiceException

getAmetysObject

public Subscription getAmetysObject(javax.jcr.Node node,
 String parentPath)
                             throws AmetysRepositoryException,
javax.jcr.RepositoryException

Description copied from interface: JCRAmetysObjectFactory

Creates a AmetysObject from a persistent JCR node.

Specified by:

getAmetysObject in interface JCRAmetysObjectFactory<SimpleAmetysObject>

Overrides:

getAmetysObject in class SimpleAmetysObjectFactory

Parameters:

node - the JCR node to use.

parentPath - the parent Path in the Ametys hierarchy, may be null if not known yet.

Returns:

the object.

Throws:

AmetysRepositoryException - if an error occurs.

javax.jcr.RepositoryException - if a JCR error occurs.

getElementTypesExtensionPoint

public ModelItemTypeExtensionPoint getElementTypesExtensionPoint()

Retrieves the extension point with available modelItem types for Subscription

Returns:

the extension point with available modelItem types for Subscription

getSubscriptionType

public SubscriptionType getSubscriptionType(String subscriptionTypeId)

Retrieve an SubscriptionType

Parameters:

subscriptionTypeId - the type id

Returns:

the subscription type