community/device-mgt-core
1
0
Fork 0
mirror of https://repository.entgra.net/community/device-mgt-core.git synced 2025-10-06 02:01:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

Adding more comments to dashboard analytics data service interface

Browse Source
This commit is contained in:
dilanua 2016-05-22 16:54:07 +05:30
parent 975a3b915f
commit 8c4752ede3
1 changed files with 17 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
components/device-mgt/org.wso2.carbon.device.mgt.analytics.dashboard/src/main/java/org/wso2/carbon/device/mgt/analytics/dashboard/GadgetDataService.java
View File

@ -58,7 +58,8 @@ public interface GadgetDataService {
* this method would return total device count in the system * this method would return total device count in the system
* wrapped with in the defined return format. * wrapped with in the defined return format.
* @return An object of type DeviceCountByGroupEntry. * @return An object of type DeviceCountByGroupEntry.
* @throws InvalidParameterValueException This can occur if and only if potentialVulnerability value of filterSet * @throws InvalidParameterValueException This can occur if nonCompliantFeatureCode is set to null or empty.
* This can also occur if potentialVulnerability value of filterSet
* is set with some value other than "NON_COMPLIANT" or "UNMONITORED". * is set with some value other than "NON_COMPLIANT" or "UNMONITORED".
* @throws DataAccessLayerException This can occur due to errors connecting to database, * @throws DataAccessLayerException This can occur due to errors connecting to database,
* executing SQL query and retrieving data. * executing SQL query and retrieving data.
@ -99,8 +100,8 @@ public interface GadgetDataService {
* @param startIndex Starting index of the data set to be retrieved. * @param startIndex Starting index of the data set to be retrieved.
* @param resultCount Total count of the result set retrieved. * @param resultCount Total count of the result set retrieved.
* @return An object of type PaginationResult. * @return An object of type PaginationResult.
* @throws InvalidParameterValueException This can occur if and only if potentialVulnerability value of filterSet * @throws InvalidParameterValueException This can occur if startIndex or resultCount is set to values
* is set with some value other than "NON_COMPLIANT" or "UNMONITORED". * lesser than their minimums.
* @throws DataAccessLayerException This can occur due to errors connecting to database, * @throws DataAccessLayerException This can occur due to errors connecting to database,
* executing SQL query and retrieving data. * executing SQL query and retrieving data.
*/ */
@ -115,8 +116,8 @@ public interface GadgetDataService {
* this method would return total device count in the system * this method would return total device count in the system
* wrapped with in the defined return format. * wrapped with in the defined return format.
* @return An object of type DeviceCountByGroupEntry. * @return An object of type DeviceCountByGroupEntry.
* @throws InvalidParameterValueException This can occur if and only if potentialVulnerability value of filterSet * @throws InvalidParameterValueException This can occur if startIndex or resultCount is set to values
* is set with some value other than "NON_COMPLIANT" or "UNMONITORED". * lesser than their minimums.
* @throws DataAccessLayerException This can occur due to errors connecting to database, * @throws DataAccessLayerException This can occur due to errors connecting to database,
* executing SQL query and retrieving data. * executing SQL query and retrieving data.
*/ */
@ -148,7 +149,8 @@ public interface GadgetDataService {
* this method would return total device count in the system * this method would return total device count in the system
* wrapped with in the defined return format. * wrapped with in the defined return format.
* @return A list of objects of type DeviceCountByGroupEntry. * @return A list of objects of type DeviceCountByGroupEntry.
* @throws InvalidParameterValueException This can occur if and only if potentialVulnerability value of filterSet * @throws InvalidParameterValueException This can occur if nonCompliantFeatureCode is set to null or empty.
* This can also occur if potentialVulnerability value of filterSet
* is set with some value other than "NON_COMPLIANT" or "UNMONITORED". * is set with some value other than "NON_COMPLIANT" or "UNMONITORED".
* @throws DataAccessLayerException This can occur due to errors connecting to database, * @throws DataAccessLayerException This can occur due to errors connecting to database,
* executing SQL query and retrieving data. * executing SQL query and retrieving data.
@ -183,7 +185,8 @@ public interface GadgetDataService {
* @param startIndex Starting index of the data set to be retrieved. * @param startIndex Starting index of the data set to be retrieved.
* @param resultCount Total count of the result set retrieved. * @param resultCount Total count of the result set retrieved.
* @return An object of type PaginationResult. * @return An object of type PaginationResult.
* @throws InvalidParameterValueException This can occur if and only if potentialVulnerability value of filterSet * @throws InvalidParameterValueException This can occur if nonCompliantFeatureCode is set to null or empty.
* This can also occur if potentialVulnerability value of filterSet
* is set with some value other than "NON_COMPLIANT" or "UNMONITORED". * is set with some value other than "NON_COMPLIANT" or "UNMONITORED".
* @throws DataAccessLayerException This can occur due to errors connecting to database, * @throws DataAccessLayerException This can occur due to errors connecting to database,
* executing SQL query and retrieving data. * executing SQL query and retrieving data.
@ -202,8 +205,10 @@ public interface GadgetDataService {
* @param startIndex Starting index of the data set to be retrieved. * @param startIndex Starting index of the data set to be retrieved.
* @param resultCount Total count of the result set retrieved. * @param resultCount Total count of the result set retrieved.
* @return An object of type PaginationResult. * @return An object of type PaginationResult.
* @throws InvalidParameterValueException This can occur if and only if potentialVulnerability value of filterSet * @throws InvalidParameterValueException This can occur if potentialVulnerability value of filterSet
* is set with some value other than "NON_COMPLIANT" or "UNMONITORED". * is set with some value other than "NON_COMPLIANT" or "UNMONITORED".
* This can also occur if startIndex or resultCount is set to values
* lesser than their minimums.
* @throws DataAccessLayerException This can occur due to errors connecting to database, * @throws DataAccessLayerException This can occur due to errors connecting to database,
* executing SQL query and retrieving data. * executing SQL query and retrieving data.
*/ */
@ -219,8 +224,11 @@ public interface GadgetDataService {
* this method would return total device count in the system * this method would return total device count in the system
* wrapped with in the defined return format. * wrapped with in the defined return format.
* @return A list of objects of type DetailedDeviceEntry. * @return A list of objects of type DetailedDeviceEntry.
* @throws InvalidParameterValueException This can occur if and only if potentialVulnerability value of filterSet * @throws InvalidParameterValueException This can occur if nonCompliantFeatureCode is set to null or empty.
* This can occur if potentialVulnerability value of filterSet
* is set with some value other than "NON_COMPLIANT" or "UNMONITORED". * is set with some value other than "NON_COMPLIANT" or "UNMONITORED".
* This can also occur if startIndex or resultCount is set to values
* lesser than their minimums.
* @throws DataAccessLayerException This can occur due to errors connecting to database, * @throws DataAccessLayerException This can occur due to errors connecting to database,
* executing SQL query and retrieving data. * executing SQL query and retrieving data.
*/ */