com.hds.hcpaw.fss.api.model

Class FileHistoryListingRequest

java.lang.Object

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

com.hds.hcpaw.fss.api.model.FileHistoryListingRequest

public abstract class FileHistoryListingRequest
extends BaseFssApiResource

Field Summary

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

UTF_8

Method Summary

Modifier and Type	Method and Description
static FileHistoryListingRequest	create(FssApiVersion apiVersion, java.lang.String path, java.lang.Boolean showPrivate, java.lang.String pageToken, java.lang.Integer pageSize, PageAction pageAction) Returns a versioned FileListVersionRequest that is compatible with the specified apiVersion.
static java.lang.Class<? extends FileHistoryListingRequest>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the FileVersionListRequest that corresponds to the specified apiVersion.
PageAction	getPageAction() Returns the requested user action
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 to the file for which to return the version list.
java.lang.Boolean	getShowPrivate() Returns true if the request is for private history, false for shared history
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 FileHistoryListingRequest> getFssApiClass(FssApiVersion apiVersion)
                                                                           throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the FileListVersionRequest that corresponds to the specified apiVersion

Throws:

AwUnsupportedApiVersionException

create

public static FileHistoryListingRequest create(FssApiVersion apiVersion,
                                               java.lang.String path,
                                               java.lang.Boolean showPrivate,
                                               java.lang.String pageToken,
                                               java.lang.Integer pageSize,
                                               PageAction pageAction)
                                        throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version to be supported by the FileListVersionRequest

path - Path to the file

showPrivate - If true, show private activity, else shared

pageToken - Token returned in last call to this API, or null

pageSize - Maximum number of entries to return

pageAction - Action to perform for this request (first, last, next, prev)

Returns:

the constructed FileListVersionRequest

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)

getPath

public java.lang.String getPath()

Returns the path to the file for which to return the version list.

Returns:

the path to the file for which to return the version list

getShowPrivate

public java.lang.Boolean getShowPrivate()

Returns true if the request is for private history, false for shared history

Returns:

true if the request is for private history, false otherwise

getPageToken

public java.lang.String getPageToken()

Returns the page token that identifies the next requested page of results. If null, then the first or last page page of results should be returned, based on the pageAction. Otherwise, this value should be from the FileVersionListing that was returned from the previous request.

Returns:

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

See Also:

FileVersionListing

getPageSize

public java.lang.Integer getPageSize()

Returns the maximum number of entries requested.

Returns:

the maximum number of entries requested

getPageAction

public PageAction getPageAction()

Returns the requested user action

Returns:

the requested user action