org.apache.jackrabbit.rmi.remote
Interface RemoteItem

All Superinterfaces:

Remote

All Known Subinterfaces:

RemoteNode, RemoteProperty, RemoteVersion, RemoteVersionHistory

All Known Implementing Classes:

ServerItem, ServerNode, ServerProperty, ServerVersion, ServerVersionHistory

public interface RemoteItem

extends Remote

Remote version of the JCR Item interface. Used by the ServerItem and ClientItem adapter base classes to provide transparent RMI access to remote items.

The methods in this interface are documented only with a reference to a corresponding Item method. The remote object will simply forward the method call to the underlying Item instance. Argument and return values, as well as possible exceptions, are copied over the network. Compex return values (Items and Nodes) are returned as remote references to the corresponding remote interfaces. RMI errors are signalled with RemoteExceptions.

Author:

Jukka Zitting

See Also:

Item, ClientItem, ServerItem

Method Summary

RemoteItem	getAncestor(int level) Remote version of the Item.getAncestor(int) method.
int	getDepth() Remote version of the Item.getDepth() method.
String	getName() Remote version of the Item.getName() method.
RemoteNode	getParent() Remote version of the Item.getParent() method.
String	getPath() Remote version of the Item.getPath() method.
boolean	isModified() Remote version of the Item.isModified() method.
boolean	isNew() Remote version of the Item.isNew() method.
void	refresh(boolean keepChanges) Remote version of the Item.refresh(boolean) method.
void	remove() Remote version of the Item.remove() method.
void	save() Remote version of the Item.save() method.

Method Detail

getPath

public String getPath()
               throws RepositoryException,
                      RemoteException

Remote version of the Item.getPath() method.

Returns:

item path

Throws:

RepositoryException - on repository errors

RemoteException - on RMI errors

getName

public String getName()
               throws RepositoryException,
                      RemoteException

Remote version of the Item.getName() method.

Returns:

item name

Throws:

RepositoryException - on repository errors

RemoteException - on RMI errors

getAncestor

public RemoteItem getAncestor(int level)
                       throws RepositoryException,
                              RemoteException

Remote version of the Item.getAncestor(int) method.

Parameters:

level - ancestor level

Returns:

ancestor item

Throws:

RepositoryException - on repository errors

RemoteException - on RMI errors

getParent

public RemoteNode getParent()
                     throws RepositoryException,
                            RemoteException

Remote version of the Item.getParent() method.

Returns:

parent node

Throws:

RepositoryException - on repository errors

RemoteException - on RMI errors

getDepth

public int getDepth()
             throws RepositoryException,
                    RemoteException

Remote version of the Item.getDepth() method.

Returns:

item depth

Throws:

RepositoryException - on repository errors

RemoteException - on RMI errors

isNew

public boolean isNew()
              throws RemoteException

Remote version of the Item.isNew() method.

Returns:

true if the item is new, false otherwise

Throws:

RemoteException - on RMI errors

isModified

public boolean isModified()
                   throws RemoteException

Remote version of the Item.isModified() method.

Returns:

true if the item is modified, false otherwise

Throws:

RemoteException - on RMI errors

save

public void save()
          throws RepositoryException,
                 RemoteException

Remote version of the Item.save() method.

Throws:

RepositoryException - on repository errors

RemoteException - on RMI errors

refresh

public void refresh(boolean keepChanges)
             throws RepositoryException,
                    RemoteException

Remote version of the Item.refresh(boolean) method.

Parameters:

keepChanges - flag to keep transient changes

Throws:

RepositoryException - on repository errors

RemoteException - on RMI errors

remove

public void remove()
            throws RepositoryException,
                   RemoteException

Remote version of the Item.remove() method.

Throws:

RepositoryException - on repository errors

RemoteException - on RMI errors