com.hds.hcpaw.fss.api.model

Class LinkUpdateRequest

java.lang.Object

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

com.hds.hcpaw.fss.api.model.LinkUpdateRequest

public abstract class LinkUpdateRequest
extends BaseFssApiResource

A request to update 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 LinkUpdateRequest	create(FssApiVersion apiVersion, java.io.InputStreamReader reader) Constructs a LinkUpdateRequest from the JSON string representation contained in reader.
static LinkUpdateRequest	create(FssApiVersion apiVersion, java.lang.String url, java.lang.Boolean updateAccessCode, java.lang.Long expirationDate) Returns a versioned LinkUpdateRequest that is compatible with the specified apiVersion.
static LinkUpdateRequest	create(FssApiVersion apiVersion, java.lang.String path, java.lang.String url, java.lang.Boolean updateAccessCode, java.lang.Long expirationDate) Returns a versioned LinkUpdateRequest that is compatible with the specified apiVersion.
java.lang.Long	getExpirationDate() Returns the expirationDate
static java.lang.Class<? extends LinkUpdateRequest>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the LinkUpdateRequest that corresponds to the specified apiVersion.
java.lang.Boolean	getUpdateAccessCode() Returns whether or not to update an access code
java.lang.String	getUrl() Returns the url of the link.
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 LinkUpdateRequest> getFssApiClass(FssApiVersion apiVersion)
                                                                   throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the LinkUpdateRequest that corresponds to the specified apiVersion

Throws:

AwUnsupportedApiVersionException

create

public static LinkUpdateRequest create(FssApiVersion apiVersion,
                                       java.lang.String path,
                                       java.lang.String url,
                                       java.lang.Boolean updateAccessCode,
                                       java.lang.Long expirationDate)
                                throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version to be supported by the LinkUpdateRequest

path - path to the file or folder

url - url of the link

Returns:

the constructed LinkUpdateRequest

Throws:

AwUnsupportedApiVersionException

create

public static LinkUpdateRequest create(FssApiVersion apiVersion,
                                       java.lang.String url,
                                       java.lang.Boolean updateAccessCode,
                                       java.lang.Long expirationDate)
                                throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version to be supported by the LinkUpdateRequest

url - url of the link

updateAccessCode - Whether or not to update the access code

expirationDate - new expiration for the link

Returns:

Throws:

AwUnsupportedApiVersionException

create

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

Constructs a LinkUpdateRequest 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 LinkUpdateRequest

Returns:

the constructed LinkUpdateRequest

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)

getUrl

public java.lang.String getUrl()

Returns the url of the link.

Returns:

the url of the link.

getUpdateAccessCode

public java.lang.Boolean getUpdateAccessCode()

Returns whether or not to update an access code

Returns:

getExpirationDate

public java.lang.Long getExpirationDate()

Returns the expirationDate

Returns: