com.hds.hcpaw.fss.api.model

Class Client

java.lang.Object

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

com.hds.hcpaw.fss.api.model.Client

public abstract class Client
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 Client	create(FssApiVersion apiVersion, java.lang.String id, java.lang.String nickname, java.lang.String os, java.lang.String version, java.lang.Long lastAccess, java.lang.Boolean needsUpgrade, java.lang.Boolean inRecovery) Returns a versioned Client that is compatible with the specified apiVersion.
static java.lang.Class<? extends Client>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the Client that corresponds to the specified apiVersion.
java.lang.String	getId() Returns the client's id.
java.lang.Boolean	getInRecovery() Returns whether the client is in recovery
java.lang.Long	getLastAccess() Returns the client's last access in milliseconds since 00:00:00 january 1st 1970
java.lang.Boolean	getNeedsUpgrade() Returns whether the client needs an upgrade
java.lang.String	getNickname() Returns the client's nickname.
java.lang.String	getOs() Returns the client's os.
java.lang.String	getVersion() Returns the client's version.
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 Client> getFssApiClass(FssApiVersion apiVersion)

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the Client that corresponds to the specified apiVersion

create

public static Client create(FssApiVersion apiVersion,
                            java.lang.String id,
                            java.lang.String nickname,
                            java.lang.String os,
                            java.lang.String version,
                            java.lang.Long lastAccess,
                            java.lang.Boolean needsUpgrade,
                            java.lang.Boolean inRecovery)
                     throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version to be supported by the Client

id - id of the client

nickname - nickname of the client

os - os of the client

version - version of the client

lastAccess - number of milliseconds since 00:00:00 january 1 1970 that this client was last accessed

needsUpgrade - Whether client needs an upgrade

inRecovery - Whether client is in recovery

Returns:

the constructed client

Throws:

AwUnsupportedApiVersionException

getId

public java.lang.String getId()

Returns the client's id.

Returns:

the client's id

getNickname

public java.lang.String getNickname()

Returns the client's nickname.

Returns:

the client's nickname

getOs

public java.lang.String getOs()

Returns the client's os.

Returns:

the client's os

getVersion

public java.lang.String getVersion()

Returns the client's version.

Returns:

theclient's version

getLastAccess

public java.lang.Long getLastAccess()

Returns the client's last access in milliseconds since 00:00:00 january 1st 1970

getNeedsUpgrade

public java.lang.Boolean getNeedsUpgrade()

Returns whether the client needs an upgrade

Returns:

Whether the client needs an upgrade

getInRecovery

public java.lang.Boolean getInRecovery()

Returns whether the client is in recovery

Returns:

Whether the client is in recovery

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)