org.nuxeo.box.api.marshalling.dao

Class BoxFile

java.lang.Object

org.nuxeo.box.api.marshalling.dao.BoxBase

org.nuxeo.box.api.marshalling.jsonentities.DefaultJSONStringEntity

org.nuxeo.box.api.marshalling.dao.BoxObject

org.nuxeo.box.api.marshalling.dao.BoxTypedObject

org.nuxeo.box.api.marshalling.dao.BoxItem

org.nuxeo.box.api.marshalling.dao.BoxFile

All Implemented Interfaces:

IBoxJSONStringEntity

public class BoxFile
extends BoxItem

Box File object

Field Summary

Fields

Modifier and Type	Field and Description
static String	FIELD_COMMENT_COUNT
static String	FIELD_CONTENT_CREATED_AT
static String	FIELD_CONTENT_MODIFIED_AT
static String	FIELD_SHA1
static String	FIELD_VERSION_NUMBER

Fields inherited from class org.nuxeo.box.api.marshalling.dao.BoxItem

FIELD_CREATED_BY, FIELD_DESCRIPTION, FIELD_ETAG, FIELD_ITEM_STATUS, FIELD_MODIFIED_BY, FIELD_NAME, FIELD_OWNED_BY, FIELD_PARENT, FIELD_PATH_COLLECTION, FIELD_SEQUENCE_ID, FIELD_SHARED_LINK, FIELD_SIZE, FIELD_TAGS

Fields inherited from class org.nuxeo.box.api.marshalling.dao.BoxTypedObject

FIELD_CREATED_AT, FIELD_ID, FIELD_MODIFIED_AT, FIELD_TYPE

Constructor Summary

Constructors

Constructor and Description
BoxFile() Constructor.
BoxFile(BoxFile obj) Copy constructor, this does deep copy for all the fields.
BoxFile(Map<String,Object> map) Instantiate the object from a map.

Method Summary

Methods

Modifier and Type	Method and Description
Date	dateContentCreatedAt() Return the date content created on local machine, if this date was not provided when uploading the file, this will be the time file was uploaded.
Date	dateContentModifieddAt() Return the date content last modified on local machine, if this date was not provided when uploading the file, this will be the time file was uploaded.
Integer	getCommentCount() Get comment count of the file.
String	getContentCreatedAt()
String	getContentModifiedAt()
String	getSha1() Get sha1 of the file.
String	getVersionNumber() Get version number of the file.

Methods inherited from class org.nuxeo.box.api.marshalling.dao.BoxItem

getCreatedBy, getDescription, getEtag, getItemStatus, getModifiedBy, getName, getOwnedBy, getParent, getPathCollection, getSequenceId, getSharedLink, getSize, getTags

Methods inherited from class org.nuxeo.box.api.marshalling.dao.BoxTypedObject

dateCreatedAt, dateModifiedAt, getCreatedAt, getId, getModifiedAt, getType, resourceType, setType

Methods inherited from class org.nuxeo.box.api.marshalling.dao.BoxObject

contains, equals, getExtraData, getKeySet, getValue, handleUnknown, hashCode, properties, put, putAll

Methods inherited from class org.nuxeo.box.api.marshalling.jsonentities.DefaultJSONStringEntity

toJSONString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

FIELD_SHA1

public static final String FIELD_SHA1

See Also:

Constant Field Values

FIELD_VERSION_NUMBER

public static final String FIELD_VERSION_NUMBER

See Also:

Constant Field Values

FIELD_COMMENT_COUNT

public static final String FIELD_COMMENT_COUNT

See Also:

Constant Field Values

FIELD_CONTENT_CREATED_AT

public static final String FIELD_CONTENT_CREATED_AT

See Also:

Constant Field Values

FIELD_CONTENT_MODIFIED_AT

public static final String FIELD_CONTENT_MODIFIED_AT

See Also:

Constant Field Values

Constructor Detail

BoxFile

public BoxFile()

Constructor.

BoxFile

public BoxFile(BoxFile obj)

Copy constructor, this does deep copy for all the fields.

Parameters:

obj -

BoxFile

public BoxFile(Map<String,Object> map)

Instantiate the object from a map. Each entry in the map reflects to a field.

Parameters:

map -

Method Detail

getSha1

public String getSha1()

Get sha1 of the file.

Returns:

sha1 of the file.

getContentCreatedAt

public String getContentCreatedAt()

dateContentCreatedAt

public Date dateContentCreatedAt()

Return the date content created on local machine, if this date was not provided when uploading the file, this will be the time file was uploaded.

Returns:

getContentModifiedAt

public String getContentModifiedAt()

dateContentModifieddAt

public Date dateContentModifieddAt()

Return the date content last modified on local machine, if this date was not provided when uploading the file, this will be the time file was uploaded.

Returns:

getVersionNumber

public String getVersionNumber()

Get version number of the file.

Returns:

version number of the file.

getCommentCount

public Integer getCommentCount()

Get comment count of the file.

Returns:

comment count of the file.