org.nuxeo.box.api.marshalling.dao

Class BoxItem

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

All Implemented Interfaces:

IBoxJSONStringEntity

Direct Known Subclasses:

BoxEvent, BoxFile, BoxFolder, BoxWebLink

public class BoxItem
extends BoxTypedObject

Box item, this is a base class for the box items(.dao.BoxFile/BoxFolder/...)

Field Summary

Fields

Modifier and Type	Field and Description
static String	FIELD_CREATED_BY
static String	FIELD_DESCRIPTION
static String	FIELD_ETAG
static String	FIELD_ITEM_STATUS
static String	FIELD_MODIFIED_BY
static String	FIELD_NAME
static String	FIELD_OWNED_BY
static String	FIELD_PARENT
static String	FIELD_PATH_COLLECTION
static String	FIELD_SEQUENCE_ID
static String	FIELD_SHARED_LINK
static String	FIELD_SIZE
static String	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
BoxItem()
BoxItem(BoxItem obj) Copy constructor, this does deep copy for all the fields.
BoxItem(Map<String,Object> map) Instantiate the object from a map.

Method Summary

Modifier and Type	Method and Description
BoxUser	getCreatedBy() Get the user creating this item.
String	getDescription() Get description of the item.
String	getEtag() Get etag.
String	getItemStatus() Get the status of this item, which indicates whether this item is deleted or not.
BoxUser	getModifiedBy() Get the user last modified the item.
String	getName() Get name of the item.
BoxUser	getOwnedBy() Get owner of the item.
BoxFolder	getParent() Get parent folder.
BoxCollection	getPathCollection() Get the path of folders to this item, starting at the root.
String	getSequenceId() Getter.
BoxSharedLink	getSharedLink() Get shared link of box item.
Double	getSize() Get size of the box item.
String[]	getTags() Get the tags that are set on this item.

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

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

FIELD_ETAG

public static final String FIELD_ETAG

See Also:

Constant Field Values

FIELD_SEQUENCE_ID

public static final String FIELD_SEQUENCE_ID

See Also:

Constant Field Values

FIELD_NAME

public static final String FIELD_NAME

See Also:

Constant Field Values

FIELD_DESCRIPTION

public static final String FIELD_DESCRIPTION

See Also:

Constant Field Values

FIELD_SIZE

public static final String FIELD_SIZE

See Also:

Constant Field Values

FIELD_ITEM_STATUS

public static final String FIELD_ITEM_STATUS

See Also:

Constant Field Values

FIELD_SHARED_LINK

public static final String FIELD_SHARED_LINK

See Also:

Constant Field Values

FIELD_CREATED_BY

public static final String FIELD_CREATED_BY

See Also:

Constant Field Values

FIELD_MODIFIED_BY

public static final String FIELD_MODIFIED_BY

See Also:

Constant Field Values

FIELD_OWNED_BY

public static final String FIELD_OWNED_BY

See Also:

Constant Field Values

FIELD_PARENT

public static final String FIELD_PARENT

See Also:

Constant Field Values

FIELD_PATH_COLLECTION

public static final String FIELD_PATH_COLLECTION

See Also:

Constant Field Values

FIELD_TAGS

public static final String FIELD_TAGS

See Also:

Constant Field Values

Constructor Detail

BoxItem

public BoxItem()

BoxItem

public BoxItem(BoxItem obj)

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

Parameters:

obj -

BoxItem

public BoxItem(Map<String,Object> map)

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

Parameters:

map -

Method Detail

getPathCollection

public BoxCollection getPathCollection()

Get the path of folders to this item, starting at the root.

Returns:

the path_collection

getTags

public String[] getTags()

Get the tags that are set on this item.

Returns:

the tags

getSequenceId

public String getSequenceId()

Getter.

Returns:

sequence id

getName

public String getName()

Get name of the item.

Returns:

name of the item

getDescription

public String getDescription()

Get description of the item.

Returns:

description of the item

getSize

public Double getSize()

Get size of the box item. In bytes.

Returns:

size of the box item in bytes.

getSharedLink

public BoxSharedLink getSharedLink()

Get shared link of box item. Note if there is not shared link created, this is null.

Returns:

shared link of box item

getCreatedBy

public BoxUser getCreatedBy()

Get the user creating this item.

Returns:

user creating this item

getModifiedBy

public BoxUser getModifiedBy()

Get the user last modified the item.

Returns:

user last modified the item

getOwnedBy

public BoxUser getOwnedBy()

Get owner of the item.

Returns:

owner of the item

getParent

public BoxFolder getParent()

Get parent folder.

Returns:

parent folder

getEtag

public String getEtag()

Get etag.

Returns:

etag

getItemStatus

public String getItemStatus()

Get the status of this item, which indicates whether this item is deleted or not.

Returns:

the item_status