com.hds.hcpaw.fss.api.model

Class SharedFolderListing

java.lang.Object

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

com.hds.hcpaw.fss.api.model.SharedFolderListing

public class SharedFolderListing
extends BaseFssApiResource

Represents a list of shared folders 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 SharedFolderListing	create(FssApiVersion apiVersion, java.util.List<SharedFolder> sharedFolders) Returns a versioned SharedFolderListing that is compatible with the specified apiVersion.
static java.lang.Class<? extends SharedFolderListing>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the SharedFolderListing that corresponds to the specified apiVersion.
java.util.List<SharedFolder>	getSharedFolders() Returns a list of SharedFolders.
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 SharedFolderListing> getFssApiClass(FssApiVersion apiVersion)

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the SharedFolderListing that corresponds to the specified apiVersion

create

public static SharedFolderListing create(FssApiVersion apiVersion,
                                         java.util.List<SharedFolder> sharedFolders)
                                  throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version to be supported by the SharedFolderListing

sharedFolders - a list of shared folders

Returns:

the constructed SharedFolderListing

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)

getSharedFolders

public java.util.List<SharedFolder> getSharedFolders()

Returns a list of SharedFolders.

Returns:

a list of SharedFolders.