com.hds.hcpaw.fss.api.model

Class FolderListing

java.lang.Object

com.hds.hcpaw.fss.api.model.BaseFssApiResource

com.hds.hcpaw.fss.api.model.FolderListing

public class FolderListing
extends BaseFssApiResource

Represents a list of Entries in a folder, that are returned as single page of results. The list also contains a page token, which is used to get the next page of entries.

Field Summary

Fields inherited from class com.hds.hcpaw.fss.api.model.BaseFssApiResource

UTF_8

Method Summary

Modifier and Type	Method and Description
static FolderListing	create(FssApiVersion apiVersion, java.lang.String pageToken, java.util.List<Entry> entries) Returns a versioned FolderListing that is compatible with the specified apiVersion.
java.util.List<Entry>	getEntries() Returns a page of Entrys in the folder.
static java.lang.Class<? extends FolderListing>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the FolderListing that corresponds to the specified apiVersion.
java.lang.String	getPageToken() Returns the page token that was returned from the request.
void	validate(java.lang.String fieldName, BaseFssApiResource parent) Validates this object.

Methods inherited from class com.hds.hcpaw.fss.api.model.BaseFssApiResource

badValue, badValue, fromJson, toJson, toJson, toString, validate, validateFieldInRange, validateFieldInRange, validateFieldIsNull, validateFieldNotNull, validateLocale, validateOptionalField, validateOptionalFieldList, validateRequiredField, validateRequiredFieldList, writeToOutputStream

Methods inherited from class java.lang.Object

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

Method Detail

getFssApiClass

public static java.lang.Class<? extends FolderListing> getFssApiClass(FssApiVersion apiVersion)

Returns the Class of the FolderListing that corresponds to the specified apiVersion.

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the FolderListing that corresponds to the specified apiVersion

create

public static FolderListing create(FssApiVersion apiVersion,
                                   java.lang.String pageToken,
                                   java.util.List<Entry> entries)
                            throws AwUnsupportedApiVersionException

Returns a versioned FolderListing that is compatible with the specified apiVersion.

Parameters:

apiVersion - API version to be supported by the FolderListing

pageToken - token used to get the next page of folder listing results

entries - a list of Entries that represent a page of folder listing results

Returns:

the constructed FolderListing

Throws:

AwUnsupportedApiVersionException

validate

public void validate(java.lang.String fieldName,
                     BaseFssApiResource parent)
              throws AwJsonException

Validates this object.

Specified by:

validate in class BaseFssApiResource

Parameters:

fieldName - name of this object in the parent (containing) object. If this object is a top-level object (not contained within another object), then enter null for this parameter

parent - parent (containing) object that contains the object specified in the fieldName parameter. If this object is a top-level object (not contained within another object), then enter null for this parameter

Throws:

AwJsonException - if any validation errors occur

See Also:

BaseFssApiResource.validate(String, BaseFssApiResource)

getPageToken

public java.lang.String getPageToken()

Returns the page token that was returned from the request. This page token should be included in the next FolderListingRequest in order to retrieve the next page of the folder's contents. If this value is null, then there are no more pages; i.e. this is the last page.

Returns:

A page token to use in the next FolderListingRequest, or null if there are no more pages

See Also:

FolderListingRequest

getEntries

public java.util.List<Entry> getEntries()

Returns a page of Entrys in the folder.

Returns:

a page of Entrys in the folder