org.nuxeo.box.api.marshalling.dao

Class BoxTypedObject

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

All Implemented Interfaces:

IBoxJSONStringEntity

Direct Known Subclasses:

BoxCollaboration, BoxComment, BoxEmailAlias, BoxFileVersion, BoxItem, BoxLock, BoxRealTimeServer, BoxServerError, BoxUser

public class BoxTypedObject
extends BoxObject

This is base class for all box objects.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FIELD_CREATED_AT
static String	FIELD_ID
static String	FIELD_MODIFIED_AT
static String	FIELD_TYPE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Date	dateCreatedAt() Get the time created at.
Date	dateModifiedAt() Get the date this object is modified at.
String	getCreatedAt() Get the time this user was created at.
String	getId() Get id.
String	getModifiedAt() Get the time this user was modified the last time.
String	getType() Get the type.
BoxResourceType	resourceType() Deprecated.
void	setType(String type) Setter.

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_TYPE

public static final String FIELD_TYPE

See Also:

Constant Field Values

FIELD_ID

public static final String FIELD_ID

See Also:

Constant Field Values

FIELD_CREATED_AT

public static final String FIELD_CREATED_AT

See Also:

Constant Field Values

FIELD_MODIFIED_AT

public static final String FIELD_MODIFIED_AT

See Also:

Constant Field Values

Constructor Detail

BoxTypedObject

public BoxTypedObject()

BoxTypedObject

public BoxTypedObject(BoxTypedObject obj)

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

Parameters:

obj -

BoxTypedObject

public BoxTypedObject(Map<String,Object> map)

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

Parameters:

map -

Method Detail

resourceType

@Deprecated
public BoxResourceType resourceType()

Deprecated.

Get BoxResourceType of this object. using getBoxResourceType() instead . use getTypeFromLowercaseString method in IBoxResourceHub to parse the result String into type object.

Returns:

getType

public String getType()

Get the type.

Returns:

type

setType

public void setType(String type)

Setter. This is only used by Jackson JSON processer

Parameters:

type - type

getId

public String getId()

Get id.

Returns:

id

getCreatedAt

public String getCreatedAt()

Get the time this user was created at. (This returns a String and can be parsed into Date by

Returns:

the created_at

dateCreatedAt

public Date dateCreatedAt()

Get the time created at.

Returns:

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

Throws:

ParseException

getModifiedAt

public String getModifiedAt()

Get the time this user was modified the last time. (This returns a String and can be parsed into Date by

Returns:

the modified_at

dateModifiedAt

public Date dateModifiedAt()

Get the date this object is modified at.

Returns:

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

Throws:

ParseException