org.nuxeo.box.api.marshalling.dao

Class BoxCollaboration

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

All Implemented Interfaces:

IBoxJSONStringEntity

public class BoxCollaboration
extends BoxTypedObject

Data for collaboration.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FIELD_ACCESSIBLE_BY
static String	FIELD_ACKNOWLEGED_AT
static String	FIELD_CREATED_BY
static String	FIELD_EXPIRES_AT
static String	FIELD_FOLDER
static String	FIELD_ROLE
static String	FIELD_STATUS
static String	STATUS_ACCEPTED Collaboration invitation is accepted.
static String	STATUS_PENDING Collaboration invitation is pending.
static String	STATUS_REJECTED Collaboration invitation is rejected.

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

Method Summary

Modifier and Type	Method and Description
Date	dateExpiresAt() Get the time this collaboration expires.
BoxUser	getAccessibleBy() Get the user this collaboration applies to.
String	getAcknowledgedAt() Get the time when the status of this collaboration was changed.
BoxUser	getCreatedBy() Get the user creating this collaboration.
String	getExpiresAt() Get the time this collaboration expires.
BoxFolder	getFolder() Get the folder this collaboration is related to.
String	getRole() Get the role/permission.
String	getStatus() Get the status of this collaboration.

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_CREATED_BY

public static final String FIELD_CREATED_BY

See Also:

Constant Field Values

FIELD_EXPIRES_AT

public static final String FIELD_EXPIRES_AT

See Also:

Constant Field Values

FIELD_ACCESSIBLE_BY

public static final String FIELD_ACCESSIBLE_BY

See Also:

Constant Field Values

FIELD_STATUS

public static final String FIELD_STATUS

See Also:

Constant Field Values

FIELD_ACKNOWLEGED_AT

public static final String FIELD_ACKNOWLEGED_AT

See Also:

Constant Field Values

FIELD_FOLDER

public static final String FIELD_FOLDER

See Also:

Constant Field Values

FIELD_ROLE

public static final String FIELD_ROLE

See Also:

Constant Field Values

STATUS_ACCEPTED

public static final String STATUS_ACCEPTED

Collaboration invitation is accepted.

See Also:

Constant Field Values

STATUS_PENDING

public static final String STATUS_PENDING

Collaboration invitation is pending.

See Also:

Constant Field Values

STATUS_REJECTED

public static final String STATUS_REJECTED

Collaboration invitation is rejected.

See Also:

Constant Field Values

Constructor Detail

BoxCollaboration

public BoxCollaboration()

Constructor.

BoxCollaboration

public BoxCollaboration(BoxCollaboration obj)

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

Parameters:

obj -

BoxCollaboration

public BoxCollaboration(Map<String,Object> map)

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

Parameters:

map -

Method Detail

getCreatedBy

public BoxUser getCreatedBy()

Get the user creating this collaboration.

Returns:

the created_by

getAccessibleBy

public BoxUser getAccessibleBy()

Get the user this collaboration applies to.

Returns:

the accessible_by

getExpiresAt

public String getExpiresAt()

Get the time this collaboration expires. This returns a String and can be parsed into Date by

Returns:

the expires_at

dateExpiresAt

public Date dateExpiresAt()
                   throws ParseException

Get the time this collaboration expires.

Returns:

Date representation of the expires_at value. Null if there was no expires_at or if it could not be parsed as an ISO8601 date.

Throws:

ParseException

getStatus

public String getStatus()

Get the status of this collaboration. Can be STATUS_ACCEPTED, link STATUS_PENDING or STATUS_REJECTED

Returns:

the status

getRole

public String getRole()

Get the role/permission. This is a role/permission String defined in CollaborationRole

Returns:

the role/permission

getAcknowledgedAt

public String getAcknowledgedAt()

Get the time when the status of this collaboration was changed. This returns a String and can be parsed into Date by

Returns:

the acknowledged_at

getFolder

public BoxFolder getFolder()

Get the folder this collaboration is related to.

Returns:

item the folder this collaboration is related to