com.hds.hcpaw.fss.api.model

Class LinkFileUpdateRequest

java.lang.Object

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

com.hds.hcpaw.fss.api.model.LinkRequestBase

com.hds.hcpaw.fss.api.model.LinkFileUpdateRequest

public abstract class LinkFileUpdateRequest
extends LinkRequestBase

Field Summary

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

accessCode, itemName, linkToken

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

UTF_8

Method Summary

Modifier and Type	Method and Description
static LinkFileUpdateRequest	create(FssApiVersion apiVersion, java.lang.String linkToken, java.lang.String itemName, java.lang.String accessCode, java.lang.String path, java.lang.Long size, java.lang.String hash, java.lang.String etag, java.lang.Long atime, java.lang.Long mtime, java.io.InputStream input) Returns a versioned LinkFileUpdateRequest that is compatible with the specified apiVersion.
java.lang.Long	getATime() Returns the Last Accessed time of the file created.
java.lang.String	getEtag()
static java.lang.Class<? extends LinkFileUpdateRequest>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the LinkFileUpdateRequest that corresponds to the specified apiVersion.
java.lang.String	getHash()
java.io.InputStream	getInput()
java.lang.Long	getMTime() Returns the modified time of the file created.
java.lang.String	getPath()
java.lang.Long	getSize()
protected void	validate(java.lang.String fieldName, BaseFssApiResource parent) Validates this object.

Methods inherited from class com.hds.hcpaw.fss.api.model.LinkRequestBase

getAccessCode, getItemName, getLinkToken

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

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the LinkFileUpdateRequest that corresponds to the specified apiVersion

Throws:

AwUnsupportedApiVersionException

create

public static LinkFileUpdateRequest create(FssApiVersion apiVersion,
                                           java.lang.String linkToken,
                                           java.lang.String itemName,
                                           java.lang.String accessCode,
                                           java.lang.String path,
                                           java.lang.Long size,
                                           java.lang.String hash,
                                           java.lang.String etag,
                                           java.lang.Long atime,
                                           java.lang.Long mtime,
                                           java.io.InputStream input)
                                    throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version to be supported by the LinkFileUpdateRequest

linkToken - The token for the link

itemName - The name of the item pointed to by the link

accessCode - Access code of the link

path - Path of the file to be updated

size - Size of the content to update the file with

hash - Hash of the content to update the file with

etag - The etag of the current file at the specified path

input - InputStream containing content to update the file with

Returns:

the constructed LinkFileUpdateRequest

Throws:

AwUnsupportedApiVersionException

getPath

public java.lang.String getPath()

Returns:

the path

getSize

public java.lang.Long getSize()

Returns:

the size

getHash

public java.lang.String getHash()

Returns:

the hash

getEtag

public java.lang.String getEtag()

Returns:

the etag

getMTime

public java.lang.Long getMTime()

Returns the modified time of the file created.

Returns:

the modified time of the file created.

getATime

public java.lang.Long getATime()

Returns the Last Accessed time of the file created.

Returns:

the Last Accessed time of the file created.

getInput

public java.io.InputStream getInput()

Returns:

the input

validate

protected void validate(java.lang.String fieldName,
                        BaseFssApiResource parent)
                 throws AwJsonException

Description copied from class: LinkRequestBase

Validates this object.

Overrides:

validate in class LinkRequestBase

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)