com.hds.hcpaw.fss.api.model

Class LinkMetadataRequest

java.lang.Object

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

com.hds.hcpaw.fss.api.model.LinkMetadataRequest

public abstract class LinkMetadataRequest
extends BaseFssApiResource

Field Summary

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

UTF_8

Method Summary

Modifier and Type	Method and Description
static LinkMetadataRequest	create(FssApiVersion apiVersion, java.lang.String itemName, java.lang.String linkToken) Returns a versioned LinkMetadataRequest that is compatible with the specified apiVersion.
static java.lang.Class<? extends LinkMetadataRequest>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the LinkMetadataRequest that corresponds to the specified apiVersion.
java.lang.String	getItemName() Returns the name of the file or folder the link points to.
java.lang.String	getLinkToken() Returns the linkToken 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 LinkMetadataRequest> getFssApiClass(FssApiVersion apiVersion)
                                                                     throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the LinkMetadataRequest that corresponds to the specified apiVersion

Throws:

AwUnsupportedApiVersionException

create

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

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

Parameters:

apiVersion - API version to be supported by the LinkMetadataRequest

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

linkToken - The token associated with the link.

Returns:

the constructed LinkMetadataRequest

Throws:

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)

getItemName

public java.lang.String getItemName()

Returns the name of the file or folder the link points to.

Returns:

the name of the file or folder the link points to.

getLinkToken

public java.lang.String getLinkToken()

Returns the linkToken of the link.

Returns:

the linkToken of the link.