com.hds.hcpaw.fss.api.model

Class LinkListRequest

java.lang.Object

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

com.hds.hcpaw.fss.api.model.LinkListRequest

public abstract class LinkListRequest
extends BaseFssApiResource

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LinkListRequest.LinkSortingCriterion

Field Summary

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

UTF_8

Method Summary

Modifier and Type	Method and Description
static LinkListRequest	create(FssApiVersion apiVersion, java.lang.String pageToken, java.lang.Integer pageSize, LinkListRequest.LinkSortingCriterion sortingCriterion, FolderListingRequest.SortingDirection sortingDirection, java.lang.String filter) Returns a versioned LinkListRequest that is compatible with the specified apiVersion.
java.lang.String	getFilter() Returns the item name filter to apply to the results.
static java.lang.Class<? extends LinkListRequest>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the LinkListRequest that corresponds to the specified apiVersion.
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.
LinkListRequest.LinkSortingCriterion	getSortingCriterion() Returns the criteria to order the results on (NAME, HAS_ACCESS_CODE, PUBLIC, EXPIRATION, PERMISSIONS).
FolderListingRequest.SortingDirection	getSortingDirection() Returns the direction to sort the results in (ascending or descending), depending on the sorting criteria.
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 LinkListRequest> getFssApiClass(FssApiVersion apiVersion)
                                                                 throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the LinkListRequest that corresponds to the specified apiVersion

Throws:

AwUnsupportedApiVersionException

create

public static LinkListRequest create(FssApiVersion apiVersion,
                                     java.lang.String pageToken,
                                     java.lang.Integer pageSize,
                                     LinkListRequest.LinkSortingCriterion sortingCriterion,
                                     FolderListingRequest.SortingDirection sortingDirection,
                                     java.lang.String filter)
                              throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version to be supported by the LinkListRequest

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

pageSize - Maximum number of entries to return

sortingCriterion - What criteria to order the results on (NAME, HAS_ACCESS_CODE, PUBLIC, EXPIRATION, PERMISSIONS). Defaults to NAME.

sortingDirection - Whether to sort the results in ascending or descending order, based on the ordering criteria.

Returns:

the constructed LinkListRequest

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 identifies the next requested page of results. If null, then the first or last page page of results should be returned, based on the sortingDirection. Otherwise, this value should be from the LinkListRequest 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:

LinkListRequest

getPageSize

public java.lang.Integer getPageSize()

Returns the maximum number of entries requested.

Returns:

the maximum number of entries requested

getSortingCriterion

public LinkListRequest.LinkSortingCriterion getSortingCriterion()

Returns the criteria to order the results on (NAME, HAS_ACCESS_CODE, PUBLIC, EXPIRATION, PERMISSIONS). Defaults to NAME.

Returns:

the criteria to order the results on (NAME, HAS_ACCESS_CODE, PUBLIC, EXPIRATION, PERMISSIONS). Defaults to NAME.

getSortingDirection

public FolderListingRequest.SortingDirection getSortingDirection()

Returns the direction to sort the results in (ascending or descending), depending on the sorting criteria.

Returns:

the direction to sort the results in (ascending or descending), depending on the sorting criteria.

getFilter

public java.lang.String getFilter()

Returns the item name filter to apply to the results. Only results that have an item name that is similar to the filter will be returned.

Returns:

the item name filter to apply to the results.