BGRightManager.java

/**
* OLAT - Online Learning and Training<br>
* http://www.olat.org
* <p>
* Licensed under the Apache License, Version 2.0 (the "License"); <br>
* you may not use this file except in compliance with the License.<br>
* You may obtain a copy of the License at
* <p>
* http://www.apache.org/licenses/LICENSE-2.0
* <p>
* Unless required by applicable law or agreed to in writing,<br>
* software distributed under the License is distributed on an "AS IS" BASIS, <br>
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. <br>
* See the License for the specific language governing permissions and <br>
* limitations under the License.
* <p>
* Copyright (c) since 2004 at Multimedia- & E-Learning Services (MELS),<br>
* University of Zurich, Switzerland.
* <hr>
* <a href="http://www.openolat.org">
* OpenOLAT - Online Learning and Training</a><br>
* This file has been modified by the OpenOLAT community. Changes are licensed
* under the Apache 2.0 license as the original file.
*/

package org.olat.group.right;

import java.util.Collection;
import java.util.List;

import org.olat.basesecurity.IdentityRef;
import org.olat.group.BusinessGroup;
import org.olat.resource.OLATResource;

/**
 * Description:<BR>
 * Interface for a business group right manager. The manager proviedes methods
 * to add, remove and find business group rights from/to business groups.
 * <P>
 * Initial Date: Aug 25, 2004
 * 
 * @author gnaegi
 */
public interface BGRightManager {
	/**
	 * Business group rights are stored as permissions. all business group right
	 * permission must use this prefix to work properly
	 */
	public static final String BG_RIGHT_PREFIX = "bgr.";

	/**
	 * Add a business group right to a business group. Don't forget
	 * that a right for business group must start with "bgr." and
	 * that a right must not be longer as 16 characters.
	 * 
	 * @param bgRight
	 * @param rightGroup
	 */
	public void addBGRight(String bgRight, BusinessGroup group, BGRightsRole role);
	
	/**
	 * 
	 * @param bgRight
	 * @param group
	 * @param resource
	 * @param role
	 */
	public void addBGRight(String bgRight, BusinessGroup group, OLATResource resource, BGRightsRole role);

	/**
	 * Remove a business group right from a business group
	 * 
	 * @param bgRight
	 * @param rightGroup
	 */
	public void removeBGRight(String bgRight, BusinessGroup group, OLATResource resource, BGRightsRole role);
	
	/**
	 * 
	 * @param rightGroup
	 * @param resource
	 * @param roles
	 */
	public void removeBGRights(BusinessGroup group, OLATResource resource, BGRightsRole role);
	
	/**
	 * 
	 * @param groups
	 */
	public void removeBGRights(Collection<BusinessGroup> groups, OLATResource resource);

	/**
	 * @param bgRight
	 * @param identity
	 * @param resource
	 * @return true if an identity is in a group that has this business group
	 *         right in the given resource
	 */
	public boolean hasBGRight(String bgRight, IdentityRef identity, OLATResource resource);
	
	/**
	 * 
	 * @param identity
	 * @param resource
	 * @return
	 */
	public List<String> getBGRights(IdentityRef identity, OLATResource resource);

	/**
	 * @param rightGroup
	 * @return a list of all business group rights associated with the given
	 *         business group
	 */
	public List<String> findBGRights(BusinessGroup group, BGRightsRole roles);
	
	/**
	 * 
	 * @param groups
	 * @param resource
	 * @return
	 */
	public List<BGRights> findBGRights(List<BusinessGroup> groups, OLATResource resource);
	
	/**
	 * 
	 * @param groups
	 * @return
	 */
	public boolean hasBGRight(List<BusinessGroup> groups);
}