com.hds.hcpaw.fss.api.model

Class LinkSettings

java.lang.Object

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

com.hds.hcpaw.fss.api.model.LinkSettings

public class LinkSettings
extends BaseFssApiResource

The link settings on the server.

Field Summary

Fields inherited from class com.hds.hcpaw.fss.api.model.BaseFssApiResource

UTF_8

Method Summary

Modifier and Type	Method and Description
static LinkSettings	create(FssApiVersion apiVersion, java.lang.Boolean readEnabled, java.lang.Boolean publicReadEnabled, java.lang.Boolean uploadEnabled, java.lang.Boolean publicUploadEnabled, java.lang.Boolean editEnabled, java.lang.Boolean sharingDefaultPublic, int defaultDaysToShare, int maxDaysToShare, java.lang.Boolean allowLinksWithoutExpiration, java.lang.Boolean requireAccessCodeOnAllLinks, java.lang.Boolean requireAccessCodeOnPublicLinks) Returns a versioned LinkSettings that is compatible with the specified apiVersion.
static java.lang.Class<? extends LinkSettings>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the LinkSettings that corresponds to the specified apiVersion.
int	getMaxSharingDays() Returns the maximum number of days a link can remain active.
int	getSharingDefaultDays() Returns the default number of days before a link expires.
java.lang.Boolean	isAccessCodeOnAllLinksRequired() Returns whether or not the server mandates that all links have access codes
java.lang.Boolean	isAccessCodeOnPublicLinksRequired() Returns whether or not the server mandates that public links have access codes
java.lang.Boolean	isAllowLinksWithoutExpiration() Returns whether links are allowed to be created without an expiration
java.lang.Boolean	isEditEnabled() Returns whether or not edit links are enabled on the server.
java.lang.Boolean	isPublicReadEnabled() Returns whether or not the server allows links to be shared publicly.
java.lang.Boolean	isPublicSharingEnabled() Returns whether or not the server allows links to be shared publicly.
java.lang.Boolean	isPublicUploadEnabled() Returns whether or not public upload links are enabled on the server.
java.lang.Boolean	isReadEnabled() Returns whether or not sharing is enabled on the server.
java.lang.Boolean	isSharingEnabled() Returns whether or not sharing is enabled on the server.
java.lang.Boolean	isSharingPublicByDefault() Returns whether or not the server is configured to share links publicly by default.
java.lang.Boolean	isUploadEnabled() Returns whether or not upload links are enabled on the server.
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 LinkSettings> getFssApiClass(FssApiVersion apiVersion)

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the LinkSettings that corresponds to the specified apiVersion

create

public static LinkSettings create(FssApiVersion apiVersion,
                                  java.lang.Boolean readEnabled,
                                  java.lang.Boolean publicReadEnabled,
                                  java.lang.Boolean uploadEnabled,
                                  java.lang.Boolean publicUploadEnabled,
                                  java.lang.Boolean editEnabled,
                                  java.lang.Boolean sharingDefaultPublic,
                                  int defaultDaysToShare,
                                  int maxDaysToShare,
                                  java.lang.Boolean allowLinksWithoutExpiration,
                                  java.lang.Boolean requireAccessCodeOnAllLinks,
                                  java.lang.Boolean requireAccessCodeOnPublicLinks)
                           throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version to be supported by the LinkSettings

readEnabled - whether sharing has been enabled

publicReadEnabled - whether public sharing has been enabled

uploadEnabled - whether upload links have been enabled

publicUploadEnabled - whether public upload links have been enabled

editEnabled - whether edit links for Microsoft Office files have been enabled

sharingDefaultPublic -

defaultDaysToShare -

maxDaysToShare -

allowLinksWithoutExpiration -

requireAccessCodeOnAllLinks -

requireAccessCodeOnPublicLinks -

Returns:

the constructed LinkSettings

Throws:

AwUnsupportedApiVersionException

isReadEnabled

public java.lang.Boolean isReadEnabled()

Returns whether or not sharing is enabled on the server.

Returns:

true if sharing is enabled on the server; false otherwise

isPublicReadEnabled

public java.lang.Boolean isPublicReadEnabled()

Returns whether or not the server allows links to be shared publicly. That is, whether or not the server allows links to be accessed without entering a username and password.

Returns:

true if links can be shared publicly; false otherwise.

isUploadEnabled

public java.lang.Boolean isUploadEnabled()

Returns whether or not upload links are enabled on the server.

Returns:

true if upload links are enabled on the server; false otherwise

isPublicUploadEnabled

public java.lang.Boolean isPublicUploadEnabled()

Returns whether or not public upload links are enabled on the server.

Returns:

true if public upload links are enabled on the server; false otherwise

isEditEnabled

public java.lang.Boolean isEditEnabled()

Returns whether or not edit links are enabled on the server.

Returns:

true if edit links are enabled on the server; false otherwise

isSharingPublicByDefault

public java.lang.Boolean isSharingPublicByDefault()

Returns whether or not the server is configured to share links publicly by default.

Returns:

true if the server shares links publicly by default; false otherwise

getSharingDefaultDays

public int getSharingDefaultDays()

Returns the default number of days before a link expires.

Returns:

he default number of days before a link expires

getMaxSharingDays

public int getMaxSharingDays()

Returns the maximum number of days a link can remain active.

Returns:

the maximum number of days a link can remain active

isAllowLinksWithoutExpiration

public java.lang.Boolean isAllowLinksWithoutExpiration()

Returns whether links are allowed to be created without an expiration

Returns:

whether links are allowed to be created without an expiration

isSharingEnabled

public java.lang.Boolean isSharingEnabled()

Returns whether or not sharing is enabled on the server.

Returns:

true if sharing is enabled on the server; false otherwise

isPublicSharingEnabled

public java.lang.Boolean isPublicSharingEnabled()

Returns whether or not the server allows links to be shared publicly. That is, whether or not the server allows links to be accessed without entering a username and password.

Returns:

true if links can be shared publicly; false otherwise.

isAccessCodeOnAllLinksRequired

public java.lang.Boolean isAccessCodeOnAllLinksRequired()

Returns whether or not the server mandates that all links have access codes

Returns:

true if all links must have an access code; false otherwise.

isAccessCodeOnPublicLinksRequired

public java.lang.Boolean isAccessCodeOnPublicLinksRequired()

Returns whether or not the server mandates that public links have access codes

Returns:

true if public links must have an access code; false otherwise.

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