javax.jcr.retention.Hold Maven / Gradle / Ivy
Show all versions of aem-sdk-api Show documentation
/*
* Copyright 2008 Day Management AG, Switzerland. All rights reserved.
*/
package javax.jcr.retention;
import javax.jcr.RepositoryException;
/**
* 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 {@link #isDeep()} is true, the hold applies to the node and
* its entire subgraph. Otherwise the hold applies to the node and its
* properties only.
*
* @see RetentionManager#getHolds(String)
* @see RetentionManager#addHold(String, String, boolean)
* @see RetentionManager#removeHold(String, Hold)
* @since JCR 2.0
*/
public interface Hold {
/**
* Returns true if this Hold is deep.
*
* @return true if this Hold is deep.
* @throws RepositoryException if an error occurs.
*/
public boolean isDeep() throws RepositoryException;
/**
* Returns the name of this Hold. A JCR name.
*
* @return the name of this Hold. A JCR name.
* @throws RepositoryException if an error occurs.
*/
public String getName() throws RepositoryException;
}