com.hds.hcpaw.fss.api.model

Class InviteResultEntry

java.lang.Object

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

com.hds.hcpaw.fss.api.model.InviteResultEntry

Direct Known Subclasses:

InviteResultEntry.V300

public abstract class InviteResultEntry
extends BaseFssApiResource

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InviteResultEntry.V300

Field Summary

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

UTF_8

Method Summary

Modifier and Type	Method and Description
static InviteResultEntry	create(FssApiVersion apiVersion, java.lang.String name, java.lang.String uniqueId, java.lang.String providerId, ShareRole role, java.lang.String errorMsg) Returns a versioned InviteResultEntry that is compatible with the specified apiVersion.
java.lang.String	getErrorMsg()
static java.lang.Class<? extends InviteResultEntry>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the InviteResultEntry that corresponds to the specified apiVersion.
java.lang.String	getName()
java.lang.String	getProviderId()
ShareRole	getRole()
java.lang.String	getUniqueId()
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 InviteResultEntry> getFssApiClass(FssApiVersion apiVersion)
                                                                   throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the InviteResultEntry that corresponds to the specified apiVersion

Throws:

AwUnsupportedApiVersionException

create

public static InviteResultEntry create(FssApiVersion apiVersion,
                                       java.lang.String name,
                                       java.lang.String uniqueId,
                                       java.lang.String providerId,
                                       ShareRole role,
                                       java.lang.String errorMsg)
                                throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version to be supported by the InviteResultEntry

name - name of the member

uniqueId - uniqueId of the member

providerId - providerId of the member

role - Role of the member

errorMsg - Error message if the invite is failed

Returns:

the constructed InviteResultEntry

Throws:

AwUnsupportedApiVersionException

getName

public java.lang.String getName()

Returns:

the name

getUniqueId

public java.lang.String getUniqueId()

Returns:

the uniqueId

getProviderId

public java.lang.String getProviderId()

Returns:

the providerId

getRole

public ShareRole getRole()

Returns:

the role

getErrorMsg

public java.lang.String getErrorMsg()

Returns:

the errorMsg

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