com.hds.hcpaw.fss.api.model

Class ShareAlertListing

java.lang.Object

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

com.hds.hcpaw.fss.api.model.ShareAlertListing

public class ShareAlertListing
extends BaseFssApiResource

Represents a list of share alerts 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 ShareAlertListing	create(FssApiVersion apiVersion, java.util.List<ShareAlert> alerts) Returns a versioned ShareAlertListing that is compatible with the specified apiVersion.
static java.lang.Class<? extends ShareAlertListing>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the ShareAlertListing that corresponds to the specified apiVersion.
java.util.List<ShareAlert>	getShareAlerts() Returns a list of ShareAlerts.
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 ShareAlertListing> getFssApiClass(FssApiVersion apiVersion)

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the ShareAlertListing that corresponds to the specified apiVersion

create

public static ShareAlertListing create(FssApiVersion apiVersion,
                                       java.util.List<ShareAlert> alerts)
                                throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version to be supported by the ShareAlertListing

alerts - a list of share alerts

Returns:

the constructed ShareAlertListing

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)

getShareAlerts

public java.util.List<ShareAlert> getShareAlerts()

Returns a list of ShareAlerts.

Returns:

a list of ShareAlerts.