com.hds.hcpaw.fss.api.model

Class ShareInvitationCancelRequest

java.lang.Object

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

com.hds.hcpaw.fss.api.model.ShareInvitationCancelRequest

public abstract class ShareInvitationCancelRequest
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 ShareInvitationCancelRequest	create(FssApiVersion apiVersion, java.lang.String path, java.lang.String uniqueId, java.lang.String providerId) Returns a versioned ShareInvitationCancelRequest that is compatible with the specified apiVersion.
static java.lang.Class<? extends ShareInvitationCancelRequest>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the ShareInvitationCancelRequest that corresponds to the specified apiVersion.
java.lang.String	getPath() Returns the path of the shared folder to cancel the invitation to.
java.lang.String	getProviderId() Returns the providerId of the user whose invitation should be cancelled.
java.lang.String	getUniqueId() Returns the uniqueId of the user whose invitation should be cancelled.
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 ShareInvitationCancelRequest> getFssApiClass(FssApiVersion apiVersion)
                                                                              throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the ShareInvitationCancelRequest that corresponds to the specified apiVersion

Throws:

AwUnsupportedApiVersionException

create

public static ShareInvitationCancelRequest create(FssApiVersion apiVersion,
                                                  java.lang.String path,
                                                  java.lang.String uniqueId,
                                                  java.lang.String providerId)
                                           throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version to be supported by the ShareInvitationCancelRequest

path - Path of the shared folder to cancel the invite to.

uniqueId - The uniqueId of the user whose invitation should be cancelled.

providerId - The providerId of the user whose invitation should be cancelled.

Returns:

the constructed ShareInvitationCancelRequest

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 shared folder to cancel the invitation to.

Returns:

the path of the shared folder to cancel the invitation to.

getUniqueId

public java.lang.String getUniqueId()

Returns the uniqueId of the user whose invitation should be cancelled.

Returns:

the uniqueId of the user whose invitation should be cancelled.

getProviderId

public java.lang.String getProviderId()

Returns the providerId of the user whose invitation should be cancelled.

Returns:

the providerId of the user whose invitation should be cancelled.