com.hds.hcpaw.fss.api.model

Class LinkBrowseSearchRequest

java.lang.Object

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

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

com.hds.hcpaw.fss.api.model.LinkBrowseSearchRequest

public abstract class LinkBrowseSearchRequest
extends LinkRequestBase

A request to search the contents of a shared link

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 LinkBrowseSearchRequest	create(FssApiVersion apiVersion, java.lang.String linkToken, java.lang.String itemName, java.lang.String accessCode, java.lang.String path, java.lang.String filter) Returns a versioned LinkBrowseSearchRequest that is compatible with the specified apiVersion.
java.lang.String	getFilter() Returns the search filter used to find entries.
static java.lang.Class<? extends LinkBrowseSearchRequest>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the LinkBrowseSearchRequest that corresponds to the specified apiVersion.
java.lang.String	getPath() Returns the path to browse relative to the link
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 LinkBrowseSearchRequest> getFssApiClass(FssApiVersion apiVersion)
                                                                         throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the LinkBrowseSearchRequest that corresponds to the specified apiVersion

Throws:

AwUnsupportedApiVersionException

create

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

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

Parameters:

apiVersion - API version to be supported by the LinkBrowseSearchRequest

linkToken - The token that uniquely identifies the link.

itemName - The item (file or folder) that the link points to.

accessCode - The access code of the link, if it has one.

path - The path relative to the link to search under.

filter - The filter to use for searching.

Returns:

the constructed LinkBrowseSearchRequest

Throws:

AwUnsupportedApiVersionException

validate

protected void validate(java.lang.String fieldName,
                        BaseFssApiResource parent)
                 throws AwJsonException

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)

getPath

public java.lang.String getPath()

Returns the path to browse relative to the link

Returns:

the path to browse relative to the link

getFilter

public java.lang.String getFilter()

Returns the search filter used to find entries.

Returns:

the search filter used to find entries.