com.hds.hcpaw.fss.api.model

Class ShareMemberListRequest

java.lang.Object

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

com.hds.hcpaw.fss.api.model.ShareMemberListRequest

Direct Known Subclasses:

ShareMemberListRequest.V300, ShareMemberListRequest.V400

public abstract class ShareMemberListRequest
extends BaseFssApiResource

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ShareMemberListRequest.SortingCriterion
static class	ShareMemberListRequest.SortingDirection
static class	ShareMemberListRequest.V300
static class	ShareMemberListRequest.V400

Field Summary

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

UTF_8

Method Summary

Modifier and Type	Method and Description
static ShareMemberListRequest	create(FssApiVersion apiVersion, java.lang.String path, java.lang.String pageToken, java.lang.Integer pageSize, ShareMemberListRequest.SortingCriterion criterion, ShareMemberListRequest.SortingDirection direction) Returns a versioned ShareMemberListRequest that is compatible with the specified apiVersion.
static java.lang.Class<? extends ShareMemberListRequest>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the ShareMemberListRequest that corresponds to the specified apiVersion.
java.lang.Integer	getPageSize()
java.lang.String	getPageToken()
java.lang.String	getPath()
ShareMemberListRequest.SortingCriterion	getSortingCriterion()
ShareMemberListRequest.SortingDirection	getSortingDirection()
protected 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 ShareMemberListRequest> getFssApiClass(FssApiVersion apiVersion)
                                                                        throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the ShareMemberListRequest that corresponds to the specified apiVersion

Throws:

AwUnsupportedApiVersionException

create

public static ShareMemberListRequest create(FssApiVersion apiVersion,
                                            java.lang.String path,
                                            java.lang.String pageToken,
                                            java.lang.Integer pageSize,
                                            ShareMemberListRequest.SortingCriterion criterion,
                                            ShareMemberListRequest.SortingDirection direction)
                                     throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version to be supported by the ShareMemberListRequest

path - path to the shared folder to list members for

pageToken - the page token used for tracking multiple pages of members.

pageSize - the maximum number of members that should be returned in a page.

Returns:

the constructed ShareMemberListRequest

Throws:

AwUnsupportedApiVersionException

validate

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

Description copied from class: BaseFssApiResource

Validates this object. Implementers of this method should call the various validate methods in this class for the fields in the class. For example, if an implementing class has a required field called foo and an optional field called bar, then this method should call BaseFssApiResource.validateRequiredField(String, BaseFssApiResource, String) for foo, and BaseFssApiResource.validateOptionalField(String, BaseFssApiResource) for bar.

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

getPath

public java.lang.String getPath()

Returns:

the path to the share.

getPageToken

public java.lang.String getPageToken()

Returns:

the page token of the request.

getPageSize

public java.lang.Integer getPageSize()

Returns:

the page size of the request.

getSortingCriterion

public ShareMemberListRequest.SortingCriterion getSortingCriterion()

getSortingDirection

public ShareMemberListRequest.SortingDirection getSortingDirection()