com.hds.hcpaw.fss.api.model

Class LinkPathMetadataRequest

java.lang.Object

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

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

com.hds.hcpaw.fss.api.model.LinkPathMetadataRequest

public class LinkPathMetadataRequest
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 LinkPathMetadataRequest	create(FssApiVersion apiVersion, java.lang.String linkToken, java.lang.String itemName, java.lang.String accessCode, java.lang.String path)
static java.lang.Class<? extends LinkPathMetadataRequest>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the LinkPathMetadataRequest that corresponds to the specified apiVersion.
java.lang.String	getPath()

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

getAccessCode, getItemName, getLinkToken, validate

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

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the LinkFileReadRequest that corresponds to the specified apiVersion

Throws:

AwUnsupportedApiVersionException

create

public static LinkPathMetadataRequest create(FssApiVersion apiVersion,
                                             java.lang.String linkToken,
                                             java.lang.String itemName,
                                             java.lang.String accessCode,
                                             java.lang.String path)
                                      throws AwUnsupportedApiVersionException

Parameters:

apiVersion - API version to be supported by the LinkPathMetadataRequest

linkToken - The token associated with the link.

itemName - The name of the file or folder that the link points to.

accessCode - The access code of the link if needed.

path - Relative path to the entry from link

Returns:

Throws:

AwUnsupportedApiVersionException

getPath

public java.lang.String getPath()