com.licensespring.management

Class DeviceVariablesService

java.lang.Object

com.licensespring.management.DeviceVariablesService

public class DeviceVariablesService
extends Object

DeviceVariablesService class is used for searching, getting, creating, updating and deleting device variables.

Method Summary

Modifier and Type	Method and Description
BackOfficeDeviceVariable	create(CreateDeviceVariableRequest request) Creates a new device variable.
void	delete(Long id) Deletes the device variable.
BackOfficeDeviceVariable	get(Long id) Retrieves device variable data.
List<BackOfficeDeviceVariable>	paginate(SearchDeviceVariablesRequest request) Goes through all pages of the search device variables response and returns a list with all possible device variables that satisfy the request.
SearchResult<BackOfficeDeviceVariable>	search(SearchDeviceVariablesRequest request) Searches through all device variables and returns the search result which contains all device variables that satisfy the request queries.
BackOfficeDeviceVariable	update(Long id, UpdateDeviceVariableRequest request) Updates the device variable.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

search

public SearchResult<BackOfficeDeviceVariable> search(SearchDeviceVariablesRequest request)
                                              throws com.licensespring.model.exceptions.LicenseSpringException

Searches through all device variables and returns the search result which contains all device variables that satisfy the request queries.

Parameters:

request - search request that can be made using the builder method

Returns:

paginated result that contains list of device variables

Throws:

com.licensespring.model.exceptions.LicenseSpringException

get

public BackOfficeDeviceVariable get(Long id)
                             throws com.licensespring.model.exceptions.LicenseSpringException

Retrieves device variable data.

Parameters:

id - id of the device variable that needs to be fetched

Returns:

the BackOfficeDeviceVariable object that contains detailed information about the device variable

Throws:

com.licensespring.model.exceptions.LicenseSpringException

create

public BackOfficeDeviceVariable create(CreateDeviceVariableRequest request)
                                throws com.licensespring.model.exceptions.LicenseSpringException

Creates a new device variable.

Parameters:

request - use builder for constructing

Returns:

the BackOfficeDeviceVariable object that contains detailed information about the device variable

Throws:

com.licensespring.model.exceptions.LicenseSpringException

update

public BackOfficeDeviceVariable update(Long id,
                                       UpdateDeviceVariableRequest request)
                                throws com.licensespring.model.exceptions.LicenseSpringException

Updates the device variable.

Parameters:

id - id of the device variable that needs an update

request - use builder for constructing, fill only fields that you want to update

Returns:

the BackOfficeDeviceVariable object that contains detailed information about the updated device variable

Throws:

com.licensespring.model.exceptions.LicenseSpringException

delete

public void delete(Long id)
            throws com.licensespring.model.exceptions.LicenseSpringException

Deletes the device variable.

Parameters:

id - id of the device variable that needs to be deleted

Throws:

com.licensespring.model.exceptions.LicenseSpringException

paginate

public List<BackOfficeDeviceVariable> paginate(SearchDeviceVariablesRequest request)
                                        throws com.licensespring.model.exceptions.LicenseSpringException

Goes through all pages of the search device variables response and returns a list with all possible device variables that satisfy the request. Makes multiple requests to the server until all results have been found. Use search(SearchDeviceVariablesRequest) in order to get results per page.

Parameters:

request - can be made with builder, contains query fields

Returns:

list of all device variables that satisfy the request

Throws:

com.licensespring.model.exceptions.LicenseSpringException