com.hds.hcpaw.fss.api.model

Class LinkMetadata

java.lang.Object

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

com.hds.hcpaw.fss.api.model.LinkMetadata

public abstract class LinkMetadata
extends BaseFssApiResource

Holds metadata about a link.

Field Summary

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

UTF_8

Method Summary

Modifier and Type	Method and Description
static LinkMetadata	create(FssApiVersion apiVersion, java.lang.Boolean requiresAccessCode, java.util.Set<LinkPermission> permission, LinkType type, java.lang.String contentType, java.lang.Long size, java.lang.String linkOwner, java.lang.String name) Returns a versioned LinkMetadata that is compatible with the specified apiVersion.
java.lang.String	getContentType() Returns the contentType of the link.
static java.lang.Class<? extends LinkMetadata>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the LinkMetadata that corresponds to the specified apiVersion.
java.lang.String	getLinkOwner() Gets the display name of the link's owner
java.util.Set<LinkPermission>	getLinkPermissions() Returns the permissions allowed on this link
java.lang.String	getName() Gets the current name of the file or folder for the link
java.lang.Boolean	getRequiresAccessCode() Returns whether the link requires an access code.
java.lang.Long	getSize() Returns the size of the link.
LinkType	getType() Returns the type of object that the link points to (FILE, FOLDER, or BROKEN).
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 LinkMetadata> getFssApiClass(FssApiVersion apiVersion)

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

the Class of the LinkMetadata that corresponds to the specified apiVersion

create

public static LinkMetadata create(FssApiVersion apiVersion,
                                  java.lang.Boolean requiresAccessCode,
                                  java.util.Set<LinkPermission> permission,
                                  LinkType type,
                                  java.lang.String contentType,
                                  java.lang.Long size,
                                  java.lang.String linkOwner,
                                  java.lang.String name)
                           throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version to be supported by the LinkMetadata

requiresAccessCode - whether or not the link requires an access code.

permission - the permissions for this link (read, write)

type - the type of entry (FILE, FOLDER, BROKEN) the link points to.

contentType - the content type of the entry (null if it is not a FILE type)

Returns:

the link's metadata.

Throws:

AwUnsupportedApiVersionException

getRequiresAccessCode

public java.lang.Boolean getRequiresAccessCode()

Returns whether the link requires an access code.

Returns:

whether the link requires an access code.

getType

public LinkType getType()

Returns the type of object that the link points to (FILE, FOLDER, or BROKEN).

Returns:

The type of object the link points to.

getLinkPermissions

public java.util.Set<LinkPermission> getLinkPermissions()

Returns the permissions allowed on this link

Returns:

the permissions allowed on this link

getContentType

public java.lang.String getContentType()

Returns the contentType of the link. FOLDERs should have a null contentType.

Returns:

getSize

public java.lang.Long getSize()

Returns the size of the link. FOLDERs should have a null value.

Returns:

getLinkOwner

public java.lang.String getLinkOwner()

Gets the display name of the link's owner

Returns:

Display name of the link's owner

getName

public java.lang.String getName()

Gets the current name of the file or folder for the link

Returns:

Current name of the file or folder for the link

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)