com.hds.hcpaw.fss.api.model

Class FolderRestoreRequest

java.lang.Object

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

com.hds.hcpaw.fss.api.model.FolderRestoreRequest

public abstract class FolderRestoreRequest
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 FolderRestoreRequest	create(FssApiVersion apiVersion, java.lang.String path, java.lang.Integer deltaSeconds) Returns a versioned FolderRestoreRequest that is compatible with the specified apiVersion.
java.lang.Integer	getDeltaSeconds() Returns the max difference in seconds between the folder to be restored and the entries inside the folder that will be restored.
static java.lang.Class<? extends FolderRestoreRequest>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the FolderRestoreRequest that corresponds to the specified apiVersion.
java.lang.String	getPath() Returns the path to be restored.
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 FolderRestoreRequest> getFssApiClass(FssApiVersion apiVersion)
                                                                      throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the FileCreateRequest that corresponds to the specified apiVersion

Throws:

AwUnsupportedApiVersionException

create

public static FolderRestoreRequest create(FssApiVersion apiVersion,
                                          java.lang.String path,
                                          java.lang.Integer deltaSeconds)
                                   throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version to be supported by the FolderCreateRequest

path - The path of the folder to restore

deltaSeconds - The maximum difference in seconds between when the folder was deleted to restore entries inside the folder

Returns:

The constructed FolderrestoreRequest.

Throws:

AwUnsupportedApiVersionException

getPath

public java.lang.String getPath()

Returns the path to be restored.

Returns:

the path to be restored

getDeltaSeconds

public java.lang.Integer getDeltaSeconds()

Returns the max difference in seconds between the folder to be restored and the entries inside the folder that will be restored.

Returns:

the max difference in seconds between the folder to be restored and the entries inside the folder that will be restored

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