com.hds.hcpaw.fss.api.model

Class GroupMember

java.lang.Object

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

com.hds.hcpaw.fss.api.model.GroupMember

public abstract class GroupMember
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 GroupMember	create(FssApiVersion apiVersion, java.lang.String name, java.lang.String displayName, java.lang.String domain) Returns a versioned GroupMember that is compatible with the specified apiVersion.
java.lang.String	getDisplayName()
java.lang.String	getDomain()
static java.lang.Class<? extends GroupMember>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the GroupMember that corresponds to the specified apiVersion.
java.lang.String	getName()
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 GroupMember> getFssApiClass(FssApiVersion apiVersion)
                                                             throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the GroupMember that corresponds to the specified apiVersion

Throws:

AwUnsupportedApiVersionException

create

public static GroupMember create(FssApiVersion apiVersion,
                                 java.lang.String name,
                                 java.lang.String displayName,
                                 java.lang.String domain)
                          throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version to be supported by the GroupMember

name - Name of the group member

displayName - Display name of the group member

domain - The name of the auth provider domain that the member belongs to.

Returns:

the constructed GroupMember

Throws:

AwUnsupportedApiVersionException

getName

public java.lang.String getName()

Returns:

the name

getDisplayName

public java.lang.String getDisplayName()

Returns:

the displayName

getDomain

public java.lang.String getDomain()

Returns:

the auth provider domain the user belongs to.

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