com.hds.hcpaw.fss.api.model

Class PreserveMembershipRequest

java.lang.Object

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

com.hds.hcpaw.fss.api.model.PreserveMembershipRequest

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

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

The Class of the PreserveMembershipRequest that corresponds to the specified apiVersion.

Throws:

AwUnsupportedApiVersionException

create

public static PreserveMembershipRequest create(FssApiVersion apiVersion,
                                               java.lang.String path,
                                               boolean removeGroups)
                                        throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version to be supported by the PreserveMembershipRequest

path - The path to share to preserve membership for

removeGroups - whether to remove the dynamic groups being tracked

Returns:

The constructed PreserveMembershipRequest.

Throws:

AwUnsupportedApiVersionException

getPath

public java.lang.String getPath()

Returns:

the path to the share to preserve membership for

isRemoveGroups

public boolean isRemoveGroups()

Returns:

whether to remove groups

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