com.hds.hcpaw.fss.api.model

Class LinkMultiDownloadRequest

java.lang.Object

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

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

com.hds.hcpaw.fss.api.model.LinkMultiDownloadRequest

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

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the LinkMultiDownloadRequest that corresponds to the specified apiVersion

Throws:

AwUnsupportedApiVersionException

create

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

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

Parameters:

apiVersion - API version to be supported by the LinkMultiDownloadRequest

linkToken - The token for the link

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

accessCode - The access code for this link

pathList - List of path to be downloaded

Returns:

the constructed LinkMultiDownloadRequest

Throws:

AwUnsupportedApiVersionException

getPathList

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

Returns:

the pathList

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)