com.hds.hcpaw.fss.api.model

Class LinkBrowseListing

java.lang.Object

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

com.hds.hcpaw.fss.api.model.LinkBrowseListing

public class LinkBrowseListing
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 LinkBrowseListing	create(FssApiVersion apiVersion, java.util.List<Entry> entries, LinkType linkType, java.lang.String pageToken) Returns a versioned LinkBrowseListing that is compatible with the specified apiVersion.
java.util.List<Entry>	getEntries()
static java.lang.Class<? extends LinkBrowseListing>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the LinkBrowseListing that corresponds to the specified apiVersion.
LinkType	getLinkType()
java.lang.String	getPageToken()
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

Method Detail

getFssApiClass

public static java.lang.Class<? extends LinkBrowseListing> getFssApiClass(FssApiVersion apiVersion)
                                                                   throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the LinkBrowseListing that corresponds to the specified apiVersion

Throws:

AwUnsupportedApiVersionException

create

public static LinkBrowseListing create(FssApiVersion apiVersion,
                                       java.util.List<Entry> entries,
                                       LinkType linkType,
                                       java.lang.String pageToken)
                                throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version to be supported by the LinkBrowseListing

entries - a list of Entries that represent a page of folder/file entries

linkType - The type of object the link points to

pageToken - Token used to get the next page of link browse listing results

Returns:

Throws:

AwUnsupportedApiVersionException

getEntries

public java.util.List<Entry> getEntries()

Returns:

the entries

getLinkType

public LinkType getLinkType()

Returns:

the linkType

getPageToken

public java.lang.String getPageToken()

Returns:

the pageToken

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)