com.hds.hcpaw.fss.api.model

Class LinkRequestBase

java.lang.Object

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

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

Direct Known Subclasses:

LinkBrowseRequest, LinkBrowseSearchRequest, LinkCheckAccessRequest, LinkCopyToLocalRequest, LinkFileCreateRequest, LinkFileReadRequest, LinkFileUpdateRequest, LinkMultiDownloadRequest, LinkPathMetadataRequest

public abstract class LinkRequestBase
extends BaseFssApiResource

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	accessCode
protected java.lang.String	itemName
protected java.lang.String	linkToken

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

UTF_8

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LinkRequestBase()
protected	LinkRequestBase(java.lang.String linkToken, java.lang.String itemName, java.lang.String accessCode)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAccessCode() Returns the access code given for this link
java.lang.String	getItemName() Returns the name of the item that is linked
java.lang.String	getLinkToken() Returns the linkToken for the link to search
protected 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

Field Detail

linkToken

protected java.lang.String linkToken

itemName

protected java.lang.String itemName

accessCode

protected java.lang.String accessCode

Constructor Detail

LinkRequestBase

protected LinkRequestBase()

LinkRequestBase

protected LinkRequestBase(java.lang.String linkToken,
                          java.lang.String itemName,
                          java.lang.String accessCode)

Method Detail

validate

protected 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)

getLinkToken

public java.lang.String getLinkToken()

Returns the linkToken for the link to search

Returns:

the linkToken for the link to search

getItemName

public java.lang.String getItemName()

Returns the name of the item that is linked

Returns:

then name of the item that is linked

getAccessCode

public java.lang.String getAccessCode()

Returns the access code given for this link

Returns:

the access code given for this link