com.hds.hcpaw.fss.api.model

Class MovePathRequest

java.lang.Object

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

com.hds.hcpaw.fss.api.model.MovePathRequest

public abstract class MovePathRequest
extends BaseFssApiResource

A request to move a file or folder to a different location.

Field Summary

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

UTF_8

Method Summary

Modifier and Type	Method and Description
static MovePathRequest	create(FssApiVersion apiVersion, java.io.InputStreamReader reader) Constructs a MovePathRequest from the JSON string representation contained in the reader.
static MovePathRequest	create(FssApiVersion apiVersion, java.lang.String sourcePath, java.lang.String destinationPath, java.lang.String etag, java.lang.Boolean createParents) Returns a versioned MovePathRequest that is compatible with the specified apiVersion.
java.lang.Boolean	getCreateParents() Returns whether or not to create missing parents at the destination path.
java.lang.String	getDestinationPath() Returns the path where the file or folder should be moved.
java.lang.String	getEtag() Returns the etag of file or folder where it currently resides.
static java.lang.Class<? extends MovePathRequest>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the MovePathRequest that corresponds to the specified apiVersion.
java.lang.String	getSourcePath() Returns the path where the file or folder currently resides.
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 MovePathRequest> getFssApiClass(FssApiVersion apiVersion)
                                                                 throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the MovePathRequest that corresponds to the specified apiVersion

Throws:

AwUnsupportedApiVersionException

create

public static MovePathRequest create(FssApiVersion apiVersion,
                                     java.lang.String sourcePath,
                                     java.lang.String destinationPath,
                                     java.lang.String etag,
                                     java.lang.Boolean createParents)
                              throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version to be supported by the MovePathRequest

sourcePath - current path (including file or folder name) of the entry to be moved

destinationPath - path where the file or folder will be moved

etag - the current etag of the file or folder at sourcePath

createParents - if true, then any parent folders of destPath (that do not already exist) should be created

Returns:

the constructed MovePathRequest

Throws:

AwUnsupportedApiVersionException

create

public static MovePathRequest create(FssApiVersion apiVersion,
                                     java.io.InputStreamReader reader)
                              throws AwJsonException,
                                     AwUnsupportedApiVersionException

Constructs a MovePathRequest from the JSON string representation contained in the reader.

Parameters:

apiVersion - API version of the object to be read from the reader

reader - contains the JSON string representation of a MovePathRequest

Returns:

the constructed MovePathRequest

Throws:

AwJsonException

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)

getSourcePath

public java.lang.String getSourcePath()

Returns the path where the file or folder currently resides.

Returns:

the path where the file or folder currently resides

getDestinationPath

public java.lang.String getDestinationPath()

Returns the path where the file or folder should be moved.

Returns:

the path where the file or folder should be moved

getEtag

public java.lang.String getEtag()

Returns the etag of file or folder where it currently resides.

Returns:

the etag of file or folder where it currently resides

getCreateParents

public java.lang.Boolean getCreateParents()

Returns whether or not to create missing parents at the destination path.

Returns:

true if any parent folders of destPath (that do not already exist) should be created; false otherwise