com.vmware.vcloud.sdk
Class QueryParams<T extends QueryField>

java.lang.Object
  com.vmware.vcloud.sdk.QueryParams<T>

public class QueryParams<T extends QueryField>
extends Object

This class represents the Query Parameters.

Since:

API 1.5, SDK 1.5

Author:

Ecosystem Engineering

Constructor Summary

QueryParams()

Method Summary

void	addMetadataField(String metadataKey) Adds a metadata field/key.
void	addMetadataField(String metadataKey, MetadataDomain domain) Adds a metadata field/key along with the domain.
Set<T>	getFields() Returns the field names.
Filter	getFilter() Returns the filter.
Integer	getOffset() Returns the offset value.
Integer	getPage() Returns the page number.
Integer	getPageSize() Returns the page size.
LinkedHashMap<T,SortType>	getSortFields() Returns a linked hash map of sort fields.
void	setFields(Set<T> fields) Set the field names
void	setFilter(Filter filter) Set the filter
void	setOffset(Integer offset) Set the offset value.
void	setPage(Integer page) Set the page number for the query.
void	setPageSize(Integer pageSize) Set the page size for the query.
void	setSortFields(LinkedHashMap<T,SortType> sortFields) Set the linked hash map of sort fields and its sort type.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryParams

public QueryParams()

Method Detail

addMetadataField

public void addMetadataField(String metadataKey,
                             MetadataDomain domain)

Adds a metadata field/key along with the domain.

Since:

API 5.1, SDK 5.1

addMetadataField

public void addMetadataField(String metadataKey)

Adds a metadata field/key.

Since:

API 5.1, SDK 5.1

getOffset

public Integer getOffset()

Returns the offset value.

Returns:

Integer

setOffset

public void setOffset(Integer offset)

Set the offset value.

Parameters:

offset -

getFields

public Set<T> getFields()

Returns the field names.

Returns:

Set

setFields

public void setFields(Set<T> fields)

Set the field names

Parameters:

fields - Set

getFilter

public Filter getFilter()

Returns the filter.

Returns:

Filter

setFilter

public void setFilter(Filter filter)

Set the filter

Parameters:

filter - Filter

getSortFields

public LinkedHashMap<T,SortType> getSortFields()

Returns a linked hash map of sort fields.

Returns:

LinkedHashMap

setSortFields

public void setSortFields(LinkedHashMap<T,SortType> sortFields)

Set the linked hash map of sort fields and its sort type.

Parameters:

sortFields - LinkedHashMap

getPage

public Integer getPage()

Returns the page number.

Returns:

Integer

setPage

public void setPage(Integer page)

Set the page number for the query.

Parameters:

page - Integer

getPageSize

public Integer getPageSize()

Returns the page size.

Returns:

Integer

setPageSize

public void setPageSize(Integer pageSize)

Set the page size for the query.

Parameters:

pageSize - Integer