Entry (anywhere-fss-sdk)

java.lang.Object
- com.hds.hcpaw.fss.api.model.BaseFssApiResource
- - com.hds.hcpaw.fss.api.model.Entry

```
public abstract class Entry
extends BaseFssApiResource
```
Represents a file or folder and holds information (metadata) about the file or folder.

Field Summary
- Fields inherited from class com.hds.hcpaw.fss.api.model.BaseFssApiResource
  UTF_8

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Entry`	`create(FssApiVersion apiVersion, EntryType type, java.lang.String parent, java.lang.String name, java.lang.String etag, java.lang.Long changeTime, java.lang.Long creationTime, java.lang.Long size, java.lang.String hash, Access access, EntryState state, EntrySharingInfo sharing, EntryBackupInfo backup, java.lang.Long accessTime, java.lang.Boolean worm, java.lang.String uniqueId, java.lang.String parentUniqueId)` Returns a versioned Entry that is compatible with the specified apiVersion.
`boolean`	`equals(java.lang.Object o)`
`Access`	`getAccess()` Returns the level of `access` the user has to this entry.
`java.lang.Long`	`getAccessTime()` Returns the time that file was last accessed or the time that the retention will expire
`EntryBackupInfo`	`getBackup()` Returns backup information about the entry.
`java.lang.Long`	`getChangeTime()` Returns the time that the entry was created or last modified.
`java.lang.Long`	`getCreationTime()` Returns the time that the entry was created or last modified.
`java.lang.String`	`getEtag()` Returns the level of `access` the user has to the entry.
`static java.lang.Class<? extends Entry>`	`getFssApiClass(FssApiVersion apiVersion)` Returns the `Class` of the Entry that corresponds to the specified apiVersion.
`java.lang.String`	`getHash()` Returns the SHA-384 hash of the entry, represented as a hex string.
`java.lang.String`	`getName()` Returns the name of the file or folder.
`java.lang.String`	`getParent()` Returns the path of the parent folder of this entry.
`java.lang.String`	`getParentUniqueId()` Returns parent uniqueId of file or folder.
`EntrySharingInfo`	`getSharing()` Returns sharing information about the entry.
`java.lang.Long`	`getSize()` Returns the size (in bytes) of the entry.
`EntryState`	`getState()` Returns the state of the entry.
`EntryType`	`getType()` Returns the Entry type (file or folder).
`java.lang.String`	`getUniqueId()` Returns uniqueId of an entry.
`int`	`hashCode()`
`boolean`	`isFolder()` Returns true if this entry is a folder; false otherwise.
`java.lang.Boolean`	`isWORM()` Returns whether or not the file is protected and cannot be modified.
`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, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - getFssApiClass
```
public static java.lang.Class<? extends Entry> getFssApiClass(FssApiVersion apiVersion)
```
    Returns the Class of the Entry 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 Entry create(FssApiVersion apiVersion,
                           EntryType type,
                           java.lang.String parent,
                           java.lang.String name,
                           java.lang.String etag,
                           java.lang.Long changeTime,
                           java.lang.Long creationTime,
                           java.lang.Long size,
                           java.lang.String hash,
                           Access access,
                           EntryState state,
                           EntrySharingInfo sharing,
                           EntryBackupInfo backup,
                           java.lang.Long accessTime,
                           java.lang.Boolean worm,
                           java.lang.String uniqueId,
                           java.lang.String parentUniqueId)
                    throws AwUnsupportedApiVersionException
```
    Returns a versioned Entry that is compatible with the specified apiVersion.
    
    Parameters:
    
    apiVersion - API version to be supported by the Entry
    
    type - the Entry type (file or folder)
    
    parent - path of the parent folder of this entry
    
    name - name of the file or folder. This parameter should not include the parent path.
    
    etag - a string representing the current version of the file or folder
    
    changeTime - time that the entry was created or last modified
    
    size - size (in bytes) of the entry. This parameter is only applicable to files.
    
    hash - The SHA-384 hash of the entry, represented as a hex string. This parameter is only applicable to files.
    
    access - level of access that the user has to the entry (no access, viewer, collaborator)
    
    state - The state of the entry (CREATE, DELETE).
    
    sharing - Visible if the entry is shared; shows sharing information.
    
    backup - Visible if the entry is a backup folder; shows backup information.
    
    accessTime - Time that the entry was last accessed
    
    worm - Whether or not the file is protected and cannot be modified.
    
    Returns:
    
    a versioned instance of Entry that supports the specified apiVersion
    
    Throws:
    
    AwUnsupportedApiVersionException
  - getType
```
public EntryType getType()
```
    Returns the Entry type (file or folder).
    
    Returns:
    
    the Entry type (file or folder)
  - getParent
```
public java.lang.String getParent()
```
    Returns the path of the parent folder of this entry.
    
    Returns:
    
    path of the parent folder of this entry
  - getName
```
public java.lang.String getName()
```
    Returns the name of the file or folder. This does not include the parent path.
    
    Returns:
    
    name of the file or folder. This does not include the parent path.
  - getCreationTime
```
public java.lang.Long getCreationTime()
```
    Returns the time that the entry was created or last modified.
    
    Returns:
    
    time that the entry was created or last modified
  - getChangeTime
```
public java.lang.Long getChangeTime()
```
    Returns the time that the entry was created or last modified.
    
    Returns:
    
    time that the entry was created or last modified
  - getSize
```
public java.lang.Long getSize()
```
    Returns the size (in bytes) of the entry. This is only applicable to files.
    
    Returns:
    
    size (in bytes) of the entry. This is only applicable to files.
  - getHash
```
public java.lang.String getHash()
```
    Returns the SHA-384 hash of the entry, represented as a hex string. This is only applicable to files.
    
    Returns:
    
    the SHA-384 hash of the entry, represented as a hex string. This is only applicable to files.
  - getAccess
```
public Access getAccess()
```
    Returns the level of access the user has to this entry.
    
    Returns:
    
    the level of access the user has to this entry
  - getEtag
```
public java.lang.String getEtag()
```
    Returns the level of access the user has to the entry.
    
    Returns:
    
    the level of access the user has to the entry
  - isFolder
```
public boolean isFolder()
```
    Returns true if this entry is a folder; false otherwise.
    
    Returns:
    
    true if this entry is a folder; false otherwise
  - getState
```
public EntryState getState()
```
    Returns the state of the entry.
    
    Returns:
    
    the state of the entry
  - getSharing
```
public EntrySharingInfo getSharing()
```
    Returns sharing information about the entry.
    
    Returns:
    
    sharing information about the entry.
  - getBackup
```
public EntryBackupInfo getBackup()
```
    Returns backup information about the entry.
    
    Returns:
    
    backup information about the entry.
  - getAccessTime
```
public java.lang.Long getAccessTime()
```
    Returns the time that file was last accessed or the time that the retention will expire
    
    Returns:
    
    the time that file was last accessed or the time that the retention will expire
  - isWORM
```
public java.lang.Boolean isWORM()
```
    Returns whether or not the file is protected and cannot be modified.
    
    Returns:
    
    whether or not the file is protected and cannot be modified.
  - getUniqueId
```
public java.lang.String getUniqueId()
```
    Returns uniqueId of an entry.
    
    Returns:
    
    uniqueId of an entry.
  - getParentUniqueId
```
public java.lang.String getParentUniqueId()
```
    Returns parent uniqueId of file or folder.
    
    Returns:
    
    parent uniqueId of file or folder.
  - 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)
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object

Class Entry

Field Summary

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

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

getFssApiClass

create

getType

getParent

getName

getCreationTime

getChangeTime

getSize

getHash

getAccess

getEtag

isFolder

getState

getSharing

getBackup

getAccessTime

isWORM

getUniqueId

getParentUniqueId

validate

equals

hashCode