com.vmware.vcloud.sdk
Class ReferenceResult

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.ReferencesType>
          com.vmware.vcloud.sdk.ReferenceResult

public class ReferenceResult
extends Result<com.vmware.vcloud.api.rest.schema.ReferencesType>

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

Since:

API 1.5, SDK 1.5

Author:

Ecosystem Engineering.

Method Summary

ReferenceResult	getFirstPage() Returns the first page if any in the form of a ReferenceResult.
RecordResult	getIdRecordResult() Returns the result in the Id RecordResult format
ReferenceResult	getLastPage() Returns the last page if any in the form of a ReferenceResult.
ReferenceResult	getNextPage() Returns the next page if any in the form of a ReferenceResult.
ReferenceResult	getPreviousPage() Returns the previous page if any in the form of a ReferenceResult.
RecordResult	getRecordResult() Returns the result in the RecordResult format
List<com.vmware.vcloud.api.rest.schema.ReferenceType>	getReferences() Returns a collection of the references.
com.vmware.vcloud.api.rest.schema.ReferencesType	getResource() Returns the actual references type 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.ReferencesType getResource()

Returns the actual references type as defined in the vcloud schema.

Overrides:

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

Returns:

ReferencesType

getReferences

public List<com.vmware.vcloud.api.rest.schema.ReferenceType> getReferences()

Returns a collection of the references.

Returns:

List<ReferenceType>

getFirstPage

public ReferenceResult getFirstPage()
                             throws VCloudException

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

Returns:

ReferenceResult

Throws:

VCloudException

getPreviousPage

public ReferenceResult getPreviousPage()
                                throws VCloudException

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

Returns:

ReferenceResult

Throws:

VCloudException

getNextPage

public ReferenceResult getNextPage()
                            throws VCloudException

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

Returns:

ReferenceResult

Throws:

VCloudException

getLastPage

public ReferenceResult getLastPage()
                            throws VCloudException

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

Returns:

ReferenceResult

Throws:

VCloudException

getRecordResult

public RecordResult getRecordResult()
                             throws VCloudException

Returns the result in the RecordResult format

Returns:

RecordResult

Throws:

VCloudException

getIdRecordResult

public RecordResult getIdRecordResult()
                               throws VCloudException

Returns the result in the Id RecordResult format

Returns:

RecordResult

Throws:

VCloudException