com.hds.hcpaw.fss.api.model

Class LinkCopyToLocalRequest

java.lang.Object

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

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

com.hds.hcpaw.fss.api.model.LinkCopyToLocalRequest

public abstract class LinkCopyToLocalRequest
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 LinkCopyToLocalRequest	create(FssApiVersion apiVersion, java.lang.String linkToken, java.lang.String itemName, java.lang.String accessCode, java.util.List<java.lang.String> pathList, java.lang.String destinationPath) Returns a versioned LinkFolderCreateRequest that is compatible with the specified apiVersion.
java.lang.String	getDestinationPath()
static java.lang.Class<? extends LinkCopyToLocalRequest>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the LinkFolderCreateRequest that corresponds to the specified apiVersion.
java.util.List<java.lang.String>	getPathList()
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 LinkCopyToLocalRequest> getFssApiClass(FssApiVersion apiVersion)
                                                                        throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the LinkFolderCreateRequest that corresponds to the specified apiVersion

Throws:

AwUnsupportedApiVersionException

create

public static LinkCopyToLocalRequest create(FssApiVersion apiVersion,
                                            java.lang.String linkToken,
                                            java.lang.String itemName,
                                            java.lang.String accessCode,
                                            java.util.List<java.lang.String> pathList,
                                            java.lang.String destinationPath)
                                     throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version to be supported by the LinkFolderCreateRequest

linkToken - The token for the link

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

accessCode - Access code of the link

pathList - List of path to be copied

destinationPath - Destination path for files to be copied to

Returns:

the constructed LinkFolderCreateRequest

Throws:

AwUnsupportedApiVersionException

getPathList

public java.util.List<java.lang.String> getPathList()

Returns:

the pathList

getDestinationPath

public java.lang.String getDestinationPath()

Returns:

the destinationPath

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)