phpcr/src/PHPCR/Retention/HoldInterface.php

Show:

inherited

Table of Contents

This file is part of the PHPCR API and was originally ported from the Java JCR API to PHP by Karsten Dambekalns for the FLOW3 project.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

License: Apache Software License 2.0
Link: http://phpcr.github.com/

\PHPCR\Retention\HoldInterface
jump to top

Package: Default

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 subgraph. Otherwise the hold applies to the node and its properties only.

Api

Methods

getName() : string

Returns the name of this Hold.

A JCR name.

Returns

Type	Description
string	the name of this Hold. A JCR name.

Throws

Exception	Description
\PHPCR\RepositoryException	if an error occurs.

Details

Api

isDeep() : boolean

Returns true if this Hold is deep.