org.apache.lenya.core.identity/src/main/java/org/apache/lenya/ac/Groupable.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 *  contributor license agreements.  See the NOTICE file distributed with
 *  this work for additional information regarding copyright ownership.
 *  The ASF licenses this file to You 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.apache.lenya.ac;

/**
 * Generalized interface of group member objects.
 * @version $Id$
 */
public interface Groupable {
    
    /**
     * Notifies this Groupable of being added to a group.
     * @param group The group.
     */
    void addedToGroup(Group group);

    /**
     * Notifies this Groupable of being removed from a group.
     * @param group The group.
     */
    void removedFromGroup(Group group);

    /**
     * Returns all groups that contain this Groupable.
     * @return A {@link Group} array.
     */
    Group[] getGroups();
    
    /**
     * Removes this Groupable from all groups.
     */
    void removeFromAllGroups();
}