com.hds.hcpaw.fss.api.model

Class OwnerInfo

java.lang.Object

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

com.hds.hcpaw.fss.api.model.OwnerInfo

public abstract class OwnerInfo
extends BaseFssApiResource

Holds information about an Owner.

Field Summary

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

UTF_8

Method Summary

Modifier and Type	Method and Description
static OwnerInfo	create(FssApiVersion apiVersion, java.lang.String username, java.lang.String displayName, java.lang.String userId) Returns a versioned OwnerInfo that is compatible with the specified apiVersion.
java.lang.String	getDisplayName() Returns the display name of the owner.
static java.lang.Class<? extends OwnerInfo>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the OwnerInfo that corresponds to the specified apiVersion.
java.lang.String	getUserId() Returns the ID of the owner.
java.lang.String	getUsername() Returns the owner's username.
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 OwnerInfo> getFssApiClass(FssApiVersion apiVersion)

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the OwnerInfo that corresponds to the specified apiVersion

create

public static OwnerInfo create(FssApiVersion apiVersion,
                               java.lang.String username,
                               java.lang.String displayName,
                               java.lang.String userId)
                        throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version to be supported by the OwnerInfo

username - username of the owner

displayName - display name of the owner

userId - the userId of the owner

Returns:

the constructed OwnerInfo

Throws:

AwUnsupportedApiVersionException

getUsername

public java.lang.String getUsername()

Returns the owner's username.

Returns:

the owner's username.

getDisplayName

public java.lang.String getDisplayName()

Returns the display name of the owner.

Returns:

the display name of the owner

getUserId

public java.lang.String getUserId()

Returns the ID of the owner.

Returns:

the ID of the owner.

validate

protected 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)