001/* 002 * Copyright 2010 Anyware Services 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); 005 * you may not use this file except in compliance with the License. 006 * You may obtain a copy of the License at 007 * 008 * http://www.apache.org/licenses/LICENSE-2.0 009 * 010 * Unless required by applicable law or agreed to in writing, software 011 * distributed under the License is distributed on an "AS IS" BASIS, 012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 013 * See the License for the specific language governing permissions and 014 * limitations under the License. 015 */ 016package org.ametys.web.repository.page; 017 018import java.util.Set; 019 020import org.ametys.web.repository.site.Site; 021 022 023/** 024 * A ContentTypesAssignementHandler is responsible for giving the available content types list for a given Zone. 025 * This list can be computed according any application needs, such as Rights of the logged in user, path of the Page, ... 026 */ 027public interface ContentTypesAssignmentHandler 028{ 029 /** The Avalon Role */ 030 public static final String ROLE = ContentTypesAssignmentHandler.class.getName(); 031 032 /** 033 * Returns the list of available content types for a given {@link Site} 034 * @param site the site to consider 035 * @return the list of available content types id 036 */ 037 public Set<String> getAvailableContentTypes (Site site); 038 039 /** 040 * Returns the list of available content types for a given {@link Site} 041 * @param site the site to consider 042 * @param includePrivate true to include private content types 043 * @return the list of available content types id 044 */ 045 public Set<String> getAvailableContentTypes (Site site, boolean includePrivate); 046 047 /** 048 * Returns the list of available content types for a given {@link Page} and zone name. 049 * @param page the Page to consider 050 * @param zoneName the zone name to consider 051 * @return the list of available content types id 052 */ 053 public Set<String> getAvailableContentTypes (Page page, String zoneName); 054 055 /** 056 * Returns the list of available content types for a given {@link Page} and zone name. 057 * @param page the Page to consider 058 * @param zoneName the zone name to consider 059 * @param includePrivate true to include private content types 060 * @return the list of available content types id 061 */ 062 public Set<String> getAvailableContentTypes (Page page, String zoneName, boolean includePrivate); 063}