org.exoplatform.services.jcr.core

Interface ExtendedNode

All Superinterfaces:

javax.jcr.Item, javax.jcr.Node

public interface ExtendedNode
extends javax.jcr.Node

Created by The eXo Platform SAS
This interface provides advanced methods that are not part of the Node Interface defined in the specification JSR-170.

Version:

$Id: ExtendedNode.java 11907 2008-03-13 15:36:21Z ksm $

Author:

Gennady Azarenkov

Level API:

Experimental

Method Summary

Methods

Modifier and Type	Method and Description
void	checkPermission(String actions) Checks if there are permission to perform some actions.
void	clearACL() Clears Access Control List.
AccessControlList	getACL()
String	getIdentifier() Get unique node identifier.
long	getNodesCount() Returns the number of children nodes.
javax.jcr.NodeIterator	getNodesLazily() Returns a NodeIterator over all child Nodes of this Node.
javax.jcr.NodeIterator	getNodesLazily(int pageSize) Returns a NodeIterator over all child Nodes of this Node.
boolean	isNodeType(InternalQName qName)
javax.jcr.lock.Lock	lock(boolean isDeep, long timeOut) Places a lock on this node.
void	removePermission(String identity) Removes permissions for particular identity.
void	removePermission(String identity, String permission) Removes specified permission for particular identity.
void	setPermission(String identity, String[] permission) Sets permissions for particular identity.
void	setPermissions(Map<String,String[]> permissions) Sets permission.

Methods inherited from interface javax.jcr.Node

addMixin, addNode, addNode, canAddMixin, cancelMerge, checkin, checkout, doneMerge, getBaseVersion, getCorrespondingNodePath, getDefinition, getIndex, getLock, getMixinNodeTypes, getNode, getNodes, getNodes, getPrimaryItem, getPrimaryNodeType, getProperties, getProperties, getProperty, getReferences, getUUID, getVersionHistory, hasNode, hasNodes, hasProperties, hasProperty, holdsLock, isCheckedOut, isLocked, isNodeType, lock, merge, orderBefore, removeMixin, restore, restore, restore, restoreByLabel, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, unlock, update

Methods inherited from interface javax.jcr.Item

accept, getAncestor, getDepth, getName, getParent, getPath, getSession, isModified, isNew, isNode, isSame, refresh, remove, save

Method Detail

setPermissions

void setPermissions(Map<String,String[]> permissions)
                    throws javax.jcr.RepositoryException,
                           AccessControlException

Sets permission.

Parameters:

permissions -

Throws:

javax.jcr.RepositoryException

AccessControlException

getACL

AccessControlList getACL()
                         throws javax.jcr.RepositoryException

Returns:

Access Control List

Throws:

javax.jcr.RepositoryException

getIdentifier

String getIdentifier()
                     throws javax.jcr.RepositoryException

Get unique node identifier.

Returns:

node identifier

Throws:

javax.jcr.RepositoryException - if any repository errors occurs

clearACL

void clearACL()
              throws javax.jcr.RepositoryException,
                     AccessControlException

Clears Access Control List.

Throws:

javax.jcr.RepositoryException

AccessControlException

removePermission

void removePermission(String identity)
                      throws javax.jcr.RepositoryException,
                             AccessControlException

Removes permissions for particular identity.

Parameters:

identity -

Throws:

javax.jcr.RepositoryException

AccessControlException

removePermission

void removePermission(String identity,
                    String permission)
                      throws javax.jcr.RepositoryException,
                             AccessControlException

Removes specified permission for particular identity.

Parameters:

identity -

Throws:

javax.jcr.RepositoryException

AccessControlException

setPermission

void setPermission(String identity,
                 String[] permission)
                   throws javax.jcr.RepositoryException,
                          AccessControlException

Sets permissions for particular identity.

Parameters:

identity -

permission -

Throws:

javax.jcr.RepositoryException

AccessControlException

checkPermission

void checkPermission(String actions)
                     throws AccessControlException,
                            javax.jcr.RepositoryException

Checks if there are permission to perform some actions.

Parameters:

actions -

Throws:

AccessControlException - if no such permissions found

javax.jcr.RepositoryException

isNodeType

boolean isNodeType(InternalQName qName)
                   throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

lock

javax.jcr.lock.Lock lock(boolean isDeep,
                       long timeOut)
                         throws javax.jcr.UnsupportedRepositoryOperationException,
                                javax.jcr.lock.LockException,
                                javax.jcr.AccessDeniedException,
                                javax.jcr.InvalidItemStateException,
                                javax.jcr.RepositoryException

Places a lock on this node.

Throws:

javax.jcr.UnsupportedRepositoryOperationException

javax.jcr.lock.LockException

javax.jcr.AccessDeniedException

javax.jcr.InvalidItemStateException

javax.jcr.RepositoryException

getNodesCount

long getNodesCount()
                   throws javax.jcr.RepositoryException

Returns the number of children nodes.

Throws:

javax.jcr.RepositoryException - If an error occurs.

getNodesLazily

javax.jcr.NodeIterator getNodesLazily()
                                      throws javax.jcr.RepositoryException

Returns a NodeIterator over all child Nodes of this Node. Does not include properties of this Node. If this node has no child nodes, then an empty iterator is returned.

Returns:

A NodeIterator over all child Nodes of this Node.

Throws:

javax.jcr.RepositoryException - If an error occurs.

getNodesLazily

javax.jcr.NodeIterator getNodesLazily(int pageSize)
                                      throws javax.jcr.RepositoryException

Returns a NodeIterator over all child Nodes of this Node. Does not include properties of this Node. If this node has no child nodes, then an empty iterator is returned.

Parameters:

pageSize - the amount of the nodes which can be retrieved from the storage per request

Returns:

A NodeIterator over all child Nodes of this Node.

Throws:

javax.jcr.RepositoryException - If an error occurs.