com.hds.hcpaw.fss.api.model

Class LinkListing

java.lang.Object

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

com.hds.hcpaw.fss.api.model.LinkListing

public class LinkListing
extends BaseFssApiResource

Represents a list of links created by the user.

Field Summary

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

UTF_8

Method Summary

Modifier and Type	Method and Description
static LinkListing	create(FssApiVersion apiVersion, java.util.List<Link> links, java.lang.String pageToken) Returns a versioned LinkListing that is compatible with the specified apiVersion.
static java.lang.Class<? extends LinkListing>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the LinkListing that corresponds to the specified apiVersion.
java.util.List<Link>	getLinks() Returns a list of Links.
java.lang.String	getPageToken() Returns the page token that identifies the next requested page of results.
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 LinkListing> getFssApiClass(FssApiVersion apiVersion)

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the LinkListing that corresponds to the specified apiVersion

create

public static LinkListing create(FssApiVersion apiVersion,
                                 java.util.List<Link> links,
                                 java.lang.String pageToken)
                          throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version to be supported by the LinkListing

links - a list of links

Returns:

the constructed LinkListing

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)

getLinks

public java.util.List<Link> getLinks()

Returns a list of Links.

Returns:

a list of Links.

getPageToken

public java.lang.String getPageToken()

Returns the page token that identifies the next requested page of results.

Returns:

the page token identifying the next requested page of results, or null if the first or last page of results is requested.

See Also:

LinkListRequest