com.hds.hcpaw.fss.api.model

Class ShareSettingsUpdateRequest

java.lang.Object

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

com.hds.hcpaw.fss.api.model.ShareSettingsUpdateRequest

public abstract class ShareSettingsUpdateRequest
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 ShareSettingsUpdateRequest	create(FssApiVersion apiVersion, java.lang.String path, java.lang.Boolean sync) Returns a versioned ShareSettingsUpdateRequest that is compatible with the specified apiVersion.
static java.lang.Class<? extends ShareSettingsUpdateRequest>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the ShareSettingsUpdateRequest that corresponds to the specified apiVersion.
java.lang.String	getPath()
java.lang.Boolean	getSync()
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 ShareSettingsUpdateRequest> getFssApiClass(FssApiVersion apiVersion)
                                                                            throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the ShareSettingsUpdateRequest that corresponds to the specified apiVersion

Throws:

AwUnsupportedApiVersionException

create

public static ShareSettingsUpdateRequest create(FssApiVersion apiVersion,
                                                java.lang.String path,
                                                java.lang.Boolean sync)
                                         throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version to be supported by the ShareMemberListRequest

path - path of the shared folder

sync - whether or not to sync the folder after accepting it

Returns:

the constructed ShareSettingsUpdateRequest

Throws:

AwUnsupportedApiVersionException

getPath

public java.lang.String getPath()

Returns:

the path

getSync

public java.lang.Boolean getSync()

Returns:

the sync

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