com.hds.hcpaw.fss.api.model

Class ProviderListing

java.lang.Object

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

com.hds.hcpaw.fss.api.model.ProviderListing

public class ProviderListing
extends BaseFssApiResource

Represents a list of providers configured on the system.

Field Summary

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

UTF_8

Method Summary

Modifier and Type	Method and Description
static ProviderListing	create(FssApiVersion apiVersion, java.util.List<Provider> providers, boolean autocompleteEnabled) Returns a versioned ProviderListing that is compatible with the specified apiVersion.
static java.lang.Class<? extends ProviderListing>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the ProviderListing that corresponds to the specified apiVersion.
java.util.List<Provider>	getProviders() Returns a list of Providers.
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 ProviderListing> getFssApiClass(FssApiVersion apiVersion)

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the ProviderListing that corresponds to the specified apiVersion

create

public static ProviderListing create(FssApiVersion apiVersion,
                                     java.util.List<Provider> providers,
                                     boolean autocompleteEnabled)
                              throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version to be supported by the ProviderListing

providers - a list of providers

Returns:

the constructed ProviderListing

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)

getProviders

public java.util.List<Provider> getProviders()

Returns a list of Providers.

Returns:

a list of Providers.