com.vmware.vcloud.sdk
Class RecordResult<T extends com.vmware.vcloud.api.rest.schema.QueryResultRecordType>

java.lang.Object
  com.vmware.vcloud.sdk.VcloudResource<com.vmware.vcloud.api.rest.schema.ContainerType>
      com.vmware.vcloud.sdk.Result<com.vmware.vcloud.api.rest.schema.QueryResultRecordsType>
          com.vmware.vcloud.sdk.RecordResult<T>

public class RecordResult<T extends com.vmware.vcloud.api.rest.schema.QueryResultRecordType>
extends Result<com.vmware.vcloud.api.rest.schema.QueryResultRecordsType>

This class represents the query results in the form of records.

Since:

API 1.5, SDK 1.5

Author:

Ecosystem Engineering

Method Summary

RecordResult<T>	getFirstPage() Returns the first page if any in the form of a RecordResult.
RecordResult	getIdRecordResult() If the current format is RecordResult format returns the result in the Id RecordResult format.
RecordResult<T>	getLastPage() Returns the last page if any in the form of a RecordResult.
RecordResult<T>	getNextPage() Returns the next page if any in the form of a RecordResult.
RecordResult<T>	getPreviousPage() Returns the previous page if any in the form of a RecordResult.
RecordResult	getRecordResult() If the current format is Id RecordResult format returns the result in the RecordResult format.
List<T>	getRecords() Returns a list of all the records
ReferenceResult	getReferenceResult() Returns the result in the ReferenceResult format
com.vmware.vcloud.api.rest.schema.QueryResultRecordsType	getResource() Returns the actual query result records as defined in the Vcloud schema.

Methods inherited from class com.vmware.vcloud.sdk.Result

getName, getPage, getPageSize, getTotal, hasFirstPage, hasLastPage, hasNextPage, hasPreviousPage

Methods inherited from class com.vmware.vcloud.sdk.VcloudResource

getReference

Methods inherited from class java.lang.Object

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

Method Detail

getResource

public com.vmware.vcloud.api.rest.schema.QueryResultRecordsType getResource()

Returns the actual query result records as defined in the Vcloud schema.

Overrides:

getResource in class VcloudResource<com.vmware.vcloud.api.rest.schema.ContainerType>

Returns:

QueryResultRecordsType

getRecords

public List<T> getRecords()

Returns a list of all the records

Returns:

List< ? extends QueryResultRecordType>

getFirstPage

public RecordResult<T> getFirstPage()
                                                                                             throws VCloudException

Returns the first page if any in the form of a RecordResult.

Returns:

RecordResult

Throws:

VCloudException

getPreviousPage

public RecordResult<T> getPreviousPage()
                                                                                                throws VCloudException

Returns the previous page if any in the form of a RecordResult.

Returns:

RecordResult

Throws:

VCloudException

getNextPage

public RecordResult<T> getNextPage()
                                                                                            throws VCloudException

Returns the next page if any in the form of a RecordResult.

Returns:

RecordResult

Throws:

VCloudException

getLastPage

public RecordResult<T> getLastPage()
                                                                                            throws VCloudException

Returns the last page if any in the form of a RecordResult.

Returns:

RecordResult

Throws:

VCloudException

getReferenceResult

public ReferenceResult getReferenceResult()
                                   throws VCloudException

Returns the result in the ReferenceResult format

Returns:

ReferenceResult

Throws:

VCloudException

getRecordResult

public RecordResult getRecordResult()
                             throws VCloudException

If the current format is Id RecordResult format returns the result in the RecordResult format.

Returns:

RecordResult

Throws:

VCloudException

getIdRecordResult

public RecordResult getIdRecordResult()
                               throws VCloudException

If the current format is RecordResult format returns the result in the Id RecordResult format.

Returns:

RecordResult

Throws:

VCloudException