/* Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
 *
 * 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.
 */

package org.acegisecurity.acls;

import org.acegisecurity.acls.objectidentity.ObjectIdentity;


/**
 * Provides support for creating and storing <code>Acl</code> instances.
 *
 * @author Ben Alex
 * @version $Id$
 */
public interface MutableAclService extends AclService {
    //~ Methods ========================================================================================================

    /**
     * Creates an empty <code>Acl</code> object in the database. It will have no entries. The returned object
     * will then be used to add entries.
     *
     * @param object the object identity to create
     *
     * @return an ACL object with its ID set
     *
     * @throws AlreadyExistsException if the passed object identity already has a record
     */
    public MutableAcl createAcl(ObjectIdentity object)
        throws AlreadyExistsException;

    /**
     * Removes the specified entry from the database.
     *
     * @param object the object identity to remove
     * @param deleteChildren whether to cascade the delete to children
     *
     * @throws ChildrenExistException if the deleteChildren argument was <code>false</code> but children exist
     */
    public void deleteAcl(ObjectIdentity object, boolean deleteChildren)
        throws ChildrenExistException;

    /**
     * Locates all object identities that use the specified parent.  This is useful for administration tools,
     * and before issuing a {@link #deleteAcl(ObjectIdentity, boolean)}.
     *
     * @param parentIdentity to locate children of
     *
     * @return the children (or <code>null</code> if none were found)
     */
    public ObjectIdentity[] findChildren(ObjectIdentity parentIdentity);

    /**
     * Changes an existing <code>Acl</code> in the database.
     *
     * @param acl to modify
     *
     * @throws NotFoundException if the relevant record could not be found (did you remember to use {@link
     *         #createAcl(ObjectIdentity)} to create the object, rather than creating it with the <code>new</code>
     *         keyword?)
     */
    public void updateAcl(MutableAcl acl) throws NotFoundException;
}
