com.hds.hcpaw.fss.api.model

Class EntrySharingInfo

java.lang.Object

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

com.hds.hcpaw.fss.api.model.EntrySharingInfo

public class EntrySharingInfo
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 EntrySharingInfo	create(FssApiVersion apiVersion, java.lang.Boolean canUserManage, java.lang.Boolean isMountPoint, FilesystemType type, java.lang.String label, TeamFolderInfo teamFolderInfo, java.lang.Boolean sync, TeamFolderInfo teamFolderRequest, java.lang.Boolean isLastTeamFolderManager, java.lang.Long retentionTime, java.lang.String retentionPolicy) Returns a versioned EntrySharingInfo that is compatible with the specified apiVersion.
boolean	equals(java.lang.Object o)
java.lang.Boolean	getCanUserManage() Returns whether or not the user can manage the entry.
static java.lang.Class<? extends EntrySharingInfo>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the EntrySharingInfo that corresponds to the specified apiVersion.
java.lang.Boolean	getIsLastTeamFolderManager() Returns whether or not the user is the last manager of the team folder.
java.lang.Boolean	getIsMountPoint() Returns whether or not the entry is a mount point.
java.lang.String	getLabel() Returns the label of the entry.
java.lang.String	getRetentionPolicy() Returns the type of retention policy of this filesystem
java.lang.Long	getRetentionTime() Returns the retention time of this filesystem
java.lang.Boolean	getSync() Returns whether filesystem is a syncing or non-syncing share
TeamFolderInfo	getTeamFolderInfo() Returns any team folder-related information (contact, quota), if applicable.
TeamFolderInfo	getTeamFolderRequest() Returns any team folder request related information (contact, quota), if applicable.
FilesystemType	getType() Returns the filesystem type of the entry.
int	hashCode()
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, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getFssApiClass

public static java.lang.Class<? extends EntrySharingInfo> getFssApiClass(FssApiVersion apiVersion)
                                                                  throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the EntrySharingInfo that corresponds to the specified apiVersion

Throws:

AwUnsupportedApiVersionException

create

public static EntrySharingInfo create(FssApiVersion apiVersion,
                                      java.lang.Boolean canUserManage,
                                      java.lang.Boolean isMountPoint,
                                      FilesystemType type,
                                      java.lang.String label,
                                      TeamFolderInfo teamFolderInfo,
                                      java.lang.Boolean sync,
                                      TeamFolderInfo teamFolderRequest,
                                      java.lang.Boolean isLastTeamFolderManager,
                                      java.lang.Long retentionTime,
                                      java.lang.String retentionPolicy)
                               throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version to be supported by the EntrySharingInfo

canUserManage - Whether or not the user is the owner of the entry.

isMountPoint - Whether or not the entry is a mount point.

sync - Whether or not the entry is syncing or under a syncing mountpoint.

type - The filesystem type of the entry

label - The label of the share.

teamFolderInfo - Team folder information related to the share, if applicable.

teamFolderRequest - Team folder request information related to the share, if applicable.

isLastTeamFolderManager - Whether or not the requesting user is the last manager of the team folder.

Returns:

the constructed EntrySharingInfo

Throws:

AwUnsupportedApiVersionException

getCanUserManage

public java.lang.Boolean getCanUserManage()

Returns whether or not the user can manage the entry.

Returns:

whether or not the user can manage the entry.

getTeamFolderInfo

public TeamFolderInfo getTeamFolderInfo()

Returns any team folder-related information (contact, quota), if applicable.

Returns:

any team folder-related information (contact, quota), if applicable.

getIsMountPoint

public java.lang.Boolean getIsMountPoint()

Returns whether or not the entry is a mount point.

Returns:

whether or not the entry is a mount point.

getType

public FilesystemType getType()

Returns the filesystem type of the entry.

Returns:

the filesystem type of the entry.

getLabel

public java.lang.String getLabel()

Returns the label of the entry.

Returns:

the label of the entry.

getTeamFolderRequest

public TeamFolderInfo getTeamFolderRequest()

Returns any team folder request related information (contact, quota), if applicable.

Returns:

any team folder request related information (contact, quota), if applicable.

getIsLastTeamFolderManager

public java.lang.Boolean getIsLastTeamFolderManager()

Returns whether or not the user is the last manager of the team folder.

Returns:

whether or not the user is the last manager of the team folder.

getSync

public java.lang.Boolean getSync()

Returns whether filesystem is a syncing or non-syncing share

Returns:

whether filesystem is a syncing or non-syncing share

getRetentionTime

public java.lang.Long getRetentionTime()

Returns the retention time of this filesystem

Returns:

the retention time of this filesystem

getRetentionPolicy

public java.lang.String getRetentionPolicy()

Returns the type of retention policy of this filesystem

Returns:

the type of retention policy of this filesystem

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

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object