HtmlEditorsService


1   //
2   //                                   ____.
3   //                       __/\ ______|    |__/\.     _______
4   //            __   .____|    |       \   |    +----+       \
5   //    _______|  /--|    |    |    -   \  _    |    :    -   \_________
6   //   \\______: :---|    :    :           |    :    |         \________>
7   //           |__\---\_____________:______:    :____|____:_____\
8   //                                      /_____|
9   //
10  //                 . . . i n   j a h i a   w e   t r u s t . . .
11  //
12  //
13  package org.jahia.services.htmleditors;
14  
15  import java.util.Enumeration  ;
16  
17  import org.jahia.exceptions.JahiaException;
18  import org.jahia.services.JahiaService;
19  
20  /**
21   * Html Editors Service
22   *
23   * @author Khue Nguyen
24   */
25  public abstract class HtmlEditorsService extends JahiaService
26  {
27      protected String   configFileName = "htmleditors_config.xml";
28  
29      /**
30       * Reload configuration file from disk
31       *
32       * @throws JahiaException
33       */
34      public abstract void reloadConfigurationFile() throws JahiaException;
35  
36      /**
37       * Returns an enumeration of all Html Editors registered in the System
38       *
39       * @return all Html Editors registered in the system
40       * @throws JahiaException
41       */
42      public abstract Enumeration   getEditors() throws JahiaException;
43  
44      /**
45       * Returns an enumeration of all Html Editor CSSs a given site can view.
46       *
47       * @param siteID
48       * @return all Html Editor CSSs a given site can view
49       * @throws JahiaException
50       */
51      public abstract Enumeration   getCSSs(int siteID) throws JahiaException;
52  
53      /**
54       * Returns an enumeration of all Html Editors a given site can view.
55       *
56       * @param siteID
57       * @return all Html Editors a given site can view
58       * @throws JahiaException
59       */
60      public abstract Enumeration   getEditors(int siteID) throws JahiaException;
61  
62      /**
63       * Returns an Editor looking at it id
64       *
65       * @param id the Editor identifier
66       * @return an Editor looking at it id
67       * @throws JahiaException
68       */
69      public abstract HtmlEditor getEditor(String   id) throws JahiaException;
70  
71      /**
72       * Authorize the site to use the given Editor
73       *
74       * @param siteID
75       * @param id the Editor identifier
76       * @throws JahiaException
77       */
78      public abstract void authorizeSite(int siteID, String   id) throws JahiaException;
79  
80      /**
81       * unauthorize the site to use the given Editor
82       *
83       * @param siteID
84       * @param id
85       * @throws JahiaException
86       */
87      public abstract void unAuthorizeSite(int siteID, String   id) throws JahiaException;
88  
89      /**
90       * Returns true if the site has autorization to use the given Editor
91       *
92       * @param siteID
93       * @param id the Editor identifier
94       * @return true if the site has autorization to use the given Editor
95       */
96      public abstract boolean isSiteAutorized(int siteID, String   id);
97  
98  }
99  
100
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags