org.wso2.carbon.device.mgt.analytics.dashboard

Interface GadgetDataService

All Known Implementing Classes:

GadgetDataServiceImpl

public interface GadgetDataService

This interface exposes useful service layer functions to retrieve data required by high level dashboard APIs.

Method Summary

Methods

Modifier and Type	Method and Description
DeviceCountByGroup	getDeviceCount(ExtendedFilterSet extendedFilterSet) This method is used to get a count of devices based on a defined filter set.
List<DeviceCountByGroup>	getDeviceCountsByConnectivityStatuses() This method is used to get device counts classified by connectivity statuses.
List<DeviceCountByGroup>	getDeviceCountsByOwnershipTypes(ExtendedFilterSet extendedFilterSet) This method is used to get device counts classified by ownership types.
List<DeviceCountByGroup>	getDeviceCountsByPlatforms(ExtendedFilterSet extendedFilterSet) This method is used to get device counts classified by platforms.
List<DeviceCountByGroup>	getDeviceCountsByPotentialVulnerabilities() This method is used to get device counts classified by potential vulnerabilities.
List<DeviceWithDetails>	getDevicesWithDetails(ExtendedFilterSet extendedFilterSet) This method is used to get a list of devices with details, based on a defined filter set.
org.wso2.carbon.device.mgt.common.PaginationResult	getDevicesWithDetails(ExtendedFilterSet extendedFilterSet, int startIndex, int resultCount) This method is used to get a paginated list of devices with details, based on a defined filter set.
DeviceCountByGroup	getFeatureNonCompliantDeviceCount(String featureCode, BasicFilterSet basicFilterSet) This method is used to get a count of devices non-compliant upon on a particular feature and a defined filter set.
List<DeviceCountByGroup>	getFeatureNonCompliantDeviceCountsByOwnershipTypes(String featureCode, BasicFilterSet basicFilterSet) This method is used to get device counts non-compliant upon a particular feature classified by ownership types.
List<DeviceCountByGroup>	getFeatureNonCompliantDeviceCountsByPlatforms(String featureCode, BasicFilterSet basicFilterSet) This method is used to get device counts non-compliant upon a particular feature classified by platforms.
List<DeviceWithDetails>	getFeatureNonCompliantDevicesWithDetails(String featureCode, BasicFilterSet basicFilterSet) This method is used to get a list of non-compliant devices with details, upon a particular feature.
org.wso2.carbon.device.mgt.common.PaginationResult	getFeatureNonCompliantDevicesWithDetails(String featureCode, BasicFilterSet basicFilterSet, int startIndex, int resultCount) This method is used to get a paginated list of non-compliant devices with details, upon a particular feature.
org.wso2.carbon.device.mgt.common.PaginationResult	getNonCompliantDeviceCountsByFeatures(int startIndex, int resultCount) This method is used to get non-compliant device counts classified by individual features.
DeviceCountByGroup	getTotalDeviceCount() This method is used to get total count of devices currently enrolled under a particular tenant.

Method Detail

getDeviceCount

DeviceCountByGroup getDeviceCount(ExtendedFilterSet extendedFilterSet)
                                  throws InvalidPotentialVulnerabilityValueException,
                                         DataAccessLayerException

This method is used to get a count of devices based on a defined filter set.

Parameters:

extendedFilterSet - An abstract representation of possible filtering options. if this value is simply "null" or no values are set for the defined filtering options, this method would return total device count in the system wrapped by the defined return format.

Returns:

An object of type DeviceCountByGroup.

Throws:

InvalidPotentialVulnerabilityValueException - This can occur if potentialVulnerability value of extendedFilterSet is set with some value other than "NON_COMPLIANT" or "UNMONITORED".

DataAccessLayerException - This can occur due to errors connecting to database, executing SQL query and retrieving data.

getFeatureNonCompliantDeviceCount

DeviceCountByGroup getFeatureNonCompliantDeviceCount(String featureCode,
                                                   BasicFilterSet basicFilterSet)
                                                     throws InvalidFeatureCodeValueException,
                                                            DataAccessLayerException

This method is used to get a count of devices non-compliant upon on a particular feature and a defined filter set.

Parameters:

featureCode - Code name of the non-compliant feature.

basicFilterSet - An abstract representation of possible filtering options. if this value is simply "null" or no values are set for the defined filtering options, this method would return total non-compliant device count in the system for the given feature-code, wrapped by the defined return format.

Returns:

An object of type DeviceCountByGroup.

Throws:

InvalidFeatureCodeValueException - This can occur if featureCode is set to null or empty.

DataAccessLayerException - This can occur due to errors connecting to database, executing SQL query and retrieving data.

getTotalDeviceCount

DeviceCountByGroup getTotalDeviceCount()
                                       throws DataAccessLayerException

This method is used to get total count of devices currently enrolled under a particular tenant.

Returns:

An object of type DeviceCountByGroup.

Throws:

DataAccessLayerException - This can occur due to errors connecting to database, executing SQL query and retrieving data.

getDeviceCountsByConnectivityStatuses

List<DeviceCountByGroup> getDeviceCountsByConnectivityStatuses()
                                                               throws DataAccessLayerException

This method is used to get device counts classified by connectivity statuses.

Returns:

A list of objects of type DeviceCountByGroup.

Throws:

DataAccessLayerException - This can occur due to errors connecting to database, executing SQL query and retrieving data.

getDeviceCountsByPotentialVulnerabilities

List<DeviceCountByGroup> getDeviceCountsByPotentialVulnerabilities()
                                                                   throws DataAccessLayerException

This method is used to get device counts classified by potential vulnerabilities.

Returns:

A list of objects of type DeviceCountByGroup.

Throws:

DataAccessLayerException - This can occur due to errors connecting to database, executing SQL query and retrieving data.

getNonCompliantDeviceCountsByFeatures

org.wso2.carbon.device.mgt.common.PaginationResult getNonCompliantDeviceCountsByFeatures(int startIndex,
                                                                                       int resultCount)
                                                                                         throws InvalidStartIndexValueException,
                                                                                                InvalidResultCountValueException,
                                                                                                DataAccessLayerException

This method is used to get non-compliant device counts classified by individual features.

Parameters:

startIndex - Starting index of the data set to be retrieved.

resultCount - Total count of the result set retrieved.

Returns:

An object of type PaginationResult.

Throws:

InvalidStartIndexValueException - This can occur if startIndex value is lesser than its minimum (0).

InvalidResultCountValueException - This can occur if resultCount value is lesser than its minimum (5).

DataAccessLayerException - This can occur due to errors connecting to database, executing SQL query and retrieving data.

getDeviceCountsByPlatforms

List<DeviceCountByGroup> getDeviceCountsByPlatforms(ExtendedFilterSet extendedFilterSet)
                                                    throws InvalidPotentialVulnerabilityValueException,
                                                           DataAccessLayerException

This method is used to get device counts classified by platforms.

Parameters:

extendedFilterSet - An abstract representation of possible filtering options. if this value is simply "null" or no values are set for the defined filtering options, this method would return total device counts per each platform in the system, wrapped by the defined return format.

Returns:

An object of type DeviceCountByGroup.

Throws:

InvalidPotentialVulnerabilityValueException - This can occur if potentialVulnerability value of extendedFilterSet is set with some value other than "NON_COMPLIANT" or "UNMONITORED".

DataAccessLayerException - This can occur due to errors connecting to database, executing SQL query and retrieving data.

getFeatureNonCompliantDeviceCountsByPlatforms

List<DeviceCountByGroup> getFeatureNonCompliantDeviceCountsByPlatforms(String featureCode,
                                                                     BasicFilterSet basicFilterSet)
                                                                       throws InvalidFeatureCodeValueException,
                                                                              DataAccessLayerException

This method is used to get device counts non-compliant upon a particular feature classified by platforms.

Parameters:

featureCode - Code name of the non-compliant feature.

basicFilterSet - An abstract representation of possible filtering options. if this value is simply "null" or no values are set for the defined filtering options, this method would return total non-compliant device counts per each platform in the system, wrapped by the defined return format.

Returns:

A list of objects of type DeviceCountByGroup.

Throws:

InvalidFeatureCodeValueException - This can occur if featureCode is set to null or empty.

DataAccessLayerException - This can occur due to errors connecting to database, executing SQL query and retrieving data.

getDeviceCountsByOwnershipTypes

List<DeviceCountByGroup> getDeviceCountsByOwnershipTypes(ExtendedFilterSet extendedFilterSet)
                                                         throws InvalidPotentialVulnerabilityValueException,
                                                                DataAccessLayerException

This method is used to get device counts classified by ownership types.

Parameters:

extendedFilterSet - An abstract representation of possible filtering options. if this value is simply "null" or no values are set for the defined filtering options, this method would return total device counts per each ownership type in the system, wrapped by the defined return format.

Returns:

A list of objects of type DeviceCountByGroup.

Throws:

InvalidPotentialVulnerabilityValueException - This can occur if potentialVulnerability value of extendedFilterSet is set with some value other than "NON_COMPLIANT" or "UNMONITORED".

DataAccessLayerException - This can occur due to errors connecting to database, executing SQL query and retrieving data.

getFeatureNonCompliantDeviceCountsByOwnershipTypes

List<DeviceCountByGroup> getFeatureNonCompliantDeviceCountsByOwnershipTypes(String featureCode,
                                                                          BasicFilterSet basicFilterSet)
                                                                            throws InvalidFeatureCodeValueException,
                                                                                   DataAccessLayerException

This method is used to get device counts non-compliant upon a particular feature classified by ownership types.

Parameters:

featureCode - Code name of the non-compliant feature.

basicFilterSet - An abstract representation of possible filtering options. if this value is simply "null" or no values are set for the defined filtering options, this method would return total non-compliant device counts per each ownership type in the system, wrapped by the defined return format.

Returns:

A list of objects of type DeviceCountByGroup.

Throws:

InvalidFeatureCodeValueException - This can occur if featureCode is set to null or empty.

DataAccessLayerException - This can occur due to errors connecting to database, executing SQL query and retrieving data.

getDevicesWithDetails

org.wso2.carbon.device.mgt.common.PaginationResult getDevicesWithDetails(ExtendedFilterSet extendedFilterSet,
                                                                       int startIndex,
                                                                       int resultCount)
                                                                         throws InvalidPotentialVulnerabilityValueException,
                                                                                DataAccessLayerException,
                                                                                InvalidStartIndexValueException,
                                                                                InvalidResultCountValueException

This method is used to get a paginated list of devices with details, based on a defined filter set.

Parameters:

extendedFilterSet - An abstract representation of possible filtering options. if this value is simply "null" or no values are set for the defined filtering options, this method would return a paginated device list in the system specified by result count, starting from specified start index, and wrapped by the defined return format.

startIndex - Starting index of the data set to be retrieved.

resultCount - Total count of the result set retrieved.

Returns:

An object of type PaginationResult.

Throws:

InvalidPotentialVulnerabilityValueException - This can occur if potentialVulnerability value of extendedFilterSet is set with some value other than "NON_COMPLIANT" or "UNMONITORED".

DataAccessLayerException - This can occur due to errors connecting to database, executing SQL query and retrieving data.

InvalidStartIndexValueException - This can occur if startIndex value is lesser than its minimum (0).

InvalidResultCountValueException - This can occur if resultCount value is lesser than its minimum (5).

getFeatureNonCompliantDevicesWithDetails

org.wso2.carbon.device.mgt.common.PaginationResult getFeatureNonCompliantDevicesWithDetails(String featureCode,
                                                                                          BasicFilterSet basicFilterSet,
                                                                                          int startIndex,
                                                                                          int resultCount)
                                                                                            throws InvalidFeatureCodeValueException,
                                                                                                   DataAccessLayerException,
                                                                                                   InvalidStartIndexValueException,
                                                                                                   InvalidResultCountValueException

This method is used to get a paginated list of non-compliant devices with details, upon a particular feature.

Parameters:

featureCode - Code name of the non-compliant feature.

basicFilterSet - An abstract representation of possible filtering options. if this value is simply "null" or no values are set for the defined filtering options, this method would return a paginated device list in the system, non-compliant by specified feature-code, result count, starting from specified start index, and wrapped by the defined return format.

startIndex - Starting index of the data set to be retrieved.

resultCount - Total count of the result set retrieved.

Returns:

An object of type PaginationResult.

Throws:

InvalidFeatureCodeValueException - This can occur if featureCode is set to null or empty.

DataAccessLayerException - This can occur due to errors connecting to database, executing SQL query and retrieving data.

InvalidStartIndexValueException - This can occur if startIndex value is lesser than its minimum (0).

InvalidResultCountValueException - This can occur if resultCount value is lesser than its minimum (5).

getDevicesWithDetails

List<DeviceWithDetails> getDevicesWithDetails(ExtendedFilterSet extendedFilterSet)
                                              throws InvalidPotentialVulnerabilityValueException,
                                                     DataAccessLayerException

This method is used to get a list of devices with details, based on a defined filter set.

Parameters:

extendedFilterSet - An abstract representation of possible filtering options. if this value is simply "null" or no values are set for the defined filtering options, this method would return total device list in the system wrapped by the defined return format.

Returns:

A list of objects of type DeviceWithDetails.

Throws:

InvalidPotentialVulnerabilityValueException - This can occur if potentialVulnerability value of extendedFilterSet is set with some value other than "NON_COMPLIANT" or "UNMONITORED".

DataAccessLayerException - This can occur due to errors connecting to database, executing SQL query and retrieving data.

getFeatureNonCompliantDevicesWithDetails

List<DeviceWithDetails> getFeatureNonCompliantDevicesWithDetails(String featureCode,
                                                               BasicFilterSet basicFilterSet)
                                                                 throws InvalidFeatureCodeValueException,
                                                                        DataAccessLayerException

This method is used to get a list of non-compliant devices with details, upon a particular feature.

Parameters:

featureCode - Code name of the non-compliant feature.

basicFilterSet - An abstract representation of possible filtering options. if this value is simply "null" or no values are set for the defined filtering options, this method would return total set of non-compliant devices in the system upon given feature-code, wrapped by the defined return format.

Returns:

A list of objects of type DeviceWithDetails.

Throws:

InvalidFeatureCodeValueException - This can occur if featureCode is set to null or empty.

DataAccessLayerException - This can occur due to errors connecting to database, executing SQL query and retrieving data.