com.bosch.iot.dm.groovy.di

Class Selector

java.lang.Object

com.bosch.iot.dm.groovy.di.Selector

public class Selector
extends java.lang.Object

Represents device search criteria providing filtering and sorting utilities. Analog of com.bosch.iot.dm.devices.Filter

Constructor Summary

Constructors

Constructor and Description
Selector()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFields() Contains a comma separated list of fields to be included in the returned device objects.
java.lang.String	getNamespaces() A comma separated list of namespaces.
java.lang.String	getOptions() A comma separated list of sorting and paging options to be applied to the returned device set.
java.lang.String	getQuery() Return the device filtering criteria.
java.lang.String	toString()
Selector	withField(java.lang.String field) Specify field to be included in the returned devices objects.
Selector	withNamespace(java.lang.String namespace) Set namespace value.
Selector	withOption(java.lang.String option) Set option filed.
Selector	withQuery(java.lang.String query) Set the device filtering criteria.

Methods inherited from class java.lang.Object

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

Constructor Detail

Selector

public Selector()

Method Detail

withQuery

public Selector withQuery(java.lang.String query)

Set the device filtering criteria. Filter query is not mandatory. If it is not set all devices the logged in user is allowed to view will be returned.

Parameters:

query - value

Returns:

this

withNamespace

public Selector withNamespace(java.lang.String namespace)

Set namespace value.

Parameters:

namespace - value

Returns:

this

withOption

public Selector withOption(java.lang.String option)

Set option filed.

Parameters:

option - value

Returns:

this

withField

public Selector withField(java.lang.String field)

Specify field to be included in the returned devices objects.

Parameters:

field - value

Returns:

this

getQuery

public java.lang.String getQuery()

Return the device filtering criteria. Filter query is not mandatory. If it is not set, all devices which the logged in user is allowed to view will be returned.

Returns:

device filter query

getNamespaces

public java.lang.String getNamespaces()

A comma separated list of namespaces. This list is used to limit the query to devices in the given namespaces only.

Returns:

a list of namespaces to search devices in

getOptions

public java.lang.String getOptions()

A comma separated list of sorting and paging options to be applied to the returned device set.

Returns:

a sorting and paging options list

getFields

public java.lang.String getFields()

Contains a comma separated list of fields to be included in the returned device objects.

Returns:

fields to be included in the device objects

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object