com.hds.hcpaw.fss.api.model

Class LinkBrowseRequest

java.lang.Object

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

com.hds.hcpaw.fss.api.model.LinkRequestBase

com.hds.hcpaw.fss.api.model.LinkBrowseRequest

public abstract class LinkBrowseRequest
extends LinkRequestBase

A request to browse the contents of a shared link

Field Summary

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

accessCode, itemName, linkToken

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

UTF_8

Method Summary

Modifier and Type	Method and Description
static LinkBrowseRequest	create(FssApiVersion apiVersion, java.lang.String linkToken, java.lang.String itemName, java.lang.String accessCode, java.lang.String path, java.lang.Integer pageSize, java.lang.String pageToken, FolderListingRequest.SortingCriterion sortingCriterion, FolderListingRequest.SortingDirection sortingDirection) Returns a versioned LinkBrowseRequest that is compatible with the specified apiVersion.
static java.lang.Class<? extends LinkBrowseRequest>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the LinkBrowseRequest that corresponds to the specified apiVersion.
java.lang.Integer	getPageSize() Returns the page size for this page of a link to browse
java.lang.String	getPageToken() Returns the pageToken for the link to browse
java.lang.String	getPath() Returns the path to browse relative to the link
FolderListingRequest.SortingCriterion	getSortingCriterion()
FolderListingRequest.SortingDirection	getSortingDirection()
protected void	validate(java.lang.String fieldName, BaseFssApiResource parent) Validates this object.

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

getAccessCode, getItemName, getLinkToken

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 LinkBrowseRequest> getFssApiClass(FssApiVersion apiVersion)
                                                                   throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the LinkBrowseRequest that corresponds to the specified apiVersion

Throws:

AwUnsupportedApiVersionException

create

public static LinkBrowseRequest create(FssApiVersion apiVersion,
                                       java.lang.String linkToken,
                                       java.lang.String itemName,
                                       java.lang.String accessCode,
                                       java.lang.String path,
                                       java.lang.Integer pageSize,
                                       java.lang.String pageToken,
                                       FolderListingRequest.SortingCriterion sortingCriterion,
                                       FolderListingRequest.SortingDirection sortingDirection)
                                throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version to be supported by the LinkBrowseRequest

path - The path relative to the link root to browse

pageToken - The pageToken for the link as supplied in a Link

Returns:

the constructed LinkBrowseRequest

Throws:

AwUnsupportedApiVersionException

validate

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

Validates this object.

Overrides:

validate in class LinkRequestBase

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 browse relative to the link

Returns:

the path to browse relative to the link

getPageToken

public java.lang.String getPageToken()

Returns the pageToken for the link to browse

Returns:

the pageToken for the link to browse

getPageSize

public java.lang.Integer getPageSize()

Returns the page size for this page of a link to browse

Returns:

the page size for this page of a link to browse

getSortingCriterion

public FolderListingRequest.SortingCriterion getSortingCriterion()

getSortingDirection

public FolderListingRequest.SortingDirection getSortingDirection()