com.hds.hcpaw.fss.api.model

Class FolderListingRequest

java.lang.Object

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

com.hds.hcpaw.fss.api.model.FolderListingRequest

public abstract class FolderListingRequest
extends BaseFssApiResource

A request to list the contents of a folder.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FolderListingRequest.SortingCriterion
static class	FolderListingRequest.SortingDirection

Field Summary

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

UTF_8

Method Summary

Modifier and Type	Method and Description
static FolderListingRequest	create(FssApiVersion apiVersion, java.io.InputStreamReader reader) Constructs a FolderListingRequest from the JSON string representation contained in the specified reader.
static FolderListingRequest	create(FssApiVersion apiVersion, java.lang.String path, java.lang.String pageToken, java.lang.Integer pageSize, java.lang.Long viewAtTime, java.lang.Boolean includeDeleted, FolderListingRequest.SortingCriterion sortingCriterion, FolderListingRequest.SortingDirection sortingDirection) Returns a versioned FolderListingRequest that is compatible with the specified apiVersion.
static java.lang.Class<? extends FolderListingRequest>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the FolderListingRequest that corresponds to the specified apiVersion.
java.lang.Boolean	getIncludeDeleted() Returns whether to include deleted items in the response.
java.lang.Integer	getPageSize() Returns the maximum number of entries requested.
java.lang.String	getPageToken() Returns the page token that identifies the next requested page of results.
java.lang.String	getPath() Returns the path of the folder whose contents are being requested.
FolderListingRequest.SortingCriterion	getSortingCriterion()
FolderListingRequest.SortingDirection	getSortingDirection()
java.lang.Long	getViewAtTime() Returns the time in milliseconds since 12:00:00 AM January 1, 1970, to view the folder.
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 FolderListingRequest> getFssApiClass(FssApiVersion apiVersion)
                                                                      throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the FolderListRequest that corresponds to the specified apiVersion

Throws:

AwUnsupportedApiVersionException

create

public static FolderListingRequest create(FssApiVersion apiVersion,
                                          java.lang.String path,
                                          java.lang.String pageToken,
                                          java.lang.Integer pageSize,
                                          java.lang.Long viewAtTime,
                                          java.lang.Boolean includeDeleted,
                                          FolderListingRequest.SortingCriterion sortingCriterion,
                                          FolderListingRequest.SortingDirection sortingDirection)
                                   throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version to be supported by the FolderListingRequest

path - path of the folder to list

pageToken - the token returned in the previous list of results

pageSize - the number of results that will be returned by a request. If there are additional folder listing results, you use the pageToken provided to request the next page of results

viewAtTime - the time at which to view the directory, in the number of milliseconds since 12:00:00 AM January 1, 1970. Mutually exclusive with includeDeleted

includeDeleted - whether to include deleted items in the output of the listing. Mutually exclusive with viewAtTime

Returns:

the constructed FolderListingRequest

Throws:

AwUnsupportedApiVersionException

create

public static FolderListingRequest create(FssApiVersion apiVersion,
                                          java.io.InputStreamReader reader)
                                   throws AwJsonException,
                                          AwUnsupportedApiVersionException

Constructs a FolderListingRequest from the JSON string representation contained in the specified reader.

Parameters:

apiVersion - API version of the object to be read

reader - contains the JSON string representation of a FolderListingRequest

Returns:

the constructed FolderListingRequest

Throws:

AwJsonException

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)

getPath

public java.lang.String getPath()

Returns the path of the folder whose contents are being requested.

Returns:

the path of the folder whose contents are being requested

getPageToken

public java.lang.String getPageToken()

Returns the page token that identifies the next requested page of results. If null, then the first page of results should be returned. Otherwise, this value should be from the FolderListing that was returned from the previous request.

Returns:

the page token identifying the next requested page of results, or null if the first page of results is requested.

See Also:

FolderListing

getPageSize

public java.lang.Integer getPageSize()

Returns the maximum number of entries requested.

Returns:

the maximum number of entries requested

getViewAtTime

public java.lang.Long getViewAtTime()

Returns the time in milliseconds since 12:00:00 AM January 1, 1970, to view the folder.

Returns:

the time in milliseconds since 12:00:00 AM January 1, 1970, to view the folder

getIncludeDeleted

public java.lang.Boolean getIncludeDeleted()

Returns whether to include deleted items in the response.

Returns:

whether to include deleted items in the response

getSortingCriterion

public FolderListingRequest.SortingCriterion getSortingCriterion()

getSortingDirection

public FolderListingRequest.SortingDirection getSortingDirection()