org.nuxeo.box.api.marshalling.dao

Class BoxFolder

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.BoxFolder

All Implemented Interfaces:

IBoxJSONStringEntity

public class BoxFolder
extends BoxItem

Box folder.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FIELD_FOLDER_UPLOAD_EMAIL
static String	FIELD_HAS_COLLABORATIONS
static String	FIELD_ITEM_COLLECTION

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
BoxFolder() Constructor.
BoxFolder(BoxFolder obj) Copy constructor, this does deep copy for all the fields.
BoxFolder(Map<String,Object> map) Instantiate the object from a map.

Method Summary

Modifier and Type	Method and Description
BoxEmail	getFolderUploadEmail() This is folder specific field, get the email that can be used to upload file into the folder.
BoxCollection	getItemCollection() Getter.Get the items(files, subfolders, web links...) under this box folder.
Boolean	hasCollaborations() Getter.Get whether this box folder has collaborations.
boolean	hasCollaborations(boolean defaultValue)
protected void	setFolderUploadEmail(BoxEmail folderUploadEmail) Setter.
protected void	setHasCollaborations(Boolean hasCollaborations) Setter.
protected void	setItemCollection(BoxCollection itemCollection) Setter.

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

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

Field Detail

FIELD_FOLDER_UPLOAD_EMAIL

public static final String FIELD_FOLDER_UPLOAD_EMAIL

See Also:

Constant Field Values

FIELD_ITEM_COLLECTION

public static final String FIELD_ITEM_COLLECTION

See Also:

Constant Field Values

FIELD_HAS_COLLABORATIONS

public static final String FIELD_HAS_COLLABORATIONS

See Also:

Constant Field Values

Constructor Detail

BoxFolder

public BoxFolder()

Constructor.

BoxFolder

public BoxFolder(BoxFolder obj)

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

Parameters:

obj -

BoxFolder

public BoxFolder(Map<String,Object> map)

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

Parameters:

map -

Method Detail

getFolderUploadEmail

public BoxEmail getFolderUploadEmail()

This is folder specific field, get the email that can be used to upload file into the folder.

Returns:

email

setFolderUploadEmail

protected void setFolderUploadEmail(BoxEmail folderUploadEmail)

Setter. This is only used by Jackson JSON processer

Parameters:

folderUploadEmail -

getItemCollection

public BoxCollection getItemCollection()

Getter.Get the items(files, subfolders, web links...) under this box folder.

Returns:

collection of children items.

setItemCollection

protected void setItemCollection(BoxCollection itemCollection)

Setter. This is only used by Jackson JSON processer

Parameters:

itemCollection - children item.

hasCollaborations

public Boolean hasCollaborations()

Getter.Get whether this box folder has collaborations.

Returns:

whether this box folder has collaborations

hasCollaborations

public boolean hasCollaborations(boolean defaultValue)

setHasCollaborations

protected void setHasCollaborations(Boolean hasCollaborations)

Setter. This is only used by Jackson JSON processer

Parameters:

hasCollaborations - whether folder has collaborations.