org.kuali.mobility.push.service

Interface DeviceService

All Known Implementing Classes:

DeviceServiceImpl

public interface DeviceService

Interface for managing Device instances.

Since:

2.0.0

Author:

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

Method Summary

Methods

Modifier and Type	Method and Description
Long	countDevices() Counts the number of all registered devices.
long	countDevices(String deviceType) Counts the number of devices by device type.
int	countDevicesWithoutUsername() Returns a count of all devices that does not have a username
boolean	doesDeviceHaveUsername(String deviceid) Return tue if there is a username for the specifed deviceId
List<Device>	findAllDevices() Find all devices that are registered.
List<Device>	findAllDevices(String deviceType) Finds all devices of a specific type.
Device	findDeviceByDeviceId(String deviceid) Finds a device with the specified device ID
Device	findDeviceById(Long id) Finds a Device by the Object ID for the Device
List<Device>	findDevicesByDeviceId(String deviceid) Finds devices with the specified device id.
List<Device>	findDevicesById(String id)
List<Device>	findDevicesByRegId(String regid)
List<Device>	findDevicesByUsername(String username) Returns a list of devices registed by a username.
Map<String,List<Device>>	findDevicesMap() Gets a map of all registerd devices in a mapping between device type and a list of the devices for that type.
List<Device>	findDevicesWithoutUsername() Finds all device that does not have a username
List<String>	getSupportedDeviceTypes() Returns a list of device types that are set up.
void	registerDevice(Device device) Deprecated. This method is misleading as it does not register a device but persists the state of a device. Rather use saveDevice(Device). This method will be removed in version 3.0
boolean	removeDevice(Device device) Removes a Device instance from persistence.
void	saveDevice(Device device) Persists a Device instance

Method Detail

saveDevice

void saveDevice(Device device)

Persists a Device instance

Parameters:

device - The device to persist

registerDevice

@Deprecated
void registerDevice(Device device)

Deprecated. This method is misleading as it does not register a device but persists the state of a device. Rather use saveDevice(Device). This method will be removed in version 3.0

Persists a Device instance

Parameters:

device - The device to persist

removeDevice

boolean removeDevice(Device device)

Removes a Device instance from persistence.

Parameters:

device - The device to remove.

Returns:

countDevices

Long countDevices()

Counts the number of all registered devices. This can included devices that does not have a Registration ID and Username.

Returns:

countDevices

long countDevices(String deviceType)

Counts the number of devices by device type. This can included devices that does not have a Registration ID and Username.

Returns:

countDevicesWithoutUsername

int countDevicesWithoutUsername()

Returns a count of all devices that does not have a username

Returns:

findAllDevices

List<Device> findAllDevices()

Find all devices that are registered. This can included devices that does not have a Registration ID and Username

Returns:

getSupportedDeviceTypes

List<String> getSupportedDeviceTypes()

Returns a list of device types that are set up. This list will be dictated by the SenderService implemenations that was set up with the SendServiceDelegator. Device types returns in this list are expected to have SendService implementations configured. This method will call the SendServiceDelegator to find supported device types.

Returns:

A list of supported device types.

findAllDevices

List<Device> findAllDevices(String deviceType)

Finds all devices of a specific type. This can included devices that does not have a Registration ID and Username

Parameters:

deviceType -

Returns:

findDevicesMap

Map<String,List<Device>> findDevicesMap()

Gets a map of all registerd devices in a mapping between device type and a list of the devices for that type.

Returns:

doesDeviceHaveUsername

boolean doesDeviceHaveUsername(String deviceid)

Return tue if there is a username for the specifed deviceId

Parameters:

deviceid -

Returns:

findDevicesByUsername

List<Device> findDevicesByUsername(String username)

Returns a list of devices registed by a username.

Parameters:

username -

Returns:

findDevicesWithoutUsername

List<Device> findDevicesWithoutUsername()

Finds all device that does not have a username

Returns:

findDevicesByDeviceId

List<Device> findDevicesByDeviceId(String deviceid)

Finds devices with the specified device id. In theory, this should only return on Device

Parameters:

deviceid -

Returns:

findDeviceByDeviceId

Device findDeviceByDeviceId(String deviceid)

Finds a device with the specified device ID

Parameters:

deviceid -

Returns:

findDeviceById

Device findDeviceById(Long id)

Finds a Device by the Object ID for the Device

Parameters:

id - If of the Device to find.

Returns:

findDevicesById

List<Device> findDevicesById(String id)

findDevicesByRegId

List<Device> findDevicesByRegId(String regid)