Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
WikiComponentConstants | 33 | 0 | - | 0 | 0 |
1 | /* | |
2 | * See the NOTICE file distributed with this work for additional | |
3 | * information regarding copyright ownership. | |
4 | * | |
5 | * This is free software; you can redistribute it and/or modify it | |
6 | * under the terms of the GNU Lesser General Public License as | |
7 | * published by the Free Software Foundation; either version 2.1 of | |
8 | * the License, or (at your option) any later version. | |
9 | * | |
10 | * This software is distributed in the hope that it will be useful, | |
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 | * Lesser General Public License for more details. | |
14 | * | |
15 | * You should have received a copy of the GNU Lesser General Public | |
16 | * License along with this software; if not, write to the Free | |
17 | * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA | |
18 | * 02110-1301 USA, or see the FSF site: http://www.fsf.org. | |
19 | */ | |
20 | package org.xwiki.component.wiki.internal; | |
21 | ||
22 | import org.xwiki.model.EntityType; | |
23 | import org.xwiki.model.reference.EntityReference; | |
24 | ||
25 | import com.xpn.xwiki.user.api.XWikiRightService; | |
26 | ||
27 | /** | |
28 | * Constants for XClasses and XProperties. | |
29 | * | |
30 | * @version $Id: 107f5019b821333ec031800eac63c42e62ebca73 $ | |
31 | * @since 4.2M3 | |
32 | */ | |
33 | public interface WikiComponentConstants | |
34 | { | |
35 | /** | |
36 | * Author of the XClass documents. | |
37 | */ | |
38 | String CLASS_AUTHOR = XWikiRightService.SUPERADMIN_USER; | |
39 | ||
40 | /** | |
41 | * Space of the XClass documents. | |
42 | */ | |
43 | EntityReference CLASS_SPACE_REFERENCE = new EntityReference("XWiki", EntityType.SPACE); | |
44 | ||
45 | /** | |
46 | * The XClass defining a component implementation. | |
47 | */ | |
48 | @Deprecated | |
49 | String COMPONENT_CLASS = "XWiki.ComponentClass"; | |
50 | ||
51 | /** | |
52 | * The XClass defining a component implementation. | |
53 | */ | |
54 | EntityReference COMPONENT_CLASS_REFERENCE = new EntityReference("ComponentClass", EntityType.DOCUMENT) | |
55 | .appendParent(CLASS_SPACE_REFERENCE); | |
56 | ||
57 | /** | |
58 | * The XClass defining a component injection. | |
59 | */ | |
60 | @Deprecated | |
61 | String DEPENDENCY_CLASS = "XWiki.ComponentDependencyClass"; | |
62 | ||
63 | /** | |
64 | * The XClass defining a component injection. | |
65 | */ | |
66 | EntityReference DEPENDENCY_CLASS_REFERENCE = new EntityReference("ComponentDependencyClass", EntityType.DOCUMENT) | |
67 | .appendParent(CLASS_SPACE_REFERENCE); | |
68 | ||
69 | /** | |
70 | * The XClass defining a component method. | |
71 | */ | |
72 | @Deprecated | |
73 | String METHOD_CLASS = "XWiki.ComponentMethodClass"; | |
74 | ||
75 | /** | |
76 | * The XClass defining a component method. | |
77 | */ | |
78 | EntityReference METHOD_CLASS_REFRENCE = new EntityReference("ComponentMethodClass", EntityType.DOCUMENT) | |
79 | .appendParent(CLASS_SPACE_REFERENCE); | |
80 | ||
81 | /** | |
82 | * The XClass defining a component interface implementation. | |
83 | */ | |
84 | @Deprecated | |
85 | String INTERFACE_CLASS = "XWiki.ComponentInterfaceClass"; | |
86 | ||
87 | /** | |
88 | * The XClass defining a component interface implementation. | |
89 | */ | |
90 | EntityReference INTERFACE_CLASS_REFERENCE = new EntityReference("ComponentInterfaceClass", EntityType.DOCUMENT) | |
91 | .appendParent(CLASS_SPACE_REFERENCE); | |
92 | ||
93 | /** | |
94 | * The name property of the {@link #INTERFACE_CLASS} XClass. | |
95 | */ | |
96 | String INTERFACE_NAME_FIELD = "name"; | |
97 | ||
98 | /** | |
99 | * The name property of the {@link #METHOD_CLASS} XClass. | |
100 | */ | |
101 | String METHOD_NAME_FIELD = INTERFACE_NAME_FIELD; | |
102 | ||
103 | /** | |
104 | * The code property of the {@link #METHOD_CLASS} XClass. | |
105 | */ | |
106 | String METHOD_CODE_FIELD = "code"; | |
107 | ||
108 | /** | |
109 | * The role hint property of both {@link #COMPONENT_CLASS} and {@link #DEPENDENCY_CLASS}. | |
110 | */ | |
111 | String COMPONENT_ROLE_HINT_FIELD = "roleHint"; | |
112 | ||
113 | /** | |
114 | * The role type property of both {@link #COMPONENT_CLASS} and {@link #DEPENDENCY_CLASS}. | |
115 | */ | |
116 | String COMPONENT_ROLE_TYPE_FIELD = "roleType"; | |
117 | /** | |
118 | * The scope of the {@link #COMPONENT_CLASS}. | |
119 | */ | |
120 | String COMPONENT_SCOPE_FIELD = "scope"; | |
121 | ||
122 | /** | |
123 | * The binding name property of {@link #DEPENDENCY_CLASS}. | |
124 | */ | |
125 | String DEPENDENCY_BINDING_NAME_FIELD = "bindingName"; | |
126 | } |