org.kuali.mobility.push.service

Interface SenderService

All Known Implementing Classes:

SenderServiceImpl

public interface SenderService

Interface for retrieving and persisting Sender for the purpose of sending Push messages to Device. Implementations of this service will typically provide for the access and checking of the status of a sender and provide for opt-out/opt-in push preferences to the user.

Since:

2.0.0

Author:

Kuali Mobility Team (mobility.dev@kuali.org)

Method Summary

Methods

Modifier and Type	Method and Description
List<Sender>	findAllSenders() Find and return all available Sender objects, useful for opt-in/opt-out preferences.
List<Sender>	findAllUnhiddenSenders() Find and return all available Sender objects, useful for opt-in/opt-out preferences.
Sender	findSenderById(long id) Find and return Sender object, using Id as search criteria.
Sender	findSenderByName(String name) Find and return Sender object, using Name as search criteria.
Sender	findSenderBySenderKey(String senderKey) Find and return Sender object, using SenderKey as search criteria.
Sender	findSenderByShortName(String shortName) Find and return Sender object, using ShortName as search criteria.
boolean	isValidSenderKey(String senderKey) Determine validity/availability of the senderKey.
boolean	removeSender(Sender sender) Removes a Sender object.
void	saveSender(Sender sender) Persists a Sender object.

Method Detail

saveSender

void saveSender(Sender sender)

Persists a Sender object.

Parameters:

sender - Sender to persist.

removeSender

boolean removeSender(Sender sender)

Removes a Sender object.

Parameters:

sender - Sender to remove.

isValidSenderKey

boolean isValidSenderKey(String senderKey)

Determine validity/availability of the senderKey.

Parameters:

senderKey - SenderKey to determine if valid.

Returns:

validity of a senderKey.

findAllSenders

List<Sender> findAllSenders()

Find and return all available Sender objects, useful for opt-in/opt-out preferences.

Returns:

List of all Sender objects.

findAllUnhiddenSenders

List<Sender> findAllUnhiddenSenders()

Find and return all available Sender objects, useful for opt-in/opt-out preferences.

Returns:

List of all Sender objects whom are not set to be hidden.

findSenderById

Sender findSenderById(long id)

Find and return Sender object, using Id as search criteria.

Parameters:

id - Id for the Sender to find.

Returns:

Sender as determined by id.

findSenderByName

Sender findSenderByName(String name)

Find and return Sender object, using Name as search criteria.

Parameters:

name - Name of the Sender to find.

Returns:

Sender as determined by Name.

findSenderByShortName

Sender findSenderByShortName(String shortName)

Find and return Sender object, using ShortName as search criteria.

Parameters:

shortName - ShortName for the Sender to find.

Returns:

Sender as determined by ShortName.

findSenderBySenderKey

Sender findSenderBySenderKey(String senderKey)

Find and return Sender object, using SenderKey as search criteria.

Parameters:

senderKey - SenderKey for the Sender to find.

Returns:

Sender as determined by SenderKey.