org.nuxeo.box.api.marshalling.dao

Class BoxEvent

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

All Implemented Interfaces:

IBoxJSONStringEntity

public class BoxEvent
extends BoxItem

Field Summary

Fields

Modifier and Type	Field and Description
static String	EVENT_TYPE_ADD_LOGIN_ACTIVITY_DEVICE
static String	EVENT_TYPE_COLLAB_ADD_COLLABORATOR
static String	EVENT_TYPE_COLLAB_INVITE_COLLABORATOR
static String	EVENT_TYPE_COMMENT_CREATE
static String	EVENT_TYPE_ITEM_COPY
static String	EVENT_TYPE_ITEM_CREATE
static String	EVENT_TYPE_ITEM_DOWNLOAD
static String	EVENT_TYPE_ITEM_MOVE
static String	EVENT_TYPE_ITEM_PREVIEW
static String	EVENT_TYPE_ITEM_RENAME
static String	EVENT_TYPE_ITEM_SHARED
static String	EVENT_TYPE_ITEM_SHARED_CREATE
static String	EVENT_TYPE_ITEM_SHARED_UNSHARE
static String	EVENT_TYPE_ITEM_SYNC
static String	EVENT_TYPE_ITEM_TRASH
static String	EVENT_TYPE_ITEM_UNDELETE_VIA_TRASH
static String	EVENT_TYPE_ITEM_UNSYNC
static String	EVENT_TYPE_ITEM_UPLOAD
static String	EVENT_TYPE_LOCK_CREATE
static String	EVENT_TYPE_LOCK_DESTROY
static String	EVENT_TYPE_TAG_ITEM_CREATE
static String	EVENT_TYPE_TASK_ASSIGNMENT_CREATE
static String	FIELD_EVENT_ID
static String	FIELD_EVENT_TYPE
static String	FIELD_SOURCE

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

Method Summary

Modifier and Type	Method and Description
String	getEventType() Get event type.
String	getId() Get event id.
BoxTypedObject	getSource() Get the source item for this event.

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, 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_EVENT_TYPE

public static final String FIELD_EVENT_TYPE

See Also:

Constant Field Values

FIELD_SOURCE

public static final String FIELD_SOURCE

See Also:

Constant Field Values

FIELD_EVENT_ID

public static final String FIELD_EVENT_ID

See Also:

Constant Field Values

EVENT_TYPE_ITEM_CREATE

public static final String EVENT_TYPE_ITEM_CREATE

See Also:

Constant Field Values

EVENT_TYPE_ITEM_UPLOAD

public static final String EVENT_TYPE_ITEM_UPLOAD

See Also:

Constant Field Values

EVENT_TYPE_COMMENT_CREATE

public static final String EVENT_TYPE_COMMENT_CREATE

See Also:

Constant Field Values

EVENT_TYPE_ITEM_DOWNLOAD

public static final String EVENT_TYPE_ITEM_DOWNLOAD

See Also:

Constant Field Values

EVENT_TYPE_ITEM_PREVIEW

public static final String EVENT_TYPE_ITEM_PREVIEW

See Also:

Constant Field Values

EVENT_TYPE_ITEM_MOVE

public static final String EVENT_TYPE_ITEM_MOVE

See Also:

Constant Field Values

EVENT_TYPE_ITEM_COPY

public static final String EVENT_TYPE_ITEM_COPY

See Also:

Constant Field Values

EVENT_TYPE_TASK_ASSIGNMENT_CREATE

public static final String EVENT_TYPE_TASK_ASSIGNMENT_CREATE

See Also:

Constant Field Values

EVENT_TYPE_LOCK_CREATE

public static final String EVENT_TYPE_LOCK_CREATE

See Also:

Constant Field Values

EVENT_TYPE_LOCK_DESTROY

public static final String EVENT_TYPE_LOCK_DESTROY

See Also:

Constant Field Values

EVENT_TYPE_ITEM_TRASH

public static final String EVENT_TYPE_ITEM_TRASH

See Also:

Constant Field Values

EVENT_TYPE_ITEM_UNDELETE_VIA_TRASH

public static final String EVENT_TYPE_ITEM_UNDELETE_VIA_TRASH

See Also:

Constant Field Values

EVENT_TYPE_COLLAB_ADD_COLLABORATOR

public static final String EVENT_TYPE_COLLAB_ADD_COLLABORATOR

See Also:

Constant Field Values

EVENT_TYPE_COLLAB_INVITE_COLLABORATOR

public static final String EVENT_TYPE_COLLAB_INVITE_COLLABORATOR

See Also:

Constant Field Values

EVENT_TYPE_ITEM_SYNC

public static final String EVENT_TYPE_ITEM_SYNC

See Also:

Constant Field Values

EVENT_TYPE_ITEM_UNSYNC

public static final String EVENT_TYPE_ITEM_UNSYNC

See Also:

Constant Field Values

EVENT_TYPE_ITEM_RENAME

public static final String EVENT_TYPE_ITEM_RENAME

See Also:

Constant Field Values

EVENT_TYPE_ITEM_SHARED_CREATE

public static final String EVENT_TYPE_ITEM_SHARED_CREATE

See Also:

Constant Field Values

EVENT_TYPE_ITEM_SHARED_UNSHARE

public static final String EVENT_TYPE_ITEM_SHARED_UNSHARE

See Also:

Constant Field Values

EVENT_TYPE_ITEM_SHARED

public static final String EVENT_TYPE_ITEM_SHARED

See Also:

Constant Field Values

EVENT_TYPE_TAG_ITEM_CREATE

public static final String EVENT_TYPE_TAG_ITEM_CREATE

See Also:

Constant Field Values

EVENT_TYPE_ADD_LOGIN_ACTIVITY_DEVICE

public static final String EVENT_TYPE_ADD_LOGIN_ACTIVITY_DEVICE

See Also:

Constant Field Values

Constructor Detail

BoxEvent

public BoxEvent()

Constructor.

BoxEvent

public BoxEvent(BoxEvent obj)

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

Parameters:

obj -

BoxEvent

public BoxEvent(Map<String,Object> map)

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

Parameters:

map -

Method Detail

getId

public String getId()

Get event id.

Overrides:

getId in class BoxTypedObject

Returns:

event id.

getEventType

public String getEventType()

Get event type.

Returns:

event type.

getSource

public BoxTypedObject getSource()

Get the source item for this event.

Returns:

source item of this event.