com.hds.hcpaw.fss.api.model

Class FolderSizeRequest

java.lang.Object

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

com.hds.hcpaw.fss.api.model.FolderSizeRequest

public abstract class FolderSizeRequest
extends BaseFssApiResource

A request to get the size of a folder.

Field Summary

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

UTF_8

Method Summary

Modifier and Type	Method and Description
static FolderSizeRequest	create(FssApiVersion apiVersion, java.lang.String path, java.lang.Long pointInTime) Returns a versioned FolderSizeRequest that is compatible with the specified apiVersion.
static java.lang.Class<? extends FolderSizeRequest>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the FolderSizeRequest that corresponds to the specified apiVersion.
java.lang.String	getPath() Returns the path of the folder for which size is being requested.
java.lang.Long	getPointInTime() Returns the pointInTime for which to get the folder size
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 FolderSizeRequest> getFssApiClass(FssApiVersion apiVersion)
                                                                   throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the FolderSizeRequest that corresponds to the specified apiVersion

Throws:

AwUnsupportedApiVersionException

create

public static FolderSizeRequest create(FssApiVersion apiVersion,
                                       java.lang.String path,
                                       java.lang.Long pointInTime)
                                throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version to be supported by the FolderSizeRequest

path - path of the folder to get size for

pointInTime - the pointInTime for which to get the size of the folder

Returns:

the constructed FolderSizeRequest.

Throws:

AwUnsupportedApiVersionException

validate

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

getPath

public java.lang.String getPath()

Returns the path of the folder for which size is being requested.

Returns:

the path of the folder for which size is being requested

getPointInTime

public java.lang.Long getPointInTime()

Returns the pointInTime for which to get the folder size

Returns:

pointInTime for which to get the folder size