oracle.cloud.mobile.location

Class LocationObjectQuery

java.lang.Object

oracle.cloud.mobile.location.LocationObjectQuery

Direct Known Subclasses:

LocationDeviceContainerQuery, LocationDeviceQuery

public abstract class LocationObjectQuery
extends java.lang.Object

A location object query can be configured to search for the various location objects (assets, devices, or places).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LocationObjectQuery.LocationObjectQueryFormatType Query format (long or short).
static class	LocationObjectQuery.LocationObjectQueryOrderByOrderType Order-by order (ascending or descending).

Field Summary

Fields

Modifier and Type	Field and Description
protected Location	mLocation
protected JSONObject	mProperties
protected java.lang.String	orderBy
protected LocationObjectQuery.LocationObjectQueryOrderByOrderType	orderByOrderType

Method Summary

Modifier and Type	Method and Description
void	addAttributes(java.util.Map<java.lang.String,java.lang.String> newAttributes) Adds the specified set of attributes to the query's attributes.
void	addID(int id) Adds the specified ID to the list of the IDs the query will search for.
void	addIDs(java.util.List<java.lang.Integer> ids) Adds the specified list of IDs to the query's IDs.
void	clearAttributes() Removes all the attribute values.
void	clearIDs() Removes all the IDs.
protected JSONObject	cloneProperties()
protected java.lang.String	createOrderByString()
protected void	execute(LocationObjectQueryRestCallback callback)
abstract void	execute(LocationObjectsQueryCallback callback) Asynchronously executes the query, invoking the specified completion handler block when finished.
JSONObject	getAttributes() Gets the user-defined attributes on which the location query will search.
java.lang.String	getDescription() Gets the location object's user-defined description on which the query's result will be filtered with a case-insensitive partial match of this string.
LocationObjectQuery.LocationObjectQueryFormatType	getFormat() Gets the format of the result returned by the query, which can be 'long' or 'short'.
protected abstract java.lang.String	getIDPropertyName()
java.util.List<java.lang.Integer>	getIDs() Gets a list of IDs that the query's result will be filtered to match with.
protected int	getIntProperty(java.lang.String key)
protected JSONArray	getJSONArrayProperty(java.lang.String key)
int	getLimit() Gets the maximum number of items to return.
java.lang.String	getName() Gets the location object's user-defined name on which the query's result will be filtered with a case-insensitive partial match of this string.
int	getOffset() Gets the zero-based index of the first item to return in the results.
protected java.lang.String	getOrderBy()
protected java.lang.String	getOrderByAttribute()
LocationObjectQuery.LocationObjectQueryOrderByOrderType	getOrderByOrder() Gets the order (ascending or descending) in which the query results will be sorted when returned.
JSONObject	getProperties() Gets the query's raw properties.
protected java.lang.String	getResourceDir()
java.lang.String	getSearch() Gets the search parameter on which the location query will search for either description or name.
protected java.lang.String	getStringProperty(java.lang.String key)
void	insertID(int id, int index) Inserts the specified ID at the specified index of the list of IDs that the query will search for.
void	removeAttribute(java.lang.String key) Removes the specified attribute's value.
void	removeID(int id) Removes the specified ID from the list of the IDs that the query will search for.
void	removeIDAtIndex(int index) Removes the ID at the specified index from the list of IDs that the query will search for.
protected void	removeProperty(java.lang.String key)
void	setAttribute(java.lang.String key, java.lang.Object value) Sets the specified attribute's value.
void	setAttributes(JSONObject attributes) Sets the user-defined attributes on which the location query will search.
void	setDescription(java.lang.String description) Sets the location object's description on which the query's result will be filtered.
void	setFormat(LocationObjectQuery.LocationObjectQueryFormatType format) Sets the format of the result returned by the query, which can be 'long' or 'short'.
void	setIDs(java.util.List<java.lang.Integer> ids) Sets the list of IDs that the query's result will be filtered to match with.
void	setLimit(int limit) Sets the maximum number of items to return.
void	setName(java.lang.String name) Sets the location object's name on which the query's result will be filtered.
void	setOffset(int offset) Gets the zero-based index of the first item to return in the results.
protected void	setOrderBy(java.lang.String orderBy)
void	setOrderByOrder(LocationObjectQuery.LocationObjectQueryOrderByOrderType orderByOrder) Gets the order (ascending or descending) in which the query results will be sorted when returned.
protected void	setProperty(java.lang.String key, java.lang.Object value)
void	setSearch(java.lang.String search) Sets the search parameter on which the location query will search for either description or name.

Methods inherited from class java.lang.Object

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

Field Detail

mLocation

protected Location mLocation

mProperties

protected JSONObject mProperties

orderBy

protected java.lang.String orderBy

orderByOrderType

protected LocationObjectQuery.LocationObjectQueryOrderByOrderType orderByOrderType

Method Detail

getProperties

public JSONObject getProperties()

Gets the query's raw properties.

Returns:

The query's raw properties as a JSONObject.

getName

public java.lang.String getName()

Gets the location object's user-defined name on which the query's result will be filtered with a case-insensitive partial match of this string.

Returns:

The name for the search as a string.

setName

public void setName(java.lang.String name)

Sets the location object's name on which the query's result will be filtered.

Parameters:

name - The name for search as a string.

getDescription

public java.lang.String getDescription()

Gets the location object's user-defined description on which the query's result will be filtered with a case-insensitive partial match of this string.

Returns:

The description for search as a string.

setDescription

public void setDescription(java.lang.String description)

Sets the location object's description on which the query's result will be filtered.

Parameters:

description - The description for search as a string.

getSearch

public java.lang.String getSearch()

Gets the search parameter on which the location query will search for either description or name.

Returns:

The search parameter as a string.

setSearch

public void setSearch(java.lang.String search)

Sets the search parameter on which the location query will search for either description or name.

Parameters:

search - The search parameter as a string.

getAttributes

public JSONObject getAttributes()

Gets the user-defined attributes on which the location query will search.

Returns:

The attributes as a JSONObject.

setAttributes

public void setAttributes(JSONObject attributes)

Sets the user-defined attributes on which the location query will search.

Parameters:

attributes - The attributes as a JSONObject.

setAttribute

public void setAttribute(java.lang.String key,
                         java.lang.Object value)

Sets the specified attribute's value.

Parameters:

key - The attribute's user-defined key.

value - The attribute's user-defined value.

removeAttribute

public void removeAttribute(java.lang.String key)

Removes the specified attribute's value.

Parameters:

key - The attribute's user-defined key.

addAttributes

public void addAttributes(java.util.Map<java.lang.String,java.lang.String> newAttributes)

Adds the specified set of attributes to the query's attributes.

Parameters:

newAttributes - The query's new set of attributes.

clearAttributes

public void clearAttributes()

Removes all the attribute values.

getIDs

public java.util.List<java.lang.Integer> getIDs()

Gets a list of IDs that the query's result will be filtered to match with.

Returns:

The list of IDs.

setIDs

public void setIDs(java.util.List<java.lang.Integer> ids)

Sets the list of IDs that the query's result will be filtered to match with.

Parameters:

ids - A list of IDs.

addIDs

public void addIDs(java.util.List<java.lang.Integer> ids)

Adds the specified list of IDs to the query's IDs.

Parameters:

ids - The set of IDs to be added to the query's current list of IDs.

addID

public void addID(int id)

Adds the specified ID to the list of the IDs the query will search for.

Parameters:

id - The ID to add to the query's list of IDs.

insertID

public void insertID(int id,
                     int index)

Inserts the specified ID at the specified index of the list of IDs that the query will search for.

Parameters:

id - The ID to add to the query's list of IDs.

index - The index at which to insert the new ID.

removeID

public void removeID(int id)

Removes the specified ID from the list of the IDs that the query will search for.

Parameters:

id - The ID to remove for the query's list of IDs.

removeIDAtIndex

public void removeIDAtIndex(int index)

Removes the ID at the specified index from the list of IDs that the query will search for.

Parameters:

index - The index of the ID to remove from the query's list of IDs.

clearIDs

public void clearIDs()

Removes all the IDs.

getFormat

public LocationObjectQuery.LocationObjectQueryFormatType getFormat()

Gets the format of the result returned by the query, which can be 'long' or 'short'.

Returns:

The format as a LocationObjectQueryFormatType enum.

setFormat

public void setFormat(LocationObjectQuery.LocationObjectQueryFormatType format)

Sets the format of the result returned by the query, which can be 'long' or 'short'.

Parameters:

format - The format as a LocationObjectQueryFormatType enum.

getOrderByOrder

public LocationObjectQuery.LocationObjectQueryOrderByOrderType getOrderByOrder()

Gets the order (ascending or descending) in which the query results will be sorted when returned.

Returns:

The order as a LocationObjectQueryOrderByOrderType enum.

setOrderByOrder

public void setOrderByOrder(LocationObjectQuery.LocationObjectQueryOrderByOrderType orderByOrder)

Gets the order (ascending or descending) in which the query results will be sorted when returned.

Parameters:

orderByOrder - The order as a LocationObjectQueryOrderByOrderType enum.

getOffset

public int getOffset()

Gets the zero-based index of the first item to return in the results. The default value is zero.

Returns:

The offset as an integer.

setOffset

public void setOffset(int offset)

Gets the zero-based index of the first item to return in the results.

Parameters:

offset - The offset as an integer.

getLimit

public int getLimit()

Gets the maximum number of items to return.

Returns:

The limit as an integer.

setLimit

public void setLimit(int limit)

Sets the maximum number of items to return. If the requested limit is greater than 100, then 100 is substituted.

Parameters:

limit - The limit as an integer.

execute

public abstract void execute(LocationObjectsQueryCallback callback)

Asynchronously executes the query, invoking the specified completion handler block when finished.

Parameters:

callback - The callback invoked when the request to the Location service is finished.

getIDPropertyName

protected abstract java.lang.String getIDPropertyName()

execute

protected void execute(LocationObjectQueryRestCallback callback)

createOrderByString

protected java.lang.String createOrderByString()

getOrderBy

protected java.lang.String getOrderBy()

getOrderByAttribute

protected java.lang.String getOrderByAttribute()

setOrderBy

protected void setOrderBy(java.lang.String orderBy)

getResourceDir

protected java.lang.String getResourceDir()

setProperty

protected void setProperty(java.lang.String key,
                           java.lang.Object value)

removeProperty

protected void removeProperty(java.lang.String key)

getStringProperty

protected java.lang.String getStringProperty(java.lang.String key)

getIntProperty

protected int getIntProperty(java.lang.String key)

getJSONArrayProperty

protected JSONArray getJSONArrayProperty(java.lang.String key)

cloneProperties

protected JSONObject cloneProperties()