Package org.dspace.eperson

Class SubscribeServiceImpl

java.lang.Object

org.dspace.eperson.SubscribeServiceImpl

All Implemented Interfaces:

SubscribeService

public class SubscribeServiceImpl
extends Object
implements SubscribeService

Class defining methods for sending new item e-mail alerts to users

Version:

$Revision$

Author:

Robert Tansley

Constructor Summary

Constructors

Constructor	Description
SubscribeServiceImpl()

Method Summary

Modifier and Type	Method	Description
Subscription	addSubscriptionParameter(Context context, Integer id, SubscriptionParameter subscriptionParam)	Adds a parameter to a subscription
Long	countAll(Context context)	Counts all subscriptions
Long	countByEPersonAndDSO(Context context, EPerson ePerson, DSpaceObject dSpaceObject)	Counts all subscriptions by ePerson and DSO
Long	countSubscriptionsByEPerson(Context context, EPerson ePerson)	Counts all subscriptions by ePerson
void	deleteByDspaceObject(Context context, DSpaceObject dSpaceObject)	Delete subscription by collection.
void	deleteByEPerson(Context context, EPerson ePerson)	Delete subscription by eperson (subscriber).
void	deleteSubscription(Context context, Subscription subscription)	Deletes a subscription
List<Subscription>	findAll(Context context, String resourceType, Integer limit, Integer offset)	Subscribe an e-person to a collection.
List<Subscription>	findAllSubscriptionsBySubscriptionTypeAndFrequency(Context context, String subscriptionType, String frequencyValue)	Finds all subscriptions by subscriptionType and frequency
List<Collection>	findAvailableSubscriptions(Context context)	Find out which collections the currently logged in e-person can subscribe to
List<Collection>	findAvailableSubscriptions(Context context, EPerson eperson)	Find out which collections an e-person can subscribe to
Subscription	findById(Context context, int id)	Finds a subscription by id
List<Subscription>	findSubscriptionsByEPerson(Context context, EPerson eperson, Integer limit, Integer offset)	Find out which collections an e-person is subscribed to
List<Subscription>	findSubscriptionsByEPersonAndDso(Context context, EPerson eperson, DSpaceObject dSpaceObject, Integer limit, Integer offset)	Find out which collections an e-person is subscribed to and related with dso
boolean	isSubscribed(Context context, EPerson eperson, DSpaceObject dSpaceObject)	Is that e-person subscribed to that collection?
Subscription	removeSubscriptionParameter(Context context, Integer id, SubscriptionParameter subscriptionParam)	Deletes a parameter from subscription
Subscription	subscribe(Context context, EPerson eperson, DSpaceObject dSpaceObject, List<SubscriptionParameter> subscriptionParameterList, String type)	Subscribe an EPerson to a dSpaceObject (Collection or Community).
void	unsubscribe(Context context, EPerson eperson, DSpaceObject dSpaceObject)	Unsubscribe an e-person to a collection.
Subscription	updateSubscription(Context context, Integer id, String subscriptionType, List<SubscriptionParameter> subscriptionParameterList)	Updates a subscription by id

Methods inherited from class java.lang.Object

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

Constructor Detail

SubscribeServiceImpl

public SubscribeServiceImpl()

Method Detail

findAll

public List<Subscription> findAll(Context context,
                                  String resourceType,
                                  Integer limit,
                                  Integer offset)
                           throws Exception

Description copied from interface: SubscribeService

Subscribe an e-person to a collection. An e-mail will be sent every day a new item appears in the collection.

Specified by:

findAll in interface SubscribeService

Parameters:

context - DSpace context

limit - Number of subscriptions to return

offset - Offset number

Returns:

list of Subscription objects

Throws:

SQLException - An exception that provides information on a database access error or other errors.

Exception

subscribe

public Subscription subscribe(Context context,
                              EPerson eperson,
                              DSpaceObject dSpaceObject,
                              List<SubscriptionParameter> subscriptionParameterList,
                              String type)
                       throws SQLException,
                              AuthorizeException

Description copied from interface: SubscribeService

Subscribe an EPerson to a dSpaceObject (Collection or Community). An e-mail will be sent every day a new item appears in the Collection or Community.

Specified by:

subscribe in interface SubscribeService

Parameters:

context - DSpace context object

eperson - EPerson to subscribe

dSpaceObject - DSpaceObject to subscribe

subscriptionParameterList - list of @SubscriptionParameter

type - Currently supported only "content"

Returns:

Throws:

SQLException - An exception that provides information on a database access error or other errors.

AuthorizeException - Exception indicating the current user of the context does not have permission to perform a particular action.

unsubscribe

public void unsubscribe(Context context,
                        EPerson eperson,
                        DSpaceObject dSpaceObject)
                 throws SQLException,
                        AuthorizeException

Description copied from interface: SubscribeService

Unsubscribe an e-person to a collection. Passing in null for the collection unsubscribes the e-person from all collections they are subscribed to.

Specified by:

unsubscribe in interface SubscribeService

Parameters:

context - DSpace context

eperson - EPerson to unsubscribe

dSpaceObject - DSpaceObject to unsubscribe from

Throws:

SQLException - An exception that provides information on a database access error or other errors.

AuthorizeException - Exception indicating the current user of the context does not have permission to perform a particular action.

findSubscriptionsByEPerson

public List<Subscription> findSubscriptionsByEPerson(Context context,
                                                     EPerson eperson,
                                                     Integer limit,
                                                     Integer offset)
                                              throws SQLException

Description copied from interface: SubscribeService

Find out which collections an e-person is subscribed to

Specified by:

findSubscriptionsByEPerson in interface SubscribeService

Parameters:

context - DSpace context

eperson - EPerson

limit - Number of subscriptions to return

offset - Offset number

Returns:

array of collections e-person is subscribed to

Throws:

SQLException - An exception that provides information on a database access error or other errors.

findSubscriptionsByEPersonAndDso

public List<Subscription> findSubscriptionsByEPersonAndDso(Context context,
                                                           EPerson eperson,
                                                           DSpaceObject dSpaceObject,
                                                           Integer limit,
                                                           Integer offset)
                                                    throws SQLException

Description copied from interface: SubscribeService

Find out which collections an e-person is subscribed to and related with dso

Specified by:

findSubscriptionsByEPersonAndDso in interface SubscribeService

Parameters:

context - DSpace context

eperson - EPerson

dSpaceObject - DSpaceObject

limit - Number of subscriptions to return

offset - Offset number

Returns:

array of collections e-person is subscribed to and related with dso

Throws:

SQLException - An exception that provides information on a database access error or other errors.

findAvailableSubscriptions

public List<Collection> findAvailableSubscriptions(Context context)
                                            throws SQLException

Description copied from interface: SubscribeService

Find out which collections the currently logged in e-person can subscribe to

Specified by:

findAvailableSubscriptions in interface SubscribeService

Parameters:

context - DSpace context

Returns:

array of collections the currently logged in e-person can subscribe to

Throws:

SQLException - An exception that provides information on a database access error or other errors.

findAvailableSubscriptions

public List<Collection> findAvailableSubscriptions(Context context,
                                                   EPerson eperson)
                                            throws SQLException

Description copied from interface: SubscribeService

Find out which collections an e-person can subscribe to

Specified by:

findAvailableSubscriptions in interface SubscribeService

Parameters:

context - DSpace context

eperson - EPerson

Returns:

array of collections e-person can subscribe to

Throws:

SQLException - An exception that provides information on a database access error or other errors.

isSubscribed

public boolean isSubscribed(Context context,
                            EPerson eperson,
                            DSpaceObject dSpaceObject)
                     throws SQLException

Description copied from interface: SubscribeService

Is that e-person subscribed to that collection?

Specified by:

isSubscribed in interface SubscribeService

Parameters:

context - DSpace context

eperson - find out if this e-person is subscribed

dSpaceObject - find out if subscribed to this dSpaceObject

Returns:

true if they are subscribed

Throws:

SQLException - An exception that provides information on a database access error or other errors.

deleteByDspaceObject

public void deleteByDspaceObject(Context context,
                                 DSpaceObject dSpaceObject)
                          throws SQLException

Description copied from interface: SubscribeService

Delete subscription by collection.

Specified by:

deleteByDspaceObject in interface SubscribeService

Parameters:

context - DSpace context

dSpaceObject - find out if subscribed to this dSpaceObject

Throws:

SQLException - An exception that provides information on a database access error or other errors.

deleteByEPerson

public void deleteByEPerson(Context context,
                            EPerson ePerson)
                     throws SQLException

Description copied from interface: SubscribeService

Delete subscription by eperson (subscriber).

Specified by:

deleteByEPerson in interface SubscribeService

Parameters:

context - DSpace context

ePerson - find out if this e-person is subscribed

Throws:

SQLException - An exception that provides information on a database access error or other errors.

findById

public Subscription findById(Context context,
                             int id)
                      throws SQLException

Description copied from interface: SubscribeService

Finds a subscription by id

Specified by:

findById in interface SubscribeService

Parameters:

context - DSpace context

id - the id of subscription to be searched

Throws:

SQLException - An exception that provides information on a database access error or other errors.

updateSubscription

public Subscription updateSubscription(Context context,
                                       Integer id,
                                       String subscriptionType,
                                       List<SubscriptionParameter> subscriptionParameterList)
                                throws SQLException

Description copied from interface: SubscribeService

Updates a subscription by id

Specified by:

updateSubscription in interface SubscribeService

Parameters:

context - DSpace context

id - Integer id

subscriptionType - type

subscriptionParameterList - List subscriptionParameterList

Throws:

SQLException - An exception that provides information on a database access error or other errors.

addSubscriptionParameter

public Subscription addSubscriptionParameter(Context context,
                                             Integer id,
                                             SubscriptionParameter subscriptionParam)
                                      throws SQLException

Description copied from interface: SubscribeService

Adds a parameter to a subscription

Specified by:

addSubscriptionParameter in interface SubscribeService

Parameters:

context - DSpace context

id - Integer id

subscriptionParam - SubscriptionParameter subscriptionParameter

Throws:

SQLException - An exception that provides information on a database access error or other errors.

removeSubscriptionParameter

public Subscription removeSubscriptionParameter(Context context,
                                                Integer id,
                                                SubscriptionParameter subscriptionParam)
                                         throws SQLException

Description copied from interface: SubscribeService

Deletes a parameter from subscription

Specified by:

removeSubscriptionParameter in interface SubscribeService

Parameters:

context - DSpace context

id - Integer id

subscriptionParam - SubscriptionParameter subscriptionParameter

Throws:

SQLException - An exception that provides information on a database access error or other errors.

deleteSubscription

public void deleteSubscription(Context context,
                               Subscription subscription)
                        throws SQLException

Description copied from interface: SubscribeService

Deletes a subscription

Specified by:

deleteSubscription in interface SubscribeService

Parameters:

context - DSpace context

subscription - The subscription to delete

Throws:

SQLException - An exception that provides information on a database access error or other errors.

findAllSubscriptionsBySubscriptionTypeAndFrequency

public List<Subscription> findAllSubscriptionsBySubscriptionTypeAndFrequency(Context context,
                                                                             String subscriptionType,
                                                                             String frequencyValue)
                                                                      throws SQLException

Description copied from interface: SubscribeService

Finds all subscriptions by subscriptionType and frequency

Specified by:

findAllSubscriptionsBySubscriptionTypeAndFrequency in interface SubscribeService

Parameters:

context - DSpace context

subscriptionType - Could be "content" or "statistics". NOTE: in DSpace we have only "content"

frequencyValue - Could be "D" stand for Day, "W" stand for Week, and "M" stand for Month

Throws:

SQLException - An exception that provides information on a database access error or other errors.

countAll

public Long countAll(Context context)
              throws SQLException

Description copied from interface: SubscribeService

Counts all subscriptions

Specified by:

countAll in interface SubscribeService

Parameters:

context - DSpace context

Throws:

SQLException

countSubscriptionsByEPerson

public Long countSubscriptionsByEPerson(Context context,
                                        EPerson ePerson)
                                 throws SQLException

Description copied from interface: SubscribeService

Counts all subscriptions by ePerson

Specified by:

countSubscriptionsByEPerson in interface SubscribeService

Parameters:

context - DSpace context

ePerson - EPerson ePerson

Throws:

SQLException

countByEPersonAndDSO

public Long countByEPersonAndDSO(Context context,
                                 EPerson ePerson,
                                 DSpaceObject dSpaceObject)
                          throws SQLException

Description copied from interface: SubscribeService

Counts all subscriptions by ePerson and DSO

Specified by:

countByEPersonAndDSO in interface SubscribeService

Parameters:

context - DSpace context

ePerson - EPerson ePerson

dSpaceObject - DSpaceObject dSpaceObject

Throws:

SQLException