com.hds.hcpaw.fss.api.model

Class FolderCreateRequest

java.lang.Object

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

com.hds.hcpaw.fss.api.model.FolderCreateRequest

public abstract class FolderCreateRequest
extends BaseFssApiResource

A request to create 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 FolderCreateRequest	create(FssApiVersion apiVersion, java.io.InputStreamReader reader) Constructs a FolderCreateRequest from the JSON string representation contained in the reader.
static FolderCreateRequest	create(FssApiVersion apiVersion, java.lang.String path, java.lang.Boolean createParents, java.lang.Long mtime, java.lang.Long ctime, java.lang.Long atime) Returns a versioned FolderCreateRequest that is compatible with the specified apiVersion.
java.lang.Long	getAtime() Returns the Last Accessed time of the file created.
java.lang.Boolean	getCreateParents() Returns whether or not to create all missing parents of the path.
java.lang.Long	getCtime() Returns the created time of the file created.
static java.lang.Class<? extends FolderCreateRequest>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the FolderCreateRequest that corresponds to the specified apiVersion.
java.lang.Long	getMtime() Returns the modified time of the file created.
java.lang.String	getPath() Returns the path where the folder should be created.
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 FolderCreateRequest> getFssApiClass(FssApiVersion apiVersion)
                                                                     throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the FolderCreateRequest that corresponds to the specified apiVersion

Throws:

AwUnsupportedApiVersionException

create

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

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

Parameters:

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

reader - contains the JSON string representation of a FolderCreateRequest

Returns:

the constructed FolderCreateRequest

Throws:

AwJsonException

AwUnsupportedApiVersionException

create

public static FolderCreateRequest create(FssApiVersion apiVersion,
                                         java.lang.String path,
                                         java.lang.Boolean createParents,
                                         java.lang.Long mtime,
                                         java.lang.Long ctime,
                                         java.lang.Long atime)
                                  throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version to be supported by the FolderCreateRequest

path - path of the folder to be created

createParents - if true, then any parent folders of path that do not already exist should be created. False otherwise

Returns:

the constructed FolderCreateRequest.

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 where the folder should be created.

Returns:

the path where the folder should be created

getMtime

public java.lang.Long getMtime()

Returns the modified time of the file created.

Returns:

the modified time of the file created.

getCtime

public java.lang.Long getCtime()

Returns the created time of the file created.

Returns:

the created time of the file created.

getAtime

public java.lang.Long getAtime()

Returns the Last Accessed time of the file created.

Returns:

the Last Accessed time of the file created.

getCreateParents

public java.lang.Boolean getCreateParents()

Returns whether or not to create all missing parents of the path.

Returns:

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