SiteConf


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.outerj.daisy.repository.VariantKey;
19  import org.outerj.daisy.repository.VersionState;
20  import org.outerj.daisy.repository.LockType;
21  import org.outerj.daisy.navigation.LookupAlternative;
22  import org.outerj.daisy.frontend.WikiVersionMode;
23  import org.apache.cocoon.xml.SaxBuffer;
24  
25  import java.io.File  ;
26  
27  public interface SiteConf {
28      VariantKey getNavigationDoc();
29  
30      long getNavigationDocId();
31  
32      /**
33       *
34       * @return -1 if there is no homepage document ID specified.
35       */
36      long getHomePageDocId();
37  
38      String   getHomePage();
39  
40      long getCollectionId();
41  
42      boolean contextualizedTree();
43  
44      String   getName();
45  
46      String   getTitle();
47  
48      String   getDescription();
49  
50      String   getSkin();
51  
52      String   getCocoonSitemapLocation();
53  
54      String   getGlobalCocoonSitemapLocation();
55  
56      VersionState getNewVersionStateDefault();
57  
58      boolean getAutomaticLocking();
59  
60      LockType getLockType();
61  
62      /**
63       * Default lock time in milliseconds.
64       */
65      long getDefaultLockTime();
66  
67      boolean getAutoExtendLock();
68  
69      /**
70       * A SaxBuffer containing XML configuration data intended to customise the skin.
71       * The SaxBuffer does not contain startDocument and endDocument events.
72       */
73      SaxBuffer getSkinConf();
74  
75      long getBranchId();
76  
77      long getLanguageId();
78  
79      File   getDirectory();
80  
81      /**
82       * Returns -1 if no default configured.
83       */
84      long getDefaultDocumentTypeId();
85  
86      String   getPublisherRequestSet();
87  
88      /**
89       * Returns the lookup alternatives for navigation lookups. This list should
90       * contain at least one entry, the first entry should always represent the current
91       * site.
92       */
93      LookupAlternative[] getNavigationLookupAlternatives(WikiVersionMode versionMode);
94  }
95
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags