com.ibm.portal.devicesupport
Interface DeviceClassService

All Known Subinterfaces:

CorDeviceClassService, PortalDeviceClassService, PortletDeviceClassService

public interface DeviceClassService

Service interface for device classes. Provides access to device classes assigned to a client, and methods to determine the best matching device class for a client and a resource requested by the client.

Since:

7.0.0.2

Method Summary

DeviceClassEquation	getBestEquation(java.util.List<? extends DeviceClassEquation> deviceEquations) Performs getBestMatch where the order of the device classes passed in is the priority order.
DeviceClass	getBestMatch(DeviceClassCapable resource)
DeviceClass	getBestMatch(java.util.List<? extends DeviceClass> deviceClasses) Performs getBestMatch where the order of the device classes passed in is the priority order.
DeviceClass	getBestMatch(java.util.Set<? extends DeviceClass> deviceClasses) Performs getBestMatch where
java.util.List<? extends DeviceClass>	getClientDeviceClasses()

Method Detail

getBestMatch

DeviceClass getBestMatch(DeviceClassCapable resource)
                         throws DataException,
                                ModelException

Parameters:

resource - A resource that supports a specific set of device classes

Returns:

The best matching device class for the client requesting the resource, taking into account all fallbacks that are defined on device classes

Throws:

DataException

ModelException

getBestMatch

DeviceClass getBestMatch(java.util.Set<? extends DeviceClass> deviceClasses)

Performs getBestMatch where

Parameters:

deviceClasses - A set of device classes

Returns:

The best matching device class for the client requesting the resource

getBestMatch

DeviceClass getBestMatch(java.util.List<? extends DeviceClass> deviceClasses)

Performs getBestMatch where the order of the device classes passed in is the priority order.

Parameters:

deviceClasses - A set of device classes

Returns:

The best matching device class for the client requesting the resource, using the parameter deviceClasses as a priority list.

getBestEquation

DeviceClassEquation getBestEquation(java.util.List<? extends DeviceClassEquation> deviceEquations)

Performs getBestMatch where the order of the device classes passed in is the priority order.

Parameters:

deviceEquations - A set of device equations

Returns:

The best matching device class equation for the client requesting the resource, using the parameter deviceEquations as a priority list.

getClientDeviceClasses

java.util.List<? extends DeviceClass> getClientDeviceClasses()

Returns:

device classes assigned to the client, in decreasing order of preference, not null but may be empty