ObjectContentManager (Apache Jackrabbit 1.5.0 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.jackrabbit.ocm.manager
Interface ObjectContentManager

All Known Implementing Classes:: ObjectContentManagerImpl

public interface ObjectContentManager

The object content manager encapsulates a JCR session. This is the main component used to manage objects into the JCR repository.

Author:: Sandro Boehme, Lombart Christophe

Method Summary
`void`	`addVersionLabel(String path, String versionName, String versionLabel)` Add a new label to a particular version
`void`	`checkin(String path)` Checkin an object
`void`	`checkin(String path, String[] versionLabels)` Checkin an object and apply some labels to this new version Within a particular object path, a given label may appear a maximum of once
`void`	`checkout(String path)` Checkout - Create a new version This is only possible if the object is based on mix:versionable node type
`void`	`copy(String srcPath, String destPath)` Copy an object
`String[]`	`getAllVersionLabels(String path)` Get all version labels assigned to all versions
`VersionIterator`	`getAllVersions(String path)` Get all object versions
`Version`	`getBaseVersion(String path)` Get the lastest object version
`Object`	`getObject(Class objectClass, String path)` Get an object from the JCR repository
`Object`	`getObject(Class objectClass, String path, String versionNumber)` Get an object from the JCR repository
`Object`	`getObject(Query query)` Retrieve an object matching to a query
`Object`	`getObject(String path)` Get an object from the JCR repository
`Object`	`getObject(String path, String versionNumber)` Get an object from the JCR repository
`Object`	`getObjectByUuid(String uuid)` Get an object from the JCR repository
`Iterator`	`getObjectIterator(Query query)` Retrieve some objects matching to a query.
`Iterator`	`getObjectIterator(String query, String language)` Retrieve an objects matching a query specified in a specific query language.
`Collection`	`getObjects(Class objectClass, String path)` Returns a list of objects of that particular class which are associated to a specific path.
`Collection`	`getObjects(Query query)` Retrieve some objects matching to a query
`Collection`	`getObjects(String query, String language)` Return a list of object matching to a JCR query
`QueryManager`	`getQueryManager()`
`Version`	`getRootVersion(String path)` Get the first object version
`Session`	`getSession()` This method returns the JCR session.
`Version`	`getVersion(String path, String versionName)` Get a particular version
`String[]`	`getVersionLabels(String path, String versionName)` Get all version labels assigned to a particular object version
`void`	`insert(Object object)` Insert an object into the JCR repository
`boolean`	`isLocked(String absPath)` Is that path locked?
`boolean`	`isPersistent(Class clazz)` Can this object content manager insert, update, delete, ... that type?
`Lock`	`lock(String path, boolean isDeep, boolean isSessionScoped)` Lock object saved on .
`void`	`logout()` Close the session
`void`	`move(String srcPath, String destPath)` Move an object
`boolean`	`objectExists(String path)` Check if an object exists
`void`	`refresh(boolean keepChanges)` Refresh the underlying jcr session (see the jcr spec)
`void`	`remove(Object object)` Remove an object from a JCR repository
`void`	`remove(Query query)` Remove all objects matching to a query
`void`	`remove(String path)` Remove an object from a JCR repository
`void`	`retrieveAllMappedAttributes(Object object)` Retrieve all mapped attributes for the given persistent object.
`void`	`retrieveMappedAttribute(Object object, String attributeName)` Retrieve the specified attribute for the given persistent object. this attribute is either a bean or a collection.
`void`	`save()` Save all modifications made by the object content manager
`void`	`unlock(String path, String lockToken)` Unlock object stored on .
`void`	`update(Object object)` Update an object

Method Detail

objectExists

boolean objectExists(String path)
                     throws ObjectContentManagerException

Check if an object exists

Parameters:: path - the object path
Returns:: true if the item exists
Throws:: ObjectContentManagerException - when it is not possible to check if the item exist

isPersistent

boolean isPersistent(Class clazz)

Can this object content manager insert, update, delete, ... that type?

Parameters:: clazz - class for question
Returns:: true if the class is persistence

insert

void insert(Object object)
            throws ObjectContentManagerException

Insert an object into the JCR repository

Parameters:: object - the object to add
Throws:: ObjectContentManagerException - when it is not possible to insert the object

update

void update(Object object)
            throws ObjectContentManagerException

Update an object

Parameters:: object - the object to update
Throws:: ObjectContentManagerException - when it is not possible to update the object