com.hds.hcpaw.fss.api.model

Class ShareAlert

java.lang.Object

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

com.hds.hcpaw.fss.api.model.ShareAlert

public abstract class ShareAlert
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 ShareAlert	create(FssApiVersion apiVersion, java.lang.String fsId, java.lang.String label, java.lang.String alert, TeamFolderInfo teamFolderInfo)
java.lang.String	getAlert()
java.lang.String	getFsId()
static java.lang.Class<? extends ShareAlert>	getFssApiClass(FssApiVersion apiVersion)
java.lang.String	getLabel()
TeamFolderInfo	getTeamFolderInfo()
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 ShareAlert> getFssApiClass(FssApiVersion apiVersion)
                                                            throws AwUnsupportedApiVersionException

Throws:

AwUnsupportedApiVersionException

create

public static ShareAlert create(FssApiVersion apiVersion,
                                java.lang.String fsId,
                                java.lang.String label,
                                java.lang.String alert,
                                TeamFolderInfo teamFolderInfo)
                         throws AwUnsupportedApiVersionException

Throws:

AwUnsupportedApiVersionException

getFsId

public java.lang.String getFsId()

Returns:

the fsId

getLabel

public java.lang.String getLabel()

Returns:

the label

getAlert

public java.lang.String getAlert()

Returns:

the alert

getTeamFolderInfo

public TeamFolderInfo getTeamFolderInfo()

Returns:

any relevant team folder info

validate

protected void validate(java.lang.String fieldName,
                        BaseFssApiResource parent)
                 throws AwJsonException

Description copied from class: BaseFssApiResource

Validates this object. Implementers of this method should call the various validate methods in this class for the fields in the class. For example, if an implementing class has a required field called foo and an optional field called bar, then this method should call BaseFssApiResource.validateRequiredField(String, BaseFssApiResource, String) for foo, and BaseFssApiResource.validateOptionalField(String, BaseFssApiResource) for bar.

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