SitesManager


1   /*
2    * Copyright 2004 Outerthought bvba and Schaubroeck nv
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.outerj.daisy.frontend.components.siteconf;
17  
18  import org.apache.cocoon.xml.SaxBuffer;
19  
20  import java.util.Collection  ;
21  import java.util.List  ;
22  
23  public interface SitesManager {
24      public static final String   ROLE = SitesManager.class.getName();
25  
26      /**
27       * Returns the SiteConf object for the named site. This method
28       * throws an exception if it does not exist.
29       */
30      SiteConf getSiteConf(String   siteName) throws Exception  ;
31  
32      /**
33       * Gets the SiteConf object for the named site, does not
34       * throw an exception but returns null if the site does not exist.
35       */
36      SiteConf getSiteConfSoftly(String   name);
37  
38      /**
39       * Returns the global (non-site-specific) skinconf. Can be null.
40       */
41      SaxBuffer getGlobalSkinConf();
42  
43      /**
44       * Returns the global (non-site-specific) skin name. If not explicitely
45       * configured by the user, this returns null.
46       */
47      String   getGlobalSkinName();
48  
49      /**
50       * Returns a list of all available sites. The list
51       * contains the SiteConf object for each site.
52       */
53      List   getSiteConfs() throws Exception  ;
54  
55      String   getGlobalCocoonSitemapLocation();
56  }
57
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags