com.hds.hcpaw.fss.api.model

Class ShareSyncMembershipRequest

java.lang.Object

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

com.hds.hcpaw.fss.api.model.ShareSyncMembershipRequest

public class ShareSyncMembershipRequest
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 ShareSyncMembershipRequest	create(FssApiVersion apiVersion, java.lang.String path, java.lang.Boolean increaseRole, java.lang.Boolean inviteDeclined) Returns a versioned ShareSyncMembershipRequest that is compatible with the specified apiVersion.
static java.lang.Class<? extends ShareSyncMembershipRequest>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the ShareSyncMembershipRequest that corresponds to the specified apiVersion.
java.lang.String	getPath() Returns the path of the share to sync membership.
java.lang.Boolean	isIncreaseRole() Returns whether the server should increase roles if applicable or not.
java.lang.Boolean	isInviteDeclined() Returns whether the server should invite users who had previously declined, left, cancelled, or been kicked out.
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 ShareSyncMembershipRequest> getFssApiClass(FssApiVersion apiVersion)
                                                                            throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the ShareSyncMembershipRequest that corresponds to the specified apiVersion

Throws:

AwUnsupportedApiVersionException

create

public static ShareSyncMembershipRequest create(FssApiVersion apiVersion,
                                                java.lang.String path,
                                                java.lang.Boolean increaseRole,
                                                java.lang.Boolean inviteDeclined)
                                         throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version to be supported by the ShareSyncMembershipRequest

path - path of the shared folder to sync membership

increaseRole - whether to increase the role of members of the share

inviteDeclined - whether to invite users who have previously declined, left, cancelled, or been kicked out

Returns:

the constructed FileCreateRequest

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 of the share to sync membership.

Returns:

the path of the share to sync membership

isIncreaseRole

public java.lang.Boolean isIncreaseRole()

Returns whether the server should increase roles if applicable or not.

Returns:

whether the server should increase roles if applicable or not

isInviteDeclined

public java.lang.Boolean isInviteDeclined()

Returns whether the server should invite users who had previously declined, left, cancelled, or been kicked out.

Returns:

whether the server should invite users who had previously declined, left, cancelled, or been kicked out