@sitevision/api 2.0.0-alpha.1 → 2023.2.1-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (280) hide show
  1. package/client/requester/index.d.ts +10 -8
  2. package/client/toasts/index.d.ts +7 -5
  3. package/common/app/index.d.ts +45 -46
  4. package/common/events/index.d.ts +30 -31
  5. package/common/i18n/index.d.ts +7 -5
  6. package/common/router/index.d.ts +72 -77
  7. package/common/security/index.d.ts +27 -21
  8. package/index.d.ts +8 -0
  9. package/package.json +1 -1
  10. package/server/AliasUtil/index.d.ts +11 -9
  11. package/server/ArchiveUtil/index.d.ts +43 -41
  12. package/server/ArraysInstance/index.d.ts +1666 -1807
  13. package/server/ArticleUtil/index.d.ts +292 -224
  14. package/server/AuthenticationUtil/index.d.ts +72 -84
  15. package/server/BookmarkUtil/index.d.ts +74 -79
  16. package/server/BuddyIconRenderer/index.d.ts +123 -131
  17. package/server/BuddyIconRenderer.BuddyIconSize/index.d.ts +41 -0
  18. package/server/BuddyIconRenderer.BuddyIconSize/index.js +25 -0
  19. package/server/ClientUtil/index.d.ts +10 -8
  20. package/server/CollaborationFactory/index.d.ts +37 -40
  21. package/server/CollaborationGroupFolderUtil/index.d.ts +28 -26
  22. package/server/CollaborationGroupState/index.d.ts +27 -0
  23. package/server/CollaborationGroupState/index.js +11 -0
  24. package/server/CollaborationGroupTemplateUtil/index.d.ts +46 -48
  25. package/server/CollaborationGroupType/index.d.ts +28 -0
  26. package/server/CollaborationGroupType/index.js +12 -0
  27. package/server/CollaborationGroupUtil/index.d.ts +84 -80
  28. package/server/CollectionsInstance/index.d.ts +641 -704
  29. package/server/ColorUtil/index.d.ts +34 -35
  30. package/server/CompoundAndFilterBuilder/index.d.ts +28 -26
  31. package/server/CompoundComparatorBuilder/index.d.ts +33 -31
  32. package/server/CompoundOrFilterBuilder/index.d.ts +28 -26
  33. package/server/ContentNodeUtil/index.d.ts +34 -32
  34. package/server/CurrencyFactory/index.d.ts +70 -68
  35. package/server/DateUtil/index.d.ts +131 -141
  36. package/server/DecorationUtil/index.d.ts +11 -9
  37. package/server/DeviceUtil/index.d.ts +19 -17
  38. package/server/DimensionMode/index.d.ts +17 -0
  39. package/server/DimensionMode/index.js +12 -0
  40. package/server/DirectoryUtil/index.d.ts +87 -85
  41. package/server/DocType/index.d.ts +30 -0
  42. package/server/DocType/index.js +14 -0
  43. package/server/DocTypeUtil/index.d.ts +127 -133
  44. package/server/EndecUtil/index.d.ts +329 -346
  45. package/server/ExtendedDismaxParserBuilder/index.d.ts +153 -167
  46. package/server/FileIconRenderer/index.d.ts +152 -171
  47. package/server/FileUtil/index.d.ts +272 -298
  48. package/server/FilterBuilder/index.d.ts +39 -37
  49. package/server/FolderUtil/index.d.ts +91 -92
  50. package/server/FontUtil/index.d.ts +34 -35
  51. package/server/FormatterBuilderFactory/index.d.ts +73 -81
  52. package/server/HighlightBuilder/index.d.ts +76 -83
  53. package/server/IconUtil/index.d.ts +25 -23
  54. package/server/ImageLinkRenderer/index.d.ts +35 -33
  55. package/server/ImageRenderer/index.d.ts +340 -376
  56. package/server/ImageUtil/index.d.ts +245 -263
  57. package/server/IndexUtil/index.d.ts +38 -35
  58. package/server/IndexUtil.IndexType/index.d.ts +29 -0
  59. package/server/IndexUtil.IndexType/index.js +13 -0
  60. package/server/IndexingUtil/index.d.ts +67 -45
  61. package/server/InstanceCreatorUtil/index.d.ts +423 -459
  62. package/server/InstanceTypeUtil/index.d.ts +167 -188
  63. package/server/JwtUtil/index.d.ts +129 -127
  64. package/server/LandingPageUtil/index.d.ts +82 -85
  65. package/server/LandingPageUtil/index.js +1 -0
  66. package/server/LinkPageUtil/index.d.ts +294 -248
  67. package/server/LinkRenderer/index.d.ts +649 -713
  68. package/server/LinkTargetBuilder/index.d.ts +65 -73
  69. package/server/LinkValueBuilder/index.d.ts +66 -73
  70. package/server/ListWrapper/index.d.ts +80 -89
  71. package/server/LocaleUtil/index.d.ts +381 -393
  72. package/server/LogUtil/index.d.ts +118 -127
  73. package/server/MailBuilder/index.d.ts +106 -121
  74. package/server/MailUtil/index.d.ts +58 -63
  75. package/server/MathInstance/index.d.ts +624 -656
  76. package/server/MessageDigesterFactory/index.d.ts +28 -26
  77. package/server/MetadataDefinitionUtil/index.d.ts +77 -81
  78. package/server/MetadataUtil/index.d.ts +321 -345
  79. package/server/MimeTypeUtil/index.d.ts +208 -214
  80. package/server/MonitorBuilder/index.d.ts +17 -17
  81. package/server/NodeComparatorUtil/index.d.ts +214 -224
  82. package/server/NodeFactoryUtil/index.d.ts +19 -17
  83. package/server/NodeFilterUtil/index.d.ts +651 -738
  84. package/server/NodeIteratorUtil/index.d.ts +209 -224
  85. package/server/NodeResolverUtil/index.d.ts +398 -404
  86. package/server/NodeTreeUtil/index.d.ts +211 -226
  87. package/server/NodeTypeUtil/index.d.ts +1430 -546
  88. package/server/OfflineVersionPropertyUtil/index.d.ts +6 -4
  89. package/server/OnlineVersionPropertyUtil/index.d.ts +6 -4
  90. package/server/OutputUtil/index.d.ts +384 -379
  91. package/server/PageUtil/index.d.ts +264 -186
  92. package/server/PermissionUtil/index.d.ts +391 -428
  93. package/server/PermissionUtil.Permission/index.d.ts +54 -0
  94. package/server/PermissionUtil.Permission/index.js +38 -0
  95. package/server/PortletContextUtil/index.d.ts +111 -106
  96. package/server/PortletUtil/index.d.ts +30 -20
  97. package/server/PrincipalUtil/index.d.ts +33 -31
  98. package/server/Properties/index.d.ts +68 -75
  99. package/server/PropertyUtil/index.d.ts +1419 -1461
  100. package/server/PublishingUtil/index.d.ts +246 -247
  101. package/server/QueryStringUtil/index.d.ts +403 -414
  102. package/server/RedirectUtil/index.d.ts +62 -66
  103. package/server/RelatedValueBuilder/index.d.ts +40 -38
  104. package/server/Requester/index.d.ts +123 -123
  105. package/server/ResourceLocatorUtil/index.d.ts +434 -474
  106. package/server/RestApi/index.d.ts +156 -136
  107. package/server/RestAppInvokerFactory/index.d.ts +25 -23
  108. package/server/RoleAssignmentBuilder/index.d.ts +35 -33
  109. package/server/RoleMatcherBuilder/index.d.ts +35 -33
  110. package/server/RoleUtil/index.d.ts +35 -37
  111. package/server/ScriptUtil/index.d.ts +457 -494
  112. package/server/SearchFactory/index.d.ts +102 -117
  113. package/server/SearchUtil/index.d.ts +73 -71
  114. package/server/SearcherBuilder/index.d.ts +107 -114
  115. package/server/Session/index.d.ts +251 -1093
  116. package/server/Session/index.js +1 -20
  117. package/server/SimpleUserUtil/index.d.ts +26 -27
  118. package/server/SiteCookieUtil/index.d.ts +150 -173
  119. package/server/SortBuilder/index.d.ts +24 -22
  120. package/server/SourceSetMode/index.d.ts +12 -0
  121. package/server/SourceSetMode/index.js +12 -0
  122. package/server/SpellCheckBuilder/index.d.ts +27 -27
  123. package/server/StandardParserBuilder/index.d.ts +33 -31
  124. package/server/StructureUtil/index.d.ts +83 -81
  125. package/server/SubscriberUtil/index.d.ts +58 -65
  126. package/server/SubscriptionUtil/index.d.ts +121 -128
  127. package/server/SystemUserUtil/index.d.ts +146 -144
  128. package/server/TagUtil/index.d.ts +113 -118
  129. package/server/TemplateUtil/index.d.ts +113 -118
  130. package/server/TemporaryFileNodeBuilder/index.d.ts +29 -27
  131. package/server/TemporaryNodeBuilder/index.d.ts +136 -174
  132. package/server/TextModuleRendererBuilder/index.d.ts +18 -16
  133. package/server/TimestampUtil/index.d.ts +102 -116
  134. package/server/TranslationUtil/index.d.ts +96 -102
  135. package/server/TrashcanUtil/index.d.ts +112 -115
  136. package/server/UserDataUtil/index.d.ts +108 -109
  137. package/server/UserFactory/index.d.ts +49 -56
  138. package/server/UserFieldRenderer/index.d.ts +118 -126
  139. package/server/UserIdentityUtil/index.d.ts +36 -34
  140. package/server/UserUtil/index.d.ts +30 -28
  141. package/server/Utils/index.d.ts +702 -791
  142. package/server/VelocityRenderer/index.d.ts +94 -92
  143. package/server/VersionUtil/index.d.ts +24 -8
  144. package/server/WebContentUtil/index.d.ts +275 -282
  145. package/server/WebResourceFactory/index.d.ts +46 -51
  146. package/server/XSLTUtil/index.d.ts +33 -31
  147. package/server/XmlParserUtil/index.d.ts +47 -45
  148. package/server/appData/index.d.ts +8 -6
  149. package/server/appInfo/index.d.ts +6 -2
  150. package/server/appResource/index.d.ts +23 -21
  151. package/server/cache/index.d.ts +8 -6
  152. package/server/globalAppData/index.d.ts +8 -6
  153. package/server/headless/index.d.ts +28 -26
  154. package/server/hooks/index.d.ts +9 -9
  155. package/server/oauth2/index.d.ts +12 -10
  156. package/server/privileged/index.d.ts +24 -22
  157. package/server/storage/index.d.ts +22 -20
  158. package/types/javax/jcr/Binary/index.d.ts +0 -20
  159. package/types/javax/jcr/Binary/index.js +0 -1
  160. package/types/javax/jcr/ImportUUIDBehavior/index.d.ts +24 -0
  161. package/types/javax/jcr/Item/index.d.ts +1 -116
  162. package/types/javax/jcr/Item/index.js +0 -6
  163. package/types/javax/jcr/NamespaceRegistry/index.d.ts +66 -42
  164. package/types/javax/jcr/NamespaceRegistry/index.js +0 -2
  165. package/types/javax/jcr/Node/index.d.ts +24 -1495
  166. package/types/javax/jcr/Node/index.js +1 -34
  167. package/types/javax/jcr/NodeIterator/index.d.ts +1 -1
  168. package/types/javax/jcr/Property/index.d.ts +487 -489
  169. package/types/javax/jcr/Property/index.js +0 -5
  170. package/types/javax/jcr/PropertyIterator/index.d.ts +1 -1
  171. package/types/javax/jcr/RangeIterator/index.d.ts +1 -43
  172. package/types/javax/jcr/RangeIterator/index.js +1 -5
  173. package/types/javax/jcr/Repository/index.d.ts +460 -260
  174. package/types/javax/jcr/Repository/index.js +0 -4
  175. package/types/javax/jcr/Value/index.d.ts +0 -29
  176. package/types/javax/jcr/Value/index.js +0 -2
  177. package/types/javax/jcr/ValueFactory/index.d.ts +0 -70
  178. package/types/javax/jcr/ValueFactory/index.js +1 -2
  179. package/types/javax/jcr/Workspace/index.d.ts +93 -569
  180. package/types/javax/jcr/Workspace/index.js +1 -12
  181. package/types/javax/jcr/nodetype/ItemDefinition/index.d.ts +0 -103
  182. package/types/javax/jcr/nodetype/ItemDefinition/index.js +0 -5
  183. package/types/javax/jcr/nodetype/NodeDefinition/index.d.ts +1 -1
  184. package/types/javax/jcr/nodetype/NodeDefinitionTemplate/index.d.ts +1 -1
  185. package/types/javax/jcr/nodetype/NodeType/index.d.ts +255 -264
  186. package/types/javax/jcr/nodetype/NodeType/index.js +1 -12
  187. package/types/javax/jcr/nodetype/NodeTypeDefinition/index.d.ts +0 -104
  188. package/types/javax/jcr/nodetype/NodeTypeDefinition/index.js +1 -7
  189. package/types/javax/jcr/nodetype/NodeTypeIterator/index.d.ts +1 -1
  190. package/types/javax/jcr/nodetype/NodeTypeManager/index.d.ts +0 -123
  191. package/types/javax/jcr/nodetype/NodeTypeManager/index.js +1 -8
  192. package/types/javax/jcr/nodetype/NodeTypeTemplate/index.d.ts +1 -1
  193. package/types/javax/jcr/nodetype/PropertyDefinition/index.d.ts +1 -270
  194. package/types/javax/jcr/nodetype/PropertyDefinition/index.js +1 -7
  195. package/types/javax/jcr/nodetype/PropertyDefinitionTemplate/index.d.ts +1 -1
  196. package/types/javax/jcr/observation/Event/index.d.ts +82 -41
  197. package/types/javax/jcr/observation/EventIterator/index.d.ts +1 -1
  198. package/types/javax/jcr/observation/EventJournal/index.d.ts +1 -1
  199. package/types/javax/jcr/observation/EventListenerIterator/index.d.ts +1 -1
  200. package/types/javax/jcr/query/Query/index.d.ts +29 -8
  201. package/types/javax/jcr/query/RowIterator/index.d.ts +1 -1
  202. package/types/javax/jcr/query/qom/And/index.d.ts +1 -1
  203. package/types/javax/jcr/query/qom/BindVariableValue/index.d.ts +1 -1
  204. package/types/javax/jcr/query/qom/ChildNode/index.d.ts +1 -1
  205. package/types/javax/jcr/query/qom/ChildNodeJoinCondition/index.d.ts +1 -1
  206. package/types/javax/jcr/query/qom/Comparison/index.d.ts +1 -1
  207. package/types/javax/jcr/query/qom/DescendantNode/index.d.ts +1 -1
  208. package/types/javax/jcr/query/qom/DescendantNodeJoinCondition/index.d.ts +1 -1
  209. package/types/javax/jcr/query/qom/DynamicOperand/index.d.ts +1 -1
  210. package/types/javax/jcr/query/qom/EquiJoinCondition/index.d.ts +1 -1
  211. package/types/javax/jcr/query/qom/FullTextSearch/index.d.ts +1 -1
  212. package/types/javax/jcr/query/qom/FullTextSearchScore/index.d.ts +1 -1
  213. package/types/javax/jcr/query/qom/Join/index.d.ts +1 -1
  214. package/types/javax/jcr/query/qom/Length/index.d.ts +1 -1
  215. package/types/javax/jcr/query/qom/Literal/index.d.ts +1 -1
  216. package/types/javax/jcr/query/qom/LowerCase/index.d.ts +1 -1
  217. package/types/javax/jcr/query/qom/NodeLocalName/index.d.ts +1 -1
  218. package/types/javax/jcr/query/qom/NodeName/index.d.ts +1 -1
  219. package/types/javax/jcr/query/qom/Not/index.d.ts +1 -1
  220. package/types/javax/jcr/query/qom/Or/index.d.ts +1 -1
  221. package/types/javax/jcr/query/qom/PropertyExistence/index.d.ts +1 -1
  222. package/types/javax/jcr/query/qom/PropertyValue/index.d.ts +1 -1
  223. package/types/javax/jcr/query/qom/QueryObjectModel/index.d.ts +1 -1
  224. package/types/javax/jcr/query/qom/QueryObjectModelConstants/index.d.ts +73 -1
  225. package/types/javax/jcr/query/qom/QueryObjectModelFactory/index.d.ts +1 -1
  226. package/types/javax/jcr/query/qom/SameNode/index.d.ts +1 -1
  227. package/types/javax/jcr/query/qom/SameNodeJoinCondition/index.d.ts +1 -1
  228. package/types/javax/jcr/query/qom/Selector/index.d.ts +1 -1
  229. package/types/javax/jcr/query/qom/StaticOperand/index.d.ts +1 -1
  230. package/types/javax/jcr/query/qom/UpperCase/index.d.ts +1 -1
  231. package/types/javax/jcr/security/AccessControlList/index.d.ts +1 -1
  232. package/types/javax/jcr/security/AccessControlPolicyIterator/index.d.ts +1 -1
  233. package/types/javax/jcr/security/NamedAccessControlPolicy/index.d.ts +1 -1
  234. package/types/javax/jcr/security/Privilege/index.d.ts +127 -43
  235. package/types/javax/jcr/version/Version/index.d.ts +1 -1
  236. package/types/javax/jcr/version/VersionHistory/index.d.ts +1 -1
  237. package/types/javax/jcr/version/VersionIterator/index.d.ts +1 -1
  238. package/types/senselogic/sitevision/api/base/Requireable/ScriptEngine/index.d.ts +9 -0
  239. package/types/senselogic/sitevision/api/base/Requireable/ScriptEngine/index.js +11 -0
  240. package/types/senselogic/sitevision/api/collaboration/CollaborationGroupWrapper/index.d.ts +9 -5
  241. package/types/senselogic/sitevision/api/format/NumericFormatterBuilder/index.d.ts +1 -1
  242. package/types/senselogic/sitevision/api/link/CustomLinkProcessor/index.d.ts +1 -1
  243. package/types/senselogic/sitevision/api/render/BuddyIconRenderer.BuddyIconInfo/index.d.ts +49 -0
  244. package/types/senselogic/sitevision/api/render/BuddyIconRenderer.BuddyIconInfo/index.js +12 -0
  245. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.ArticleUtilConstants/index.d.ts +83 -0
  246. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.ArticleUtilConstants/index.js +21 -0
  247. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.ExceptionSuppressingProxyConstants/index.d.ts +29 -0
  248. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.ExceptionSuppressingProxyConstants/index.js +12 -0
  249. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.IndexingUtilConstants/index.d.ts +29 -0
  250. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.IndexingUtilConstants/index.js +12 -0
  251. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.LinkPageUtilConstants/index.d.ts +65 -0
  252. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.LinkPageUtilConstants/index.js +18 -0
  253. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.MathInstanceConstants/index.d.ts +23 -0
  254. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.MathInstanceConstants/index.js +11 -0
  255. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.MimeTypeUtilConstants/index.d.ts +17 -0
  256. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.MimeTypeUtilConstants/index.js +10 -0
  257. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.NodeTypeUtilConstants/index.d.ts +1241 -0
  258. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.NodeTypeUtilConstants/index.js +189 -0
  259. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.OutputUtilConstants/index.d.ts +29 -0
  260. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.OutputUtilConstants/index.js +12 -0
  261. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PageUtilConstants/index.d.ts +89 -0
  262. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PageUtilConstants/index.js +22 -0
  263. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PortletContextUtilConstants/index.d.ts +25 -0
  264. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PortletContextUtilConstants/index.js +11 -0
  265. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PortletUtilConstants/index.d.ts +17 -0
  266. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PortletUtilConstants/index.js +10 -0
  267. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.QueryStringUtilConstants/index.d.ts +17 -0
  268. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.QueryStringUtilConstants/index.js +10 -0
  269. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.SearchHitConstants/index.d.ts +23 -0
  270. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.SearchHitConstants/index.js +11 -0
  271. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.SearchResultConstants/index.d.ts +35 -0
  272. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.SearchResultConstants/index.js +13 -0
  273. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.VersionUtilConstants/index.d.ts +23 -0
  274. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.VersionUtilConstants/index.js +11 -0
  275. package/types/senselogic/sitevision/api/script/RequesterChainable/index.d.ts +2 -2
  276. package/types/senselogic/sitevision/api/script/proxy/ExceptionSuppressingProxy/index.d.ts +22 -2
  277. package/types/senselogic/sitevision/api/search/SearchHit/index.d.ts +16 -2
  278. package/types/senselogic/sitevision/api/search/SearchResult/index.d.ts +28 -6
  279. package/types/senselogic/sitevision/api/security/jaas/filter/AuthenticationFilter/index.d.ts +31 -1
  280. package/types/senselogic/sitevision/api/user/UserIdentityWrapper/index.d.ts +1 -1
@@ -1,417 +1,411 @@
1
1
  import type { Resolver } from "../../types/senselogic/sitevision/api/base/Resolver";
2
2
 
3
3
  /**
4
- * Gets the Calendar resolver for Collaboration-related nodes.
5
- *
6
- * <p>
7
- * This is a convenience resolver that uses the {@link #getCollaborationDateResolver()} to resolve a <code>Date</code>
8
- * from a <code>Node</code> and then convert it to a <code>Calendar</code>.
9
- * </p>
10
- * <p>
11
- * <em>Note!</em> <code>Calendar</code> implements <code>Comparable</code> so this resolver can be used
12
- * to get a <code>Comparator</code> using {@link NodeComparatorUtil#getResolverComparator(Resolver)}.
13
- * </p>
14
- * @return the Calendar resolver for collaboration-related nodes
15
- * @see #getCollaborationDateResolver()
4
+ * Node resolver utility interface.
5
+ * @author Magnus Lövgren
6
+ * @since Sitevision 4.1
16
7
  */
17
- export function getCollaborationCalendarResolver(): Resolver;
8
+ export interface NodeResolverUtil {
9
+ /**
10
+ * Gets the Calendar resolver for Collaboration-related nodes.
11
+ *
12
+ * <p>
13
+ * This is a convenience resolver that uses the {@link #getCollaborationDateResolver()} to resolve a <code>Date</code>
14
+ * from a <code>Node</code> and then convert it to a <code>Calendar</code>.
15
+ * </p>
16
+ * <p>
17
+ * <em>Note!</em> <code>Calendar</code> implements <code>Comparable</code> so this resolver can be used
18
+ * to get a <code>Comparator</code> using {@link NodeComparatorUtil#getResolverComparator(Resolver)}.
19
+ * </p>
20
+ * @return the Calendar resolver for collaboration-related nodes
21
+ * @see #getCollaborationDateResolver()
22
+ */
23
+ getCollaborationCalendarResolver(): Resolver;
18
24
 
19
- /**
20
- * Gets the Date resolver for Collaboration-related nodes.
21
- *
22
- * <p>
23
- * <strong>Types</strong><br>
24
- * The Date value will be resolved differently for different node types.
25
- * For some types it will potentially do multiple checks and return the <em>first found</em> of them
26
- * (i.e. first check that has a non-null Date value).
27
- * </p>
28
- * <ul>
29
- * <li>
30
- * <code>sv:userIdentity</code>
31
- * <br><em>- returns:</em>
32
- * <ul>
33
- * <li>The time when the last entry was added to the personal timeline of the identity.</li>
34
- * </ul>
35
- * </li>
36
- * <li>
37
- * <code>sv:collaborationGroup</code>
38
- * <br><em>- returns first found of:</em>
39
- * <ol>
40
- * <li>The time when the collaboration group had it's last activity e.g. new entry or a modified file.</li>
41
- * <li>The time when the <code>sv:collaborationGroupPage</code> of the group was last published.</li>
42
- * <li>The time when the <code>sv:collaborationGroupPage</code> of the group was last modified.</li>
43
- * <li>The time when the <code>sv:collaborationGroupPage</code> of the group was created.</li>
44
- * </ol>
45
- * </li>
46
- * <li>
47
- * <code>sv:collaborationGroupPage</code>
48
- * <br><em>- returns first found of:</em>
49
- * <ol>
50
- * <li>
51
- * The time when the <code>sv:collaborationGroup</code> of the collaboration group page had it's last activity
52
- * e.g. new entry or a modified file.
53
- * </li>
54
- * <li>The time when the collaboration group page was last published.</li>
55
- * <li>The time when the collaboration group page was last modified.</li>
56
- * <li>The time when the collaboration group page was created.</li>
57
- * </ol>
58
- * </li>
59
- * <li>
60
- * <code>sv:collaborationGroupTemplate</code>
61
- * <br><em>- returns first found of:</em>
62
- * <ol>
63
- * <li>The time when the node was last published.</li>
64
- * <li>The time when the node was last modified.</li>
65
- * <li>The time when the node was created.</li>
66
- * </ol>
67
- * </li>
68
- * <li>
69
- * <code>sv:collaborationGroupFolder</code>
70
- * <br><em>- returns first found of:</em>
71
- * <ol>
72
- * <li>The time when the node was last modified.</li>
73
- * <li>The time when the node was created.</li>
74
- * </ol>
75
- * </li>
76
- * </ul>
77
- *
78
- * <p>
79
- * This resolver also supports some non-collaboration node types:
80
- * </p>
81
- * <ul>
82
- * <li>
83
- * <code>sv:page</code>, <code>sv:article</code>, <code>sv:sitePage</code>, <code>sv:link</code>, <code>sv:template</code>,
84
- * <code>sv:structurePage</code>, <code>sv:structureLink</code>
85
- * <br><em>- returns first found of:</em>
86
- * <ol>
87
- * <li>The time when the node was last published.</li>
88
- * <li>The time when the node was last modified.</li>
89
- * <li>The time when the node was created.</li>
90
- * </ol>
91
- * </li>
92
- * <li>
93
- * <code>sv:image</code>, <code>sv:file</code>, <code>sv:folder</code>, <code>sv:structureFolder</code>
94
- * <br><em>- returns first found of:</em>
95
- * <ol>
96
- * <li>The time when the node was last modified.</li>
97
- * <li>The time when the node was created.</li>
98
- * </ol>
99
- * </li>
100
- * </ul>
101
- * <p>
102
- * Unsupported node types will resolve to <code>null</code>.
103
- * </p>
104
- *
105
- * <p>
106
- * <strong>Example</strong>
107
- * <br>This server-side Javascript code demonstrates how to get the "last updated" Date from av sv:collaborationGroup.
108
- * </p>
109
- * <pre><code> <em>// Use NodeResolverUtil to get the Date resolver for Collaboration Nodes</em>
110
- * var nodeResolverUtil = require('NodeResolverUtil'),
111
- * collaborationDateResolver = nodeResolverUtil.getCollaborationDateResolver(),
112
- * collaborationGroup,
113
- * lastUpdated;
114
- *
115
- * <em>// Get the sv:collaborationGroup Node...</em>
116
- * collaborationGroup = ...
117
- *
118
- * <em>// Use the resolver to get (i.e. resolve) the "last updated" Date of the Collaboration group</em>
119
- * lastUpdated = collaborationDateResolver.resolve(collaborationGroup);</code></pre>
120
- *
121
- * <p>
122
- * <strong>Sorting tip!</strong><br>
123
- * <code>Date</code> implements <code>Comparable</code> so this resolver can be used
124
- * to get a <code>Comparator</code> using {@link NodeComparatorUtil#getResolverComparator(Resolver)}.
125
- * This resolver and the resolver comparator can be helpful when you want to sort a collection of
126
- * <code>sv:collaborationGroup</code> nodes in "most active" order.
127
- * </p>
128
- * @return the Date resolver for collaboration-related nodes
129
- */
130
- export function getCollaborationDateResolver(): Resolver;
25
+ /**
26
+ * Gets the Date resolver for Collaboration-related nodes.
27
+ *
28
+ * <p>
29
+ * <strong>Types</strong><br>
30
+ * The Date value will be resolved differently for different node types.
31
+ * For some types it will potentially do multiple checks and return the <em>first found</em> of them
32
+ * (i.e. first check that has a non-null Date value).
33
+ * </p>
34
+ * <ul>
35
+ * <li>
36
+ * <code>sv:userIdentity</code>
37
+ * <br><em>- returns:</em>
38
+ * <ul>
39
+ * <li>The time when the last entry was added to the personal timeline of the identity.</li>
40
+ * </ul>
41
+ * </li>
42
+ * <li>
43
+ * <code>sv:collaborationGroup</code>
44
+ * <br><em>- returns first found of:</em>
45
+ * <ol>
46
+ * <li>The time when the collaboration group had it's last activity e.g. new entry or a modified file.</li>
47
+ * <li>The time when the <code>sv:collaborationGroupPage</code> of the group was last published.</li>
48
+ * <li>The time when the <code>sv:collaborationGroupPage</code> of the group was last modified.</li>
49
+ * <li>The time when the <code>sv:collaborationGroupPage</code> of the group was created.</li>
50
+ * </ol>
51
+ * </li>
52
+ * <li>
53
+ * <code>sv:collaborationGroupPage</code>
54
+ * <br><em>- returns first found of:</em>
55
+ * <ol>
56
+ * <li>
57
+ * The time when the <code>sv:collaborationGroup</code> of the collaboration group page had it's last activity
58
+ * e.g. new entry or a modified file.
59
+ * </li>
60
+ * <li>The time when the collaboration group page was last published.</li>
61
+ * <li>The time when the collaboration group page was last modified.</li>
62
+ * <li>The time when the collaboration group page was created.</li>
63
+ * </ol>
64
+ * </li>
65
+ * <li>
66
+ * <code>sv:collaborationGroupTemplate</code>
67
+ * <br><em>- returns first found of:</em>
68
+ * <ol>
69
+ * <li>The time when the node was last published.</li>
70
+ * <li>The time when the node was last modified.</li>
71
+ * <li>The time when the node was created.</li>
72
+ * </ol>
73
+ * </li>
74
+ * <li>
75
+ * <code>sv:collaborationGroupFolder</code>
76
+ * <br><em>- returns first found of:</em>
77
+ * <ol>
78
+ * <li>The time when the node was last modified.</li>
79
+ * <li>The time when the node was created.</li>
80
+ * </ol>
81
+ * </li>
82
+ * </ul>
83
+ *
84
+ * <p>
85
+ * This resolver also supports some non-collaboration node types:
86
+ * </p>
87
+ * <ul>
88
+ * <li>
89
+ * <code>sv:page</code>, <code>sv:article</code>, <code>sv:sitePage</code>, <code>sv:link</code>, <code>sv:template</code>,
90
+ * <code>sv:structurePage</code>, <code>sv:structureLink</code>
91
+ * <br><em>- returns first found of:</em>
92
+ * <ol>
93
+ * <li>The time when the node was last published.</li>
94
+ * <li>The time when the node was last modified.</li>
95
+ * <li>The time when the node was created.</li>
96
+ * </ol>
97
+ * </li>
98
+ * <li>
99
+ * <code>sv:image</code>, <code>sv:file</code>, <code>sv:folder</code>, <code>sv:structureFolder</code>
100
+ * <br><em>- returns first found of:</em>
101
+ * <ol>
102
+ * <li>The time when the node was last modified.</li>
103
+ * <li>The time when the node was created.</li>
104
+ * </ol>
105
+ * </li>
106
+ * </ul>
107
+ * <p>
108
+ * Unsupported node types will resolve to <code>null</code>.
109
+ * </p>
110
+ *
111
+ * <p>
112
+ * <strong>Example</strong>
113
+ * <br>This server-side Javascript code demonstrates how to get the "last updated" Date from av sv:collaborationGroup.
114
+ * </p>
115
+ * <pre><code> <em>// Use NodeResolverUtil to get the Date resolver for Collaboration Nodes</em>
116
+ * var nodeResolverUtil = require('NodeResolverUtil'),
117
+ * collaborationDateResolver = nodeResolverUtil.getCollaborationDateResolver(),
118
+ * collaborationGroup,
119
+ * lastUpdated;
120
+ *
121
+ * <em>// Get the sv:collaborationGroup Node...</em>
122
+ * collaborationGroup = ...
123
+ *
124
+ * <em>// Use the resolver to get (i.e. resolve) the "last updated" Date of the Collaboration group</em>
125
+ * lastUpdated = collaborationDateResolver.resolve(collaborationGroup);</code></pre>
126
+ *
127
+ * <p>
128
+ * <strong>Sorting tip!</strong><br>
129
+ * <code>Date</code> implements <code>Comparable</code> so this resolver can be used
130
+ * to get a <code>Comparator</code> using {@link NodeComparatorUtil#getResolverComparator(Resolver)}.
131
+ * This resolver and the resolver comparator can be helpful when you want to sort a collection of
132
+ * <code>sv:collaborationGroup</code> nodes in "most active" order.
133
+ * </p>
134
+ * @return the Date resolver for collaboration-related nodes
135
+ */
136
+ getCollaborationDateResolver(): Resolver;
131
137
 
132
- /**
133
- * Gets the versioned Calendar resolver for nodes.
134
- *
135
- * <p>
136
- * This is a convenience resolver that uses the {@link #getVersionedDateResolver()} to resolve a <code>Date</code>
137
- * from a <code>Node</code> and then convert it to a <code>Calendar</code>.
138
- * </p>
139
- * <p>
140
- * <em>Note!</em> <code>Calendar</code> implements <code>Comparable</code> so this resolver can be used
141
- * to get a <code>Comparator</code> using {@link NodeComparatorUtil#getResolverComparator(Resolver)}.
142
- * </p>
143
- * @return the Calendar resolver for nodes
144
- * @see #getVersionedDateResolver()
145
- */
146
- export function getVersionedCalendarResolver(): Resolver;
138
+ /**
139
+ * Gets the versioned Calendar resolver for nodes.
140
+ *
141
+ * <p>
142
+ * This is a convenience resolver that uses the {@link #getVersionedDateResolver()} to resolve a <code>Date</code>
143
+ * from a <code>Node</code> and then convert it to a <code>Calendar</code>.
144
+ * </p>
145
+ * <p>
146
+ * <em>Note!</em> <code>Calendar</code> implements <code>Comparable</code> so this resolver can be used
147
+ * to get a <code>Comparator</code> using {@link NodeComparatorUtil#getResolverComparator(Resolver)}.
148
+ * </p>
149
+ * @return the Calendar resolver for nodes
150
+ * @see #getVersionedDateResolver()
151
+ */
152
+ getVersionedCalendarResolver(): Resolver;
147
153
 
148
- /**
149
- * Gets the versioned Date resolver for nodes.
150
- *
151
- * <p>
152
- * <strong>Types and versions</strong><br>
153
- * The Date value will be resolved differently for different node types in different versions.
154
- * For some types it will potentially do multiple checks and return the <em>first found</em> of them
155
- * (i.e. first check that has a non-null Date value).
156
- * </p>
157
- *
158
- * <p>
159
- * Date resolve in the {@link senselogic.sitevision.api.versioning.VersionUtil#ONLINE_VERSION}:
160
- * </p>
161
- * <ul>
162
- * <li>
163
- * <code>sv:page</code>, <code>sv:article</code>, <code>sv:sitePage</code>, <code>sv:link</code>, <code>sv:template</code>,
164
- * <code>sv:collaborationGroupPage</code>, <code>sv:collaborationGroupTemplate</code>,
165
- * <code>sv:structurePage</code>, <code>sv:structureLink</code>
166
- * <br><em>- returns first found of:</em>
167
- * <ol>
168
- * <li>The time when the node was last published.</li>
169
- * <li>The time when the node was last modified.</li>
170
- * <li>The time when the node was created.</li>
171
- * </ol>
172
- * </li>
173
- * <li>
174
- * <code>sv:collaborationGroup</code>
175
- * <br><em>- returns first found of:</em>
176
- * <ol>
177
- * <li>The time when the <code>sv:collaborationGroupPage</code> of the group was last published.</li>
178
- * <li>The time when the <code>sv:collaborationGroupPage</code> of the group was last modified.</li>
179
- * <li>The time when the <code>sv:collaborationGroupPage</code> of the group was created.</li>
180
- * </ol>
181
- * </li>
182
- * <li>
183
- * <code>sv:file</code>, <code>sv:image</code>, <code>sv:folder</code>, <code>sv:structureFolder</code>
184
- * <br><em>- returns first found of:</em>
185
- * <ol>
186
- * <li>The time when the node was last modified.</li>
187
- * <li>The time when the node was created.</li>
188
- * </ol>
189
- * </li>
190
- * </ul>
191
- *
192
- * <p>
193
- * Date resolve in the {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION}:
194
- * </p>
195
- * <ul>
196
- * <li>
197
- * <code>sv:page</code>, <code>sv:article</code>, <code>sv:sitePage</code>, <code>sv:link</code>, <code>sv:template</code>,
198
- * <code>sv:file</code>, <code>sv:image</code>, <code>sv:folder</code>,
199
- * <code>sv:collaborationGroupPage</code>, <code>sv:collaborationGroupTemplate</code>,
200
- * <code>sv:structurePage</code>, <code>sv:structureLink</code>, <code>sv:structureFolder</code>
201
- * <br><em>- returns first found of:</em>
202
- * <ol>
203
- * <li>The time when the node was last modified.</li>
204
- * <li>The time when the node was created.</li>
205
- * </ol>
206
- * </li>
207
- * <li>
208
- * <code>sv:collaborationGroup</code>
209
- * <br><em>- returns first found of:</em>
210
- * <ol>
211
- * <li>The time when the <code>sv:collaborationGroupPage</code> of the group was last modified.</li>
212
- * <li>The time when the <code>sv:collaborationGroupPage</code> of the group was created.</li>
213
- * </ol>
214
- * </li>
215
- * </ul>
216
- * <p>
217
- * Unsupported node types will resolve to <code>null</code>.
218
- * </p>
219
- *
220
- * <p>
221
- * <strong>Sorting tip!</strong><br>
222
- * <code>Date</code> implements <code>Comparable</code> so this resolver can be used
223
- * to get a <code>Comparator</code> using {@link NodeComparatorUtil#getResolverComparator(Resolver)}.
224
- * This resolver and the resolver comparator can be helpful when you want to sort nodes by time.
225
- * </p>
226
- * @return the versioned Date resolver for nodes
227
- */
228
- export function getVersionedDateResolver(): Resolver;
154
+ /**
155
+ * Gets the versioned Date resolver for nodes.
156
+ *
157
+ * <p>
158
+ * <strong>Types and versions</strong><br>
159
+ * The Date value will be resolved differently for different node types in different versions.
160
+ * For some types it will potentially do multiple checks and return the <em>first found</em> of them
161
+ * (i.e. first check that has a non-null Date value).
162
+ * </p>
163
+ *
164
+ * <p>
165
+ * Date resolve in the {@link senselogic.sitevision.api.versioning.VersionUtil#ONLINE_VERSION}:
166
+ * </p>
167
+ * <ul>
168
+ * <li>
169
+ * <code>sv:page</code>, <code>sv:article</code>, <code>sv:sitePage</code>, <code>sv:link</code>, <code>sv:template</code>,
170
+ * <code>sv:collaborationGroupPage</code>, <code>sv:collaborationGroupTemplate</code>,
171
+ * <code>sv:structurePage</code>, <code>sv:structureLink</code>
172
+ * <br><em>- returns first found of:</em>
173
+ * <ol>
174
+ * <li>The time when the node was last published.</li>
175
+ * <li>The time when the node was last modified.</li>
176
+ * <li>The time when the node was created.</li>
177
+ * </ol>
178
+ * </li>
179
+ * <li>
180
+ * <code>sv:collaborationGroup</code>
181
+ * <br><em>- returns first found of:</em>
182
+ * <ol>
183
+ * <li>The time when the <code>sv:collaborationGroupPage</code> of the group was last published.</li>
184
+ * <li>The time when the <code>sv:collaborationGroupPage</code> of the group was last modified.</li>
185
+ * <li>The time when the <code>sv:collaborationGroupPage</code> of the group was created.</li>
186
+ * </ol>
187
+ * </li>
188
+ * <li>
189
+ * <code>sv:file</code>, <code>sv:image</code>, <code>sv:folder</code>, <code>sv:structureFolder</code>
190
+ * <br><em>- returns first found of:</em>
191
+ * <ol>
192
+ * <li>The time when the node was last modified.</li>
193
+ * <li>The time when the node was created.</li>
194
+ * </ol>
195
+ * </li>
196
+ * </ul>
197
+ *
198
+ * <p>
199
+ * Date resolve in the {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION}:
200
+ * </p>
201
+ * <ul>
202
+ * <li>
203
+ * <code>sv:page</code>, <code>sv:article</code>, <code>sv:sitePage</code>, <code>sv:link</code>, <code>sv:template</code>,
204
+ * <code>sv:file</code>, <code>sv:image</code>, <code>sv:folder</code>,
205
+ * <code>sv:collaborationGroupPage</code>, <code>sv:collaborationGroupTemplate</code>,
206
+ * <code>sv:structurePage</code>, <code>sv:structureLink</code>, <code>sv:structureFolder</code>
207
+ * <br><em>- returns first found of:</em>
208
+ * <ol>
209
+ * <li>The time when the node was last modified.</li>
210
+ * <li>The time when the node was created.</li>
211
+ * </ol>
212
+ * </li>
213
+ * <li>
214
+ * <code>sv:collaborationGroup</code>
215
+ * <br><em>- returns first found of:</em>
216
+ * <ol>
217
+ * <li>The time when the <code>sv:collaborationGroupPage</code> of the group was last modified.</li>
218
+ * <li>The time when the <code>sv:collaborationGroupPage</code> of the group was created.</li>
219
+ * </ol>
220
+ * </li>
221
+ * </ul>
222
+ * <p>
223
+ * Unsupported node types will resolve to <code>null</code>.
224
+ * </p>
225
+ *
226
+ * <p>
227
+ * <strong>Sorting tip!</strong><br>
228
+ * <code>Date</code> implements <code>Comparable</code> so this resolver can be used
229
+ * to get a <code>Comparator</code> using {@link NodeComparatorUtil#getResolverComparator(Resolver)}.
230
+ * This resolver and the resolver comparator can be helpful when you want to sort nodes by time.
231
+ * </p>
232
+ * @return the versioned Date resolver for nodes
233
+ */
234
+ getVersionedDateResolver(): Resolver;
229
235
 
230
- /**
231
- * Gets the Locale resolver for nodes.
232
- *
233
- * <p>
234
- * The Locale value will be resolved differently for different node types:
235
- * </p>
236
- * <ul>
237
- * <li>
238
- * <code>sv:page</code>, <code>sv:article</code>, <code>sv:template</code>, <code>sv:sitePage</code>,
239
- * <code>sv:structurePage</code>, <code>sv:collaborationGroupPage</code>, <code>sv:collaborationGroupTemplate</code>,
240
- * <code>sv:link</code>, <code>sv:structureLink</code>,
241
- * <code>sv:folder</code>, <code>sv:structureFolder</code>, <code>sv:collaborationGroupFolder</code>
242
- * <code>sv:archive</code>,
243
- * <code>sv:applicationIndex</code>, <code>sv:nodeIndex</code>
244
- * <br><em>- returns:</em>
245
- * <ul>
246
- * <li>The Locale of the node.</li>
247
- * </ul>
248
- * </li>
249
- * <li>
250
- * <code>sv:collaborationGroup</code>
251
- * <br><em>- returns:</em>
252
- * <ul>
253
- * <li>The Locale of the <code>sv:collaborationGroupPage</code> of the group.</li>
254
- * </ul>
255
- * </li>
256
- * </ul>
257
- *
258
- * <p>
259
- * Unsupported node types will resolve to <code>null</code>.
260
- * </p>
261
- * @return the Locale resolver for nodes
262
- * @see senselogic.sitevision.api.context.PortletContextUtil#getCurrentLocale()
263
- */
264
- export function getLocaleResolver(): Resolver;
236
+ /**
237
+ * Gets the Locale resolver for nodes.
238
+ *
239
+ * <p>
240
+ * The Locale value will be resolved differently for different node types:
241
+ * </p>
242
+ * <ul>
243
+ * <li>
244
+ * <code>sv:page</code>, <code>sv:article</code>, <code>sv:template</code>, <code>sv:sitePage</code>,
245
+ * <code>sv:structurePage</code>, <code>sv:collaborationGroupPage</code>, <code>sv:collaborationGroupTemplate</code>,
246
+ * <code>sv:link</code>, <code>sv:structureLink</code>,
247
+ * <code>sv:folder</code>, <code>sv:structureFolder</code>, <code>sv:collaborationGroupFolder</code>
248
+ * <code>sv:archive</code>,
249
+ * <code>sv:applicationIndex</code>, <code>sv:nodeIndex</code>
250
+ * <br><em>- returns:</em>
251
+ * <ul>
252
+ * <li>The Locale of the node.</li>
253
+ * </ul>
254
+ * </li>
255
+ * <li>
256
+ * <code>sv:collaborationGroup</code>
257
+ * <br><em>- returns:</em>
258
+ * <ul>
259
+ * <li>The Locale of the <code>sv:collaborationGroupPage</code> of the group.</li>
260
+ * </ul>
261
+ * </li>
262
+ * </ul>
263
+ *
264
+ * <p>
265
+ * Unsupported node types will resolve to <code>null</code>.
266
+ * </p>
267
+ * @return the Locale resolver for nodes
268
+ * @see senselogic.sitevision.api.context.PortletContextUtil#getCurrentLocale()
269
+ */
270
+ getLocaleResolver(): Resolver;
265
271
 
266
- /**
267
- * Gets the sv:tag resolver for nodes.
268
- *
269
- * <p>
270
- * The list of tags can be resolved for different node types:
271
- * </p>
272
- * <ul>
273
- * <li>
274
- * <code>sv:page</code>, <code>sv:article</code>, <code>sv:file</code>, <code>sv:image</code>,
275
- * <code>sv:sitePage</code>, <code>sv:collaborationGroupPage</code>
276
- * <br><em>- returns:</em>
277
- * <ul>
278
- * <li>The potential tags of the node.</li>
279
- * </ul>
280
- * </li>
281
- * <li>
282
- * <code>sv:timelineEntry</code>, <code>sv:timelineWallEntry</code>, <code>sv:timelineFileEntry</code>,
283
- * <code>sv:timelineFileWallEntry</code>, <code>sv:timelineShareEntry</code>, <code>sv:timelineSharePageEntry</code>
284
- * <br><em>- returns:</em>
285
- * <ul>
286
- * <li>The potential tags in the entry text.</li>
287
- * </ul>
288
- * </li>
289
- * <li>
290
- * <code>sv:comment</code>, <code>sv:pageComment</code>
291
- * <br><em>- returns:</em>
292
- * <ul>
293
- * <li>The potential tags in the comment text.</li>
294
- * </ul>
295
- * </li>
296
- * <li>
297
- * <code>sv:tagGroup</code>
298
- * <br><em>- returns:</em>
299
- * <ul>
300
- * <li>The potential tags of the tag group.</li>
301
- * </ul>
302
- * </li>
303
- * <li>
304
- * <code>sv:tagGroupRepository</code>
305
- * <br><em>- returns:</em>
306
- * <ul>
307
- * <li>All the potential tags of all the tag groups of the repository combined.</li>
308
- * </ul>
309
- * </li>
310
- * </ul>
311
- *
312
- * <p>
313
- * Unsupported node types will resolve to an empty list (unmodifiable), i.e. the resolver will never return null.
314
- * </p>
315
- * <p>
316
- * <em>Note!</em> The resolved list is not explicitly sorted. The tags will typically be in insertion order.
317
- * </p>
318
- *
319
- * <p>
320
- * <strong>Example</strong>
321
- * <br>This server-side Javascript code demonstrates how to get all tags that belong to a sv:tagGroup, sorted by the tag name.
322
- * </p>
323
- * <pre><code> <em>// Resolves and returns a List of sv:tag from a given Node</em>
324
- * function getAllTagsFrom(from) {
325
- * var nodeResolverUtil = require('NodeResolverUtil'),
326
- * tagResolver = nodeResolverUtil.getTagsResolver();
327
- *
328
- * return tagResolver.resolve(from);
329
- * }
330
- *
331
- * <em>// Sorts a List of sv:tag by the tag names in ascending order</em>
332
- * function sortTagList(tagList) {
333
- * var nodeComparatorUtil = require('NodeComparatorUtil'),
334
- * collectionsInstance = require('CollectionsInstance'),
335
- * tagNameComparator;
336
- *
337
- * tagNameComparator = nodeComparatorUtil.getPropertyComparator('tagName');
338
- * collectionsInstance.sort(tagList, tagNameComparator);
339
- * }
340
- *
341
- * var resourceLocatorUtil = require('ResourceLocatorUtil'),
342
- * tagGroupsRepository,
343
- * tags;
344
- *
345
- * tagGroupsRepository = resourceLocatorUtil.getTagGroupRepository();
346
- * tags = getAllTagsFrom(tagGroupsRepository);
347
- *
348
- * if (tags.size() &gt; 1) {
349
- * sortTagList(tags);
350
- * }</code></pre>
351
- * @return a resolver that can resolve a List of sv:tag from a Node
352
- * @since Sitevision 5
353
- */
354
- export function getTagsResolver(): Resolver;
355
-
356
- /**
357
- * Gets the sv:tagGroup resolver for nodes.
358
- *
359
- * <p>
360
- * The list of tag groups can be resolved for different node types:
361
- * </p>
362
- * <ul>
363
- * <li>
364
- * <code>sv:tag</code>
365
- * <br><em>- returns:</em>
366
- * <ul>
367
- * <li>The potential tag groups of the tag <em>(a sv:tag can belong to multiple sv:tagGroup)</em>.</li>
368
- * </ul>
369
- * </li>
370
- * <li>
371
- * <code>sv:tagGroupRepository</code>
372
- * <br><em>- returns:</em>
373
- * <ul>
374
- * <li>The potential tag groups of the repository.</li>
375
- * </ul>
376
- * </li>
377
- * <li>
378
- * <code>sv:sitePage</code>, <code>sv:page</code>, <code>sv:folder</code>, <code>sv:archive</code>,
379
- * <code>sv:article</code>, <code>sv:file</code>, <code>sv:image</code>, <code>sv:collaborationGroupFolder</code>,
380
- * <code>sv:collaborationGroupPage</code>, <code>sv:userField</code> (of type TAGS),
381
- * <code>sv:metadataMultipleTagDefinition</code>, <code>sv:metadataSingleTagDefinition</code>
382
- * <br><em>- returns:</em>
383
- * <ul>
384
- * <li>The potential effective tag groups of the node.</li>
385
- * </ul>
386
- * </li>
387
- * </ul>
388
- *
389
- * <p>
390
- * Unsupported node types will resolve to an empty list (unmodifiable), i.e. the resolver will never return null.
391
- * </p>
392
- * <p>
393
- * <em>Note!</em> The resolved list is not explicitly sorted. The tag groups will typically be in insertion order.
394
- * </p>
395
- * @return a resolver that can resolve a List of sv:tagGroup from a Node
396
- * @since Sitevision 5
397
- */
398
- export function getTagGroupsResolver(): Resolver;
272
+ /**
273
+ * Gets the sv:tag resolver for nodes.
274
+ *
275
+ * <p>
276
+ * The list of tags can be resolved for different node types:
277
+ * </p>
278
+ * <ul>
279
+ * <li>
280
+ * <code>sv:page</code>, <code>sv:article</code>, <code>sv:file</code>, <code>sv:image</code>,
281
+ * <code>sv:sitePage</code>, <code>sv:collaborationGroupPage</code>
282
+ * <br><em>- returns:</em>
283
+ * <ul>
284
+ * <li>The potential tags of the node.</li>
285
+ * </ul>
286
+ * </li>
287
+ * <li>
288
+ * <code>sv:timelineEntry</code>, <code>sv:timelineWallEntry</code>, <code>sv:timelineFileEntry</code>,
289
+ * <code>sv:timelineFileWallEntry</code>, <code>sv:timelineShareEntry</code>, <code>sv:timelineSharePageEntry</code>
290
+ * <br><em>- returns:</em>
291
+ * <ul>
292
+ * <li>The potential tags in the entry text.</li>
293
+ * </ul>
294
+ * </li>
295
+ * <li>
296
+ * <code>sv:comment</code>, <code>sv:pageComment</code>
297
+ * <br><em>- returns:</em>
298
+ * <ul>
299
+ * <li>The potential tags in the comment text.</li>
300
+ * </ul>
301
+ * </li>
302
+ * <li>
303
+ * <code>sv:tagGroup</code>
304
+ * <br><em>- returns:</em>
305
+ * <ul>
306
+ * <li>The potential tags of the tag group.</li>
307
+ * </ul>
308
+ * </li>
309
+ * <li>
310
+ * <code>sv:tagGroupRepository</code>
311
+ * <br><em>- returns:</em>
312
+ * <ul>
313
+ * <li>All the potential tags of all the tag groups of the repository combined.</li>
314
+ * </ul>
315
+ * </li>
316
+ * </ul>
317
+ *
318
+ * <p>
319
+ * Unsupported node types will resolve to an empty list (unmodifiable), i.e. the resolver will never return null.
320
+ * </p>
321
+ * <p>
322
+ * <em>Note!</em> The resolved list is not explicitly sorted. The tags will typically be in insertion order.
323
+ * </p>
324
+ *
325
+ * <p>
326
+ * <strong>Example</strong>
327
+ * <br>This server-side Javascript code demonstrates how to get all tags that belong to a sv:tagGroup, sorted by the tag name.
328
+ * </p>
329
+ * <pre><code> <em>// Resolves and returns a List of sv:tag from a given Node</em>
330
+ * function getAllTagsFrom(from) {
331
+ * var nodeResolverUtil = require('NodeResolverUtil'),
332
+ * tagResolver = nodeResolverUtil.getTagsResolver();
333
+ *
334
+ * return tagResolver.resolve(from);
335
+ * }
336
+ *
337
+ * <em>// Sorts a List of sv:tag by the tag names in ascending order</em>
338
+ * function sortTagList(tagList) {
339
+ * var nodeComparatorUtil = require('NodeComparatorUtil'),
340
+ * collectionsInstance = require('CollectionsInstance'),
341
+ * tagNameComparator;
342
+ *
343
+ * tagNameComparator = nodeComparatorUtil.getPropertyComparator('tagName');
344
+ * collectionsInstance.sort(tagList, tagNameComparator);
345
+ * }
346
+ *
347
+ * var resourceLocatorUtil = require('ResourceLocatorUtil'),
348
+ * tagGroupsRepository,
349
+ * tags;
350
+ *
351
+ * tagGroupsRepository = resourceLocatorUtil.getTagGroupRepository();
352
+ * tags = getAllTagsFrom(tagGroupsRepository);
353
+ *
354
+ * if (tags.size() &gt; 1) {
355
+ * sortTagList(tags);
356
+ * }</code></pre>
357
+ * @return a resolver that can resolve a List of sv:tag from a Node
358
+ * @since Sitevision 5
359
+ */
360
+ getTagsResolver(): Resolver;
399
361
 
400
- /**
401
- * Node resolver utility interface.
402
- * @author Magnus Lövgren
403
- * @since Sitevision 4.1
404
- */
405
- declare namespace nodeResolverUtil {
406
- export {
407
- getCollaborationCalendarResolver,
408
- getCollaborationDateResolver,
409
- getVersionedCalendarResolver,
410
- getVersionedDateResolver,
411
- getLocaleResolver,
412
- getTagsResolver,
413
- getTagGroupsResolver,
414
- };
362
+ /**
363
+ * Gets the sv:tagGroup resolver for nodes.
364
+ *
365
+ * <p>
366
+ * The list of tag groups can be resolved for different node types:
367
+ * </p>
368
+ * <ul>
369
+ * <li>
370
+ * <code>sv:tag</code>
371
+ * <br><em>- returns:</em>
372
+ * <ul>
373
+ * <li>The potential tag groups of the tag <em>(a sv:tag can belong to multiple sv:tagGroup)</em>.</li>
374
+ * </ul>
375
+ * </li>
376
+ * <li>
377
+ * <code>sv:tagGroupRepository</code>
378
+ * <br><em>- returns:</em>
379
+ * <ul>
380
+ * <li>The potential tag groups of the repository.</li>
381
+ * </ul>
382
+ * </li>
383
+ * <li>
384
+ * <code>sv:sitePage</code>, <code>sv:page</code>, <code>sv:folder</code>, <code>sv:archive</code>,
385
+ * <code>sv:article</code>, <code>sv:file</code>, <code>sv:image</code>, <code>sv:collaborationGroupFolder</code>,
386
+ * <code>sv:collaborationGroupPage</code>, <code>sv:userField</code> (of type TAGS),
387
+ * <code>sv:metadataMultipleTagDefinition</code>, <code>sv:metadataSingleTagDefinition</code>
388
+ * <br><em>- returns:</em>
389
+ * <ul>
390
+ * <li>The potential effective tag groups of the node.</li>
391
+ * </ul>
392
+ * </li>
393
+ * </ul>
394
+ *
395
+ * <p>
396
+ * Unsupported node types will resolve to an empty list (unmodifiable), i.e. the resolver will never return null.
397
+ * </p>
398
+ * <p>
399
+ * <em>Note!</em> The resolved list is not explicitly sorted. The tag groups will typically be in insertion order.
400
+ * </p>
401
+ * @return a resolver that can resolve a List of sv:tagGroup from a Node
402
+ * @since Sitevision 5
403
+ */
404
+ getTagGroupsResolver(): Resolver;
415
405
  }
416
406
 
407
+ declare namespace NodeResolverUtil {}
408
+
409
+ declare var nodeResolverUtil: NodeResolverUtil;
410
+
417
411
  export default nodeResolverUtil;