org.exoplatform.commons.api.event.data

Interface BaseObject

All Known Subinterfaces:

File

public interface BaseObject

Gets information from a JCR node instead of opening a direct access to the javax.jcr.Node object. However, the BaseObject just provides basic information of an object that could be used in search result or somewhere else.

Level API:

Experimental

Method Summary

Methods

Modifier and Type	Method and Description
Calendar	getCreatedDate() Gets the created date of the BaseObject.
Calendar	getLastModifiedDate() Gets the last modified date of the BaseObject.
String	getLastModifier() Gets name of the user who did the last modification on the BaseObject.
List<String>	getMixinTypes() Gets a list of node type names which are added to the BaseObject as mixin.
String	getName() Gets name of an object.
String	getOwner() Gets name of the user who created the BaseObject.
String	getPath() Gets the absolute path of the BaseObject.
String	getPrimaryType() Gets the primary type of the BaseObject.
String	getRating() Gets the rating value for the BaseObject.
List<String>	getTags() Gets a list of tag names which are added to the BaseObject.
String	getTitle() Gets title of the BaseObject.
String	getUUID() Gets the UUID value of the BaseObject.
String	getWorkspace() Gets the workspace name where the BaseObject is stored.
void	save() Stores all information to the database.

Method Detail

getName

String getName()

Gets name of an object. The name is the last element in its path, excluding any square-bracket index (if any).

Returns:

The object name.

Level API:

Experimental

getPath

String getPath()

Gets the absolute path of the BaseObject.

Returns:

The BaseObject path.

Level API:

Experimental

getTitle

String getTitle()

Gets title of the BaseObject.

Returns:

The value of exo:title property.

Level API:

Experimental

getCreatedDate

Calendar getCreatedDate()

Gets the created date of the BaseObject.

Returns:

The value of exo:dateCreated property.

Level API:

Experimental

getLastModifiedDate

Calendar getLastModifiedDate()

Gets the last modified date of the BaseObject.

Returns:

The value of exo:lastModifiedDate property.

Level API:

Experimental

getLastModifier

String getLastModifier()

Gets name of the user who did the last modification on the BaseObject.

Returns:

The value of exo:lastModifier property.

Level API:

Experimental

getOwner

String getOwner()

Gets name of the user who created the BaseObject.

Returns:

The value of exo:owner property.

Level API:

Experimental

getPrimaryType

String getPrimaryType()

Gets the primary type of the BaseObject. For example: nt:file, exo:webContent.

Returns:

The value of jcr:primartyType property.

Level API:

Experimental

getMixinTypes

List<String> getMixinTypes()

Gets a list of node type names which are added to the BaseObject as mixin.

Returns:

The list of mixin names.

Level API:

Experimental

getWorkspace

String getWorkspace()

Gets the workspace name where the BaseObject is stored.

Returns:

The workspace name.

Level API:

Experimental

getTags

List<String> getTags()

Gets a list of tag names which are added to the BaseObject.

Returns:

The list of tag names.

Level API:

Experimental

getRating

String getRating()

Gets the rating value for the BaseObject.

Returns:

The rating value.

Level API:

Experimental

getUUID

String getUUID()

Gets the UUID value of the BaseObject. This is just available when the mix:referenceable mixin node type has already been added.

Returns:

Value of the exo:uuid property.

Level API:

Experimental

save

void save()

Stores all information to the database.

Level API:

Experimental