com.hds.hcpaw.fss.api.model

Class LinkCreateRequest

java.lang.Object

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

com.hds.hcpaw.fss.api.model.LinkCreateRequest

public abstract class LinkCreateRequest
extends BaseFssApiResource

A request to create a link.

Field Summary

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

UTF_8

Method Summary

Modifier and Type	Method and Description
static LinkCreateRequest	create(FssApiVersion apiVersion, java.io.InputStreamReader reader) Constructs a LinkCreateRequest from the JSON string representation contained in reader.
static LinkCreateRequest	create(FssApiVersion apiVersion, java.lang.String path, java.lang.Integer expirationDays, java.lang.Boolean publicLink, boolean accessCode, java.util.Set<LinkPermission> permissions) Returns a versioned LinkCreateRequest that is compatible with the specified apiVersion.
static LinkCreateRequest	create(FssApiVersion apiVersion, java.lang.String path, java.lang.Integer expirationDays, java.lang.Boolean publicLink, boolean accessCode, java.util.Set<LinkPermission> permissions, java.lang.String uniqueId) Returns a versioned LinkCreateRequest that is compatible with the specified apiVersion.
java.lang.Integer	getExpirationDays() Returns the number of days until the link should expire.
static java.lang.Class<? extends LinkCreateRequest>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the LinkCreateRequest that corresponds to the specified apiVersion.
abstract java.lang.String	getObjectIdentifier() Returns the value used to identify the entry for which to create a link
java.lang.String	getPath() Returns the path to the entry for which to create a link.
java.util.Set<LinkPermission>	getPermissions() Returns the set of permissions for this link.
boolean	hasAccessCode() Returns whether or not to use an access code for this link.
abstract boolean	hasUniqueId() Returns whether the LinkCreateRequest has a uniqueId value
java.lang.Boolean	isPublicLink() Returns whether or not this link should be publicly accessible (accessible without a username and password).
void	validate(java.lang.String fieldName, BaseFssApiResource parent) Validates this object.
protected abstract void	validateObjectIdentifierToLink(java.lang.String fieldName) Validates that the specified argument that is used as the object identifier for creating a link is not null

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 LinkCreateRequest> getFssApiClass(FssApiVersion apiVersion)
                                                                   throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the LinkCreateRequest that corresponds to the specified apiVersion

Throws:

AwUnsupportedApiVersionException

create

public static LinkCreateRequest create(FssApiVersion apiVersion,
                                       java.lang.String path,
                                       java.lang.Integer expirationDays,
                                       java.lang.Boolean publicLink,
                                       boolean accessCode,
                                       java.util.Set<LinkPermission> permissions)
                                throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version to be supported by the LinkCreateRequest

path - path to the file or folder

expirationDays - optionally, the number of days that the link remains active. If null, then the default number of days from the server will be used

publicLink - optionally, whether the link is publicly accessible. If null, then the server default will be used

accessCode - whether to protect the link with an access code

permissions - the permissions for this link (read, write)

Returns:

the constructed LinkCreateRequest

Throws:

AwUnsupportedApiVersionException

create

public static LinkCreateRequest create(FssApiVersion apiVersion,
                                       java.lang.String path,
                                       java.lang.Integer expirationDays,
                                       java.lang.Boolean publicLink,
                                       boolean accessCode,
                                       java.util.Set<LinkPermission> permissions,
                                       java.lang.String uniqueId)
                                throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version to be supported by the LinkCreateRequest

expirationDays - optionally, the number of days that the link remains active. If null, then the default number of days from the server will be used

publicLink - optionally, whether the link is publicly accessible. If null, then the server default will be used

accessCode - whether to protect the link with an access code

permissions - the permissions for this link (read, write)

uniqueId - uniqueId to the file or folder

Returns:

the constructed LinkCreateRequest

Throws:

AwUnsupportedApiVersionException

create

public static LinkCreateRequest create(FssApiVersion apiVersion,
                                       java.io.InputStreamReader reader)
                                throws AwJsonException,
                                       AwUnsupportedApiVersionException

Constructs a LinkCreateRequest from the JSON string representation contained in reader.

Parameters:

apiVersion - API version of the object to be read from reader

reader - contains the JSON representation of a DeletePathRequest

Returns:

the constructed LinkGetRequest

Throws:

AwJsonException

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)

validateObjectIdentifierToLink

protected abstract void validateObjectIdentifierToLink(java.lang.String fieldName)
                                                throws AwJsonException

Validates that the specified argument that is used as the object identifier for creating a link is not null

Parameters:

fieldName -

Throws:

AwJsonException

getPath

public java.lang.String getPath()

Returns the path to the entry for which to create a link.

Returns:

the path to the entry for which to create a link

getExpirationDays

public java.lang.Integer getExpirationDays()

Returns the number of days until the link should expire.

Returns:

the number of days until the link should expire

isPublicLink

public java.lang.Boolean isPublicLink()

Returns whether or not this link should be publicly accessible (accessible without a username and password).

Returns:

whether or not this link should be publicly accessible (accessible without a username and password)

hasAccessCode

public boolean hasAccessCode()

Returns whether or not to use an access code for this link.

Returns:

whether or not to use an access code for this link

getPermissions

public java.util.Set<LinkPermission> getPermissions()

Returns the set of permissions for this link.

Returns:

the set of permissions for this link

getObjectIdentifier

public abstract java.lang.String getObjectIdentifier()

Returns the value used to identify the entry for which to create a link

Returns:

hasUniqueId

public abstract boolean hasUniqueId()

Returns whether the LinkCreateRequest has a uniqueId value

Returns: