com.hds.hcpaw.fss.api.model

Class ListPathLinksRequest

java.lang.Object

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

com.hds.hcpaw.fss.api.model.ListPathLinksRequest

public abstract class ListPathLinksRequest
extends BaseFssApiResource

A request to list links for a path.

Field Summary

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

UTF_8

Method Summary

Modifier and Type	Method and Description
static ListPathLinksRequest	create(FssApiVersion apiVersion, java.lang.String path) Returns a versioned ListPathLinksRequest that is compatible with the specified apiVersion.
static java.lang.Class<? extends ListPathLinksRequest>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the ListPathLinksRequest that corresponds to the specified apiVersion.
java.lang.String	getPath() Returns the path of the file or folder that you are listing link for.
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 ListPathLinksRequest> getFssApiClass(FssApiVersion apiVersion)
                                                                      throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the ListPathLinksRequest that corresponds to the specified apiVersion

Throws:

AwUnsupportedApiVersionException

create

public static ListPathLinksRequest create(FssApiVersion apiVersion,
                                          java.lang.String path)
                                   throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version to be supported by the ListPathLinksRequest

path - path of the file or folder that you are listing link for

Returns:

the constructed ListPathLinksRequest

Throws:

AwUnsupportedApiVersionException

getPath

public java.lang.String getPath()

Returns the path of the file or folder that you are listing link for.

Returns:

the path of the file or folder that you are listing link for

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)