com.hds.hcpaw.fss.api.model

Class EntryIdentifier

java.lang.Object

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

com.hds.hcpaw.fss.api.model.EntryIdentifier

public abstract class EntryIdentifier
extends BaseFssApiResource

A (path,etag) pair that is enough to uniquely identify an Entry for a given user.

Field Summary

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

UTF_8

Method Summary

Modifier and Type	Method and Description
static EntryIdentifier	create(FssApiVersion apiVersion, java.lang.String path, java.lang.String etag) Returns a versioned EntryIdentifier that is compatible with the specified apiVersion.
java.lang.String	getEtag() Returns the etag of the entry.
static java.lang.Class<? extends EntryIdentifier>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the EntryIdentifier that corresponds to the specified apiVersion.
java.lang.String	getPath() Returns the path of the file or folder.
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 EntryIdentifier> getFssApiClass(FssApiVersion apiVersion)

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the entry that corresponds to the specified apiVersion

create

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

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

Parameters:

apiVersion - API version to be supported by the EntryIdentifier

path - path of the file or folder.

etag - a string representing the current version of the file or folder

Throws:

AwUnsupportedApiVersionException

getPath

public java.lang.String getPath()

Returns the path of the file or folder.

Returns:

path of the file or folder.

getEtag

public java.lang.String getEtag()

Returns the etag of the entry.

Returns:

the etag of the entry.

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)