Device Retrieval

Syntax

PaginationResult<DeviceInfoVO> listDevices(DeviceSearchCriteriaVO searchCondition, Long skip, Long take, DeviceSortVO sortInfo) throws SUPAdminException;

Returns

If successful, returns an object of the specified type (can be null). If unsuccessful, returns SUPAdminException.

Examples

• Retrieval of locked devices – retrieves a list of locked devices (it returns up to five results sorted by Device ID):

  // List devices that have been locked. Return at most 5 devices, sorted
  // by "Device ID". 
  DeviceSearchCriteriaVO searchCondition = new DeviceSearchCriteriaVO();
  searchCondition.setLocked(true);
  DeviceSortVO sortInfo = new DeviceSortVO();
  sortInfo.setOrder(SORT_ORDER.ASCENDING);
  sortInfo.setSortField(DeviceSortVO.SortField.DEVICEID);
  PaginationResult<DeviceInfoVO> result = deviceUser.listDevices(
  		searchCondition, 0L, 5L, sortInfo);
  // Since you have total records count of the search condition, also you
  // can specify start index and return amount by
  // SUPDeviceUser#listDevices(DeviceSearchCriteriaVO, Long skip, Long take,
  // DeviceSortVO) method, you can implement pagination in your code.
  int totalRecords = result.getTotalAvailableRecords();
  
  // print out DeviceInfoVO
  for (DeviceInfoVO info : result.getItems()) {
  	System.out.println(info.getDeviceId());
  	System.out.println(info.getDevicePlatform());
  	System.out.println(info.getLogicId());
  	System.out.println(info.getDeviceType());
  	System.out.println(info.getLastConnected());
  	System.out.println(info.getMbsStatus());
  	System.out.println(info.getRbsStatus());
  	System.out.println(info.getRegisterTime());
  	// MBSPropertiesVO is additional info only for MBS devices.
  	MBSPropertiesVO mbsProperties = info.getMbsPropertiesVO();
  	if (mbsProperties != null) {
  		System.out.println(mbsProperties.getUserName());
  		System.out.println(mbsProperties.getActivationCodeExpireDate());
  		...
  	}
  }

Usage

For information on search fields and sort fields, see DeviceSearchCriteriaVO and DeviceSortVO in the Javadoc.