org.apache.jackrabbit.api.jsr283.retention
Interface Hold


public interface Hold

Hold represents a hold that can be applied to an existing node in order to prevent the node from being modified or removed. The format and interpretation of the name are not specified. They are application-dependent.

If isDeep() is true, the hold applies to the node and its entire subtree. Otherwise the hold applies to the node and its properties only.

Since:
JCR 2.0
See Also:
RetentionManager.getHolds(String), RetentionManager.addHold(String, String, boolean), RetentionManager.removeHold(String, Hold)

Method Summary
 String getName()
          Returns the name of this Hold.
 boolean isDeep()
          Returns true if this Hold is deep.
 

Method Detail

isDeep

boolean isDeep()
               throws RepositoryException
Returns true if this Hold is deep.

Returns:
true if this Hold is deep.
Throws:
RepositoryException - if an error occurs.

getName

String getName()
               throws RepositoryException
Returns the name of this Hold. A JCR name.

Returns:
the name of this Hold. A JCR name.
Throws:
RepositoryException - if an error occurs.


Copyright © 2004-2008 The Apache Software Foundation. All Rights Reserved.