com.vmware.vise.data.query

Class ResultSpec

java.lang.Object

com.vmware.vise.data.query.ResultSpec

All Implemented Interfaces:

java.lang.Cloneable

@data(base="Object")
public class ResultSpec
extends java.lang.Object
implements java.lang.Cloneable

Describes additional transformations/filters to be applied on the result set.

Field Summary

Fields

Modifier and Type	Field and Description
com.vmware.vise.data.query.FacetSpec[]	facets Specification of which facets to compute on the result (internal use only).
java.lang.Integer	maxResultCount The maximum number of results to retrieve.
java.lang.Integer	offset The offset into the result set.
OrderingCriteria	order The criteria specifying how the results should be ordered.

Constructor Summary

Constructors

Constructor and Description
ResultSpec()

Method Summary

Modifier and Type	Method and Description
ResultSpec	clone() Creates and returns a copy of this object.
boolean	equals(java.lang.Object obj)
int	hashCode()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

maxResultCount

@optional
public java.lang.Integer maxResultCount

The maximum number of results to retrieve. By default all results are retrieved.

offset

@optional
public java.lang.Integer offset

The offset into the result set. If the offset is N then items from N to N + maxResultCount - 1 will be returned. If maxResultCount is not specified then all results greater or equal to the offset will be returned. If no offset is specified value will default to 0.

order

@optional
public OrderingCriteria order

The criteria specifying how the results should be ordered.

facets

@optional
public com.vmware.vise.data.query.FacetSpec[] facets

Specification of which facets to compute on the result (internal use only).

Constructor Detail

ResultSpec

public ResultSpec()

Method Detail

clone

public ResultSpec clone()
                 throws java.lang.CloneNotSupportedException

Creates and returns a copy of this object.

Overrides:

clone in class java.lang.Object

Returns:

a copy of this object.

Throws:

java.lang.CloneNotSupportedException

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object