com.hds.hcpaw.fss.api.model

Class ShareInvitation

java.lang.Object

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

com.hds.hcpaw.fss.api.model.ShareInvitation

public abstract class ShareInvitation
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 ShareInvitation	create(FssApiVersion apiVersion, java.lang.String inviter, java.lang.String fsId, java.lang.Long size, ShareRole role, java.lang.String label, boolean individual, java.lang.String uniqueId) Returns a versioned ShareInvitation that is compatible with the specified apiVersion.
java.lang.String	getFilesystemId() Returns the filesystem id of the share
static java.lang.Class<? extends ShareInvitation>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the ShareInvitation that corresponds to the specified apiVersion.
java.lang.String	getInviter() Returns the inviter.
java.lang.String	getLabel() Returns the label of the share
ShareRole	getRole() Returns the role of the user in the share
java.lang.Long	getSize() Returns the size of the share
java.lang.String	getUniqueId() Returns unique id of shared/team folder
boolean	isIndividual() Returns true if it's an individual invitation otherwise false
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 ShareInvitation> getFssApiClass(FssApiVersion apiVersion)

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the ShareInvitation that corresponds to the specified apiVersion

create

public static ShareInvitation create(FssApiVersion apiVersion,
                                     java.lang.String inviter,
                                     java.lang.String fsId,
                                     java.lang.Long size,
                                     ShareRole role,
                                     java.lang.String label,
                                     boolean individual,
                                     java.lang.String uniqueId)
                              throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version to be supported by the ShareInvitation

inviter - the person who invited the user to the folder

fsId - the id of the folder that the user is invited to

size - the size of the folder, in bytes

role - the role the user will be added to the share with

individual - true if it is an individual invitation, false otherwise

uniqueId - the unique id of the folder that the user is invited to

Returns:

the constructed invitation

Throws:

AwUnsupportedApiVersionException

getInviter

public java.lang.String getInviter()

Returns the inviter.

Returns:

the inviter

getFilesystemId

public java.lang.String getFilesystemId()

Returns the filesystem id of the share

Returns:

the filesystem id of the share

getSize

public java.lang.Long getSize()

Returns the size of the share

Returns:

the size of the share

getRole

public ShareRole getRole()

Returns the role of the user in the share

Returns:

the role of the user in the share

getLabel

public java.lang.String getLabel()

Returns the label of the share

Returns:

the label of the share

isIndividual

public boolean isIndividual()

Returns true if it's an individual invitation otherwise false

Returns:

the label of the share

getUniqueId

public java.lang.String getUniqueId()

Returns unique id of shared/team folder

Returns:

unique id of shared/team folder

validate

protected 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)