@sitevision/api 2.0.0-alpha.1 → 2.0.0-alpha.2

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 (332) hide show
  1. package/index.d.ts +8 -0
  2. package/package.json +1 -1
  3. package/server/AliasUtil/index.d.ts +13 -11
  4. package/server/ArchiveUtil/index.d.ts +45 -43
  5. package/server/ArraysInstance/index.d.ts +1667 -1808
  6. package/server/ArticleUtil/index.d.ts +294 -226
  7. package/server/AuthenticationUtil/index.d.ts +73 -85
  8. package/server/BookmarkUtil/index.d.ts +76 -81
  9. package/server/BuddyIconRenderer/index.d.ts +124 -132
  10. package/server/BuddyIconRenderer.BuddyIconSize/index.d.ts +41 -0
  11. package/server/BuddyIconRenderer.BuddyIconSize/index.js +25 -0
  12. package/server/ClientUtil/index.d.ts +11 -9
  13. package/server/CollaborationFactory/index.d.ts +37 -40
  14. package/server/CollaborationGroupFolderUtil/index.d.ts +30 -28
  15. package/server/CollaborationGroupState/index.d.ts +27 -0
  16. package/server/CollaborationGroupState/index.js +11 -0
  17. package/server/CollaborationGroupTemplateUtil/index.d.ts +48 -50
  18. package/server/CollaborationGroupType/index.d.ts +28 -0
  19. package/server/CollaborationGroupType/index.js +12 -0
  20. package/server/CollaborationGroupUtil/index.d.ts +86 -82
  21. package/server/CollectionsInstance/index.d.ts +642 -705
  22. package/server/ColorUtil/index.d.ts +36 -37
  23. package/server/CompoundAndFilterBuilder/index.d.ts +31 -29
  24. package/server/CompoundComparatorBuilder/index.d.ts +35 -33
  25. package/server/CompoundOrFilterBuilder/index.d.ts +31 -29
  26. package/server/ContentNodeUtil/index.d.ts +36 -34
  27. package/server/CurrencyFactory/index.d.ts +72 -70
  28. package/server/DateUtil/index.d.ts +132 -142
  29. package/server/DecorationUtil/index.d.ts +13 -11
  30. package/server/DeviceUtil/index.d.ts +21 -19
  31. package/server/DimensionMode/index.d.ts +17 -0
  32. package/server/DimensionMode/index.js +12 -0
  33. package/server/DirectoryUtil/index.d.ts +90 -88
  34. package/server/DocType/index.d.ts +30 -0
  35. package/server/DocType/index.js +14 -0
  36. package/server/DocTypeUtil/index.d.ts +129 -135
  37. package/server/EndecUtil/index.d.ts +330 -347
  38. package/server/ExtendedDismaxParserBuilder/index.d.ts +156 -170
  39. package/server/FileIconRenderer/index.d.ts +153 -172
  40. package/server/FileUtil/index.d.ts +274 -300
  41. package/server/FilterBuilder/index.d.ts +42 -40
  42. package/server/FolderUtil/index.d.ts +93 -94
  43. package/server/FontUtil/index.d.ts +36 -37
  44. package/server/FormatterBuilderFactory/index.d.ts +76 -84
  45. package/server/HighlightBuilder/index.d.ts +79 -86
  46. package/server/IconUtil/index.d.ts +27 -25
  47. package/server/ImageLinkRenderer/index.d.ts +34 -32
  48. package/server/ImageRenderer/index.d.ts +343 -379
  49. package/server/ImageUtil/index.d.ts +247 -265
  50. package/server/IndexUtil/index.d.ts +40 -37
  51. package/server/IndexUtil.IndexType/index.d.ts +29 -0
  52. package/server/IndexUtil.IndexType/index.js +13 -0
  53. package/server/IndexingUtil/index.d.ts +69 -47
  54. package/server/InstanceCreatorUtil/index.d.ts +421 -457
  55. package/server/InstanceTypeUtil/index.d.ts +168 -189
  56. package/server/JwtUtil/index.d.ts +131 -129
  57. package/server/LandingPageUtil/index.d.ts +84 -87
  58. package/server/LandingPageUtil/index.js +1 -0
  59. package/server/LinkPageUtil/index.d.ts +297 -251
  60. package/server/LinkRenderer/index.d.ts +651 -715
  61. package/server/LinkTargetBuilder/index.d.ts +69 -77
  62. package/server/LinkValueBuilder/index.d.ts +70 -77
  63. package/server/ListWrapper/index.d.ts +82 -91
  64. package/server/LocaleUtil/index.d.ts +382 -394
  65. package/server/LogUtil/index.d.ts +119 -128
  66. package/server/MailBuilder/index.d.ts +109 -124
  67. package/server/MailUtil/index.d.ts +58 -63
  68. package/server/MathInstance/index.d.ts +625 -657
  69. package/server/MessageDigesterFactory/index.d.ts +30 -28
  70. package/server/MetadataDefinitionUtil/index.d.ts +79 -83
  71. package/server/MetadataUtil/index.d.ts +322 -346
  72. package/server/MimeTypeUtil/index.d.ts +209 -215
  73. package/server/MonitorBuilder/index.d.ts +20 -20
  74. package/server/NodeComparatorUtil/index.d.ts +215 -225
  75. package/server/NodeFactoryUtil/index.d.ts +18 -16
  76. package/server/NodeFilterUtil/index.d.ts +652 -739
  77. package/server/NodeIteratorUtil/index.d.ts +214 -229
  78. package/server/NodeResolverUtil/index.d.ts +400 -406
  79. package/server/NodeTreeUtil/index.d.ts +214 -229
  80. package/server/NodeTypeUtil/index.d.ts +1432 -548
  81. package/server/OfflineVersionPropertyUtil/index.d.ts +8 -6
  82. package/server/OnlineVersionPropertyUtil/index.d.ts +8 -6
  83. package/server/OutputUtil/index.d.ts +385 -380
  84. package/server/PageUtil/index.d.ts +266 -188
  85. package/server/PermissionUtil/index.d.ts +393 -430
  86. package/server/PermissionUtil.Permission/index.d.ts +54 -0
  87. package/server/PermissionUtil.Permission/index.js +38 -0
  88. package/server/PortletContextUtil/index.d.ts +112 -107
  89. package/server/PortletUtil/index.d.ts +32 -22
  90. package/server/PrincipalUtil/index.d.ts +35 -33
  91. package/server/Properties/index.d.ts +69 -76
  92. package/server/PropertyUtil/index.d.ts +1422 -1464
  93. package/server/PublishingUtil/index.d.ts +248 -249
  94. package/server/QueryStringUtil/index.d.ts +404 -415
  95. package/server/RedirectUtil/index.d.ts +64 -68
  96. package/server/RelatedValueBuilder/index.d.ts +45 -43
  97. package/server/Requester/index.d.ts +125 -125
  98. package/server/ResourceLocatorUtil/index.d.ts +436 -476
  99. package/server/RestApi/index.d.ts +158 -138
  100. package/server/RestAppInvokerFactory/index.d.ts +28 -26
  101. package/server/RoleAssignmentBuilder/index.d.ts +39 -37
  102. package/server/RoleMatcherBuilder/index.d.ts +39 -37
  103. package/server/RoleUtil/index.d.ts +35 -37
  104. package/server/ScriptUtil/index.d.ts +458 -495
  105. package/server/SearchFactory/index.d.ts +90 -105
  106. package/server/SearchUtil/index.d.ts +75 -73
  107. package/server/SearcherBuilder/index.d.ts +117 -124
  108. package/server/Session/index.d.ts +261 -1103
  109. package/server/Session/index.js +1 -20
  110. package/server/SimpleUserUtil/index.d.ts +28 -29
  111. package/server/SiteCookieUtil/index.d.ts +152 -175
  112. package/server/SortBuilder/index.d.ts +27 -25
  113. package/server/SourceSetMode/index.d.ts +12 -0
  114. package/server/SourceSetMode/index.js +12 -0
  115. package/server/SpellCheckBuilder/index.d.ts +30 -30
  116. package/server/StandardParserBuilder/index.d.ts +36 -34
  117. package/server/StructureUtil/index.d.ts +85 -83
  118. package/server/SubscriberUtil/index.d.ts +60 -67
  119. package/server/SubscriptionUtil/index.d.ts +123 -130
  120. package/server/SystemUserUtil/index.d.ts +148 -146
  121. package/server/TagUtil/index.d.ts +115 -120
  122. package/server/TemplateUtil/index.d.ts +115 -120
  123. package/server/TemporaryFileNodeBuilder/index.d.ts +32 -30
  124. package/server/TemporaryNodeBuilder/index.d.ts +139 -177
  125. package/server/TextModuleRendererBuilder/index.d.ts +22 -20
  126. package/server/TimestampUtil/index.d.ts +103 -117
  127. package/server/TranslationUtil/index.d.ts +98 -104
  128. package/server/TrashcanUtil/index.d.ts +114 -117
  129. package/server/UserDataUtil/index.d.ts +110 -111
  130. package/server/UserFactory/index.d.ts +47 -54
  131. package/server/UserFieldRenderer/index.d.ts +120 -128
  132. package/server/UserIdentityUtil/index.d.ts +38 -36
  133. package/server/UserUtil/index.d.ts +32 -30
  134. package/server/Utils/index.d.ts +634 -723
  135. package/server/VelocityRenderer/index.d.ts +96 -94
  136. package/server/VersionUtil/index.d.ts +25 -9
  137. package/server/WebContentUtil/index.d.ts +277 -284
  138. package/server/WebResourceFactory/index.d.ts +41 -46
  139. package/server/XSLTUtil/index.d.ts +34 -32
  140. package/server/XmlParserUtil/index.d.ts +50 -48
  141. package/types/javax/jcr/Binary/index.d.ts +3 -21
  142. package/types/javax/jcr/Binary/index.js +0 -1
  143. package/types/javax/jcr/Credentials/index.d.ts +3 -1
  144. package/types/javax/jcr/ImportUUIDBehavior/index.d.ts +27 -1
  145. package/types/javax/jcr/Item/index.d.ts +6 -119
  146. package/types/javax/jcr/Item/index.js +0 -6
  147. package/types/javax/jcr/ItemVisitor/index.d.ts +5 -3
  148. package/types/javax/jcr/NamespaceRegistry/index.d.ts +69 -43
  149. package/types/javax/jcr/NamespaceRegistry/index.js +0 -2
  150. package/types/javax/jcr/Node/index.d.ts +37 -1506
  151. package/types/javax/jcr/Node/index.js +1 -34
  152. package/types/javax/jcr/NodeIterator/index.d.ts +5 -3
  153. package/types/javax/jcr/Property/index.d.ts +494 -494
  154. package/types/javax/jcr/Property/index.js +0 -5
  155. package/types/javax/jcr/PropertyIterator/index.d.ts +5 -3
  156. package/types/javax/jcr/RangeIterator/index.d.ts +2 -42
  157. package/types/javax/jcr/RangeIterator/index.js +1 -5
  158. package/types/javax/jcr/Repository/index.d.ts +465 -263
  159. package/types/javax/jcr/Repository/index.js +0 -4
  160. package/types/javax/jcr/RepositoryFactory/index.d.ts +4 -2
  161. package/types/javax/jcr/Value/index.d.ts +4 -31
  162. package/types/javax/jcr/Value/index.js +0 -2
  163. package/types/javax/jcr/ValueFactory/index.d.ts +6 -74
  164. package/types/javax/jcr/ValueFactory/index.js +1 -2
  165. package/types/javax/jcr/Workspace/index.d.ts +103 -577
  166. package/types/javax/jcr/Workspace/index.js +1 -12
  167. package/types/javax/jcr/lock/Lock/index.d.ts +4 -2
  168. package/types/javax/jcr/lock/LockManager/index.d.ts +4 -2
  169. package/types/javax/jcr/nodetype/ItemDefinition/index.d.ts +4 -105
  170. package/types/javax/jcr/nodetype/ItemDefinition/index.js +0 -5
  171. package/types/javax/jcr/nodetype/NodeDefinition/index.d.ts +5 -3
  172. package/types/javax/jcr/nodetype/NodeDefinitionTemplate/index.d.ts +4 -2
  173. package/types/javax/jcr/nodetype/NodeType/index.d.ts +262 -269
  174. package/types/javax/jcr/nodetype/NodeType/index.js +1 -12
  175. package/types/javax/jcr/nodetype/NodeTypeDefinition/index.d.ts +5 -107
  176. package/types/javax/jcr/nodetype/NodeTypeDefinition/index.js +1 -7
  177. package/types/javax/jcr/nodetype/NodeTypeIterator/index.d.ts +5 -3
  178. package/types/javax/jcr/nodetype/NodeTypeManager/index.d.ts +9 -130
  179. package/types/javax/jcr/nodetype/NodeTypeManager/index.js +1 -8
  180. package/types/javax/jcr/nodetype/NodeTypeTemplate/index.d.ts +4 -2
  181. package/types/javax/jcr/nodetype/PropertyDefinition/index.d.ts +5 -272
  182. package/types/javax/jcr/nodetype/PropertyDefinition/index.js +1 -7
  183. package/types/javax/jcr/nodetype/PropertyDefinitionTemplate/index.d.ts +5 -3
  184. package/types/javax/jcr/observation/Event/index.d.ts +85 -42
  185. package/types/javax/jcr/observation/EventIterator/index.d.ts +5 -3
  186. package/types/javax/jcr/observation/EventJournal/index.d.ts +4 -2
  187. package/types/javax/jcr/observation/EventListener/index.d.ts +4 -2
  188. package/types/javax/jcr/observation/EventListenerIterator/index.d.ts +5 -3
  189. package/types/javax/jcr/observation/ObservationManager/index.d.ts +6 -4
  190. package/types/javax/jcr/query/Query/index.d.ts +35 -12
  191. package/types/javax/jcr/query/QueryManager/index.d.ts +6 -4
  192. package/types/javax/jcr/query/QueryResult/index.d.ts +5 -3
  193. package/types/javax/jcr/query/Row/index.d.ts +5 -3
  194. package/types/javax/jcr/query/RowIterator/index.d.ts +5 -3
  195. package/types/javax/jcr/query/qom/And/index.d.ts +4 -2
  196. package/types/javax/jcr/query/qom/BindVariableValue/index.d.ts +4 -2
  197. package/types/javax/jcr/query/qom/ChildNode/index.d.ts +4 -2
  198. package/types/javax/jcr/query/qom/ChildNodeJoinCondition/index.d.ts +4 -2
  199. package/types/javax/jcr/query/qom/Column/index.d.ts +3 -1
  200. package/types/javax/jcr/query/qom/Comparison/index.d.ts +6 -4
  201. package/types/javax/jcr/query/qom/Constraint/index.d.ts +3 -1
  202. package/types/javax/jcr/query/qom/DescendantNode/index.d.ts +4 -2
  203. package/types/javax/jcr/query/qom/DescendantNodeJoinCondition/index.d.ts +4 -2
  204. package/types/javax/jcr/query/qom/DynamicOperand/index.d.ts +4 -2
  205. package/types/javax/jcr/query/qom/EquiJoinCondition/index.d.ts +4 -2
  206. package/types/javax/jcr/query/qom/FullTextSearch/index.d.ts +5 -3
  207. package/types/javax/jcr/query/qom/FullTextSearchScore/index.d.ts +4 -2
  208. package/types/javax/jcr/query/qom/Join/index.d.ts +5 -3
  209. package/types/javax/jcr/query/qom/JoinCondition/index.d.ts +3 -1
  210. package/types/javax/jcr/query/qom/Length/index.d.ts +5 -3
  211. package/types/javax/jcr/query/qom/Literal/index.d.ts +5 -3
  212. package/types/javax/jcr/query/qom/LowerCase/index.d.ts +4 -2
  213. package/types/javax/jcr/query/qom/NodeLocalName/index.d.ts +4 -2
  214. package/types/javax/jcr/query/qom/NodeName/index.d.ts +4 -2
  215. package/types/javax/jcr/query/qom/Not/index.d.ts +4 -2
  216. package/types/javax/jcr/query/qom/Operand/index.d.ts +3 -1
  217. package/types/javax/jcr/query/qom/Or/index.d.ts +4 -2
  218. package/types/javax/jcr/query/qom/Ordering/index.d.ts +4 -2
  219. package/types/javax/jcr/query/qom/PropertyExistence/index.d.ts +4 -2
  220. package/types/javax/jcr/query/qom/PropertyValue/index.d.ts +4 -2
  221. package/types/javax/jcr/query/qom/QueryObjectModel/index.d.ts +8 -6
  222. package/types/javax/jcr/query/qom/QueryObjectModelConstants/index.d.ts +76 -2
  223. package/types/javax/jcr/query/qom/QueryObjectModelFactory/index.d.ts +37 -35
  224. package/types/javax/jcr/query/qom/SameNode/index.d.ts +4 -2
  225. package/types/javax/jcr/query/qom/SameNodeJoinCondition/index.d.ts +4 -2
  226. package/types/javax/jcr/query/qom/Selector/index.d.ts +4 -2
  227. package/types/javax/jcr/query/qom/Source/index.d.ts +3 -1
  228. package/types/javax/jcr/query/qom/StaticOperand/index.d.ts +4 -2
  229. package/types/javax/jcr/query/qom/UpperCase/index.d.ts +4 -2
  230. package/types/javax/jcr/retention/Hold/index.d.ts +3 -1
  231. package/types/javax/jcr/retention/RetentionManager/index.d.ts +5 -3
  232. package/types/javax/jcr/retention/RetentionPolicy/index.d.ts +3 -1
  233. package/types/javax/jcr/security/AccessControlEntry/index.d.ts +4 -2
  234. package/types/javax/jcr/security/AccessControlList/index.d.ts +6 -4
  235. package/types/javax/jcr/security/AccessControlManager/index.d.ts +6 -4
  236. package/types/javax/jcr/security/AccessControlPolicy/index.d.ts +3 -1
  237. package/types/javax/jcr/security/AccessControlPolicyIterator/index.d.ts +5 -3
  238. package/types/javax/jcr/security/NamedAccessControlPolicy/index.d.ts +4 -2
  239. package/types/javax/jcr/security/Privilege/index.d.ts +130 -44
  240. package/types/javax/jcr/version/Version/index.d.ts +5 -3
  241. package/types/javax/jcr/version/VersionHistory/index.d.ts +7 -5
  242. package/types/javax/jcr/version/VersionIterator/index.d.ts +5 -3
  243. package/types/javax/jcr/version/VersionManager/index.d.ts +7 -5
  244. package/types/senselogic/sitevision/api/base/Builder/index.d.ts +3 -1
  245. package/types/senselogic/sitevision/api/base/Filter/index.d.ts +3 -1
  246. package/types/senselogic/sitevision/api/base/FilterSplit/index.d.ts +4 -2
  247. package/types/senselogic/sitevision/api/base/Loadable/index.d.ts +3 -1
  248. package/types/senselogic/sitevision/api/base/Requireable/ScriptEngine/index.d.ts +9 -0
  249. package/types/senselogic/sitevision/api/base/Requireable/ScriptEngine/index.js +11 -0
  250. package/types/senselogic/sitevision/api/base/Resolver/index.d.ts +3 -1
  251. package/types/senselogic/sitevision/api/base/Wrapper/index.d.ts +3 -1
  252. package/types/senselogic/sitevision/api/collaboration/CollaborationGroupWrapper/index.d.ts +13 -7
  253. package/types/senselogic/sitevision/api/format/NumericFormatter/index.d.ts +3 -1
  254. package/types/senselogic/sitevision/api/format/NumericFormatterBuilder/index.d.ts +5 -3
  255. package/types/senselogic/sitevision/api/i18n/Currency/index.d.ts +3 -1
  256. package/types/senselogic/sitevision/api/link/CustomLinkProcessor/index.d.ts +5 -3
  257. package/types/senselogic/sitevision/api/link/CustomLinkRenderData/index.d.ts +3 -1
  258. package/types/senselogic/sitevision/api/mail/Mail/index.d.ts +3 -1
  259. package/types/senselogic/sitevision/api/message/MessageTextLinker/index.d.ts +3 -1
  260. package/types/senselogic/sitevision/api/metadata/value/LinkValue/index.d.ts +3 -1
  261. package/types/senselogic/sitevision/api/metadata/value/RelatedValue/index.d.ts +3 -1
  262. package/types/senselogic/sitevision/api/property/VersionedPropertyUtil/index.d.ts +4 -2
  263. package/types/senselogic/sitevision/api/render/BuddyIconRenderer.BuddyIconInfo/index.d.ts +51 -0
  264. package/types/senselogic/sitevision/api/render/BuddyIconRenderer.BuddyIconInfo/index.js +12 -0
  265. package/types/senselogic/sitevision/api/render/ImageScaler/index.d.ts +4 -2
  266. package/types/senselogic/sitevision/api/render/TextModuleRenderer/index.d.ts +4 -2
  267. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess/index.d.ts +3 -1
  268. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.ArticleUtilConstants/index.d.ts +85 -0
  269. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.ArticleUtilConstants/index.js +21 -0
  270. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.ExceptionSuppressingProxyConstants/index.d.ts +31 -0
  271. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.ExceptionSuppressingProxyConstants/index.js +12 -0
  272. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.IndexingUtilConstants/index.d.ts +31 -0
  273. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.IndexingUtilConstants/index.js +12 -0
  274. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.LinkPageUtilConstants/index.d.ts +67 -0
  275. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.LinkPageUtilConstants/index.js +18 -0
  276. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.MathInstanceConstants/index.d.ts +25 -0
  277. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.MathInstanceConstants/index.js +11 -0
  278. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.MimeTypeUtilConstants/index.d.ts +19 -0
  279. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.MimeTypeUtilConstants/index.js +10 -0
  280. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.NodeTypeUtilConstants/index.d.ts +1243 -0
  281. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.NodeTypeUtilConstants/index.js +189 -0
  282. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.OutputUtilConstants/index.d.ts +31 -0
  283. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.OutputUtilConstants/index.js +12 -0
  284. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PageUtilConstants/index.d.ts +91 -0
  285. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PageUtilConstants/index.js +22 -0
  286. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PortletContextUtilConstants/index.d.ts +27 -0
  287. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PortletContextUtilConstants/index.js +11 -0
  288. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PortletUtilConstants/index.d.ts +19 -0
  289. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PortletUtilConstants/index.js +10 -0
  290. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.QueryStringUtilConstants/index.d.ts +19 -0
  291. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.QueryStringUtilConstants/index.js +10 -0
  292. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.SearchHitConstants/index.d.ts +25 -0
  293. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.SearchHitConstants/index.js +11 -0
  294. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.SearchResultConstants/index.d.ts +37 -0
  295. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.SearchResultConstants/index.js +13 -0
  296. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.VersionUtilConstants/index.d.ts +25 -0
  297. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.VersionUtilConstants/index.js +11 -0
  298. package/types/senselogic/sitevision/api/render/velocity/VelocityContext/index.d.ts +3 -1
  299. package/types/senselogic/sitevision/api/render/velocity/VelocityEvaluator/index.d.ts +3 -1
  300. package/types/senselogic/sitevision/api/script/RequesterChainable/index.d.ts +4 -2
  301. package/types/senselogic/sitevision/api/script/app/RestAppInvoker/index.d.ts +3 -1
  302. package/types/senselogic/sitevision/api/script/factory/TypedArgument/index.d.ts +3 -1
  303. package/types/senselogic/sitevision/api/script/proxy/ExceptionSuppressingCollection/index.d.ts +3 -1
  304. package/types/senselogic/sitevision/api/script/proxy/ExceptionSuppressingIterator/index.d.ts +4 -2
  305. package/types/senselogic/sitevision/api/script/proxy/ExceptionSuppressingProxy/index.d.ts +24 -2
  306. package/types/senselogic/sitevision/api/search/SearchFieldUtil/index.d.ts +3 -1
  307. package/types/senselogic/sitevision/api/search/SearchHighlighter/index.d.ts +4 -2
  308. package/types/senselogic/sitevision/api/search/SearchHit/index.d.ts +19 -3
  309. package/types/senselogic/sitevision/api/search/SearchResult/index.d.ts +31 -7
  310. package/types/senselogic/sitevision/api/search/facet/SearchFacetField/index.d.ts +3 -1
  311. package/types/senselogic/sitevision/api/search/facet/SearchFacetValue/index.d.ts +3 -1
  312. package/types/senselogic/sitevision/api/search/searcher/Searcher/index.d.ts +4 -2
  313. package/types/senselogic/sitevision/api/search/searcher/component/Filter/index.d.ts +3 -1
  314. package/types/senselogic/sitevision/api/search/searcher/component/Highlight/index.d.ts +3 -1
  315. package/types/senselogic/sitevision/api/search/searcher/component/Monitor/index.d.ts +3 -1
  316. package/types/senselogic/sitevision/api/search/searcher/component/Parser/index.d.ts +3 -1
  317. package/types/senselogic/sitevision/api/search/searcher/component/Sort/index.d.ts +3 -1
  318. package/types/senselogic/sitevision/api/search/searcher/component/SpellCheck/index.d.ts +3 -1
  319. package/types/senselogic/sitevision/api/search/sort/CustomSort/index.d.ts +3 -1
  320. package/types/senselogic/sitevision/api/search/suggestion/SearchSuggestion/index.d.ts +3 -1
  321. package/types/senselogic/sitevision/api/security/DirectoryAttributes/index.d.ts +3 -1
  322. package/types/senselogic/sitevision/api/security/MessageDigester/index.d.ts +3 -1
  323. package/types/senselogic/sitevision/api/security/RoleAssignment/index.d.ts +4 -2
  324. package/types/senselogic/sitevision/api/security/RoleMatcher/index.d.ts +4 -2
  325. package/types/senselogic/sitevision/api/security/SecretStore/index.d.ts +3 -1
  326. package/types/senselogic/sitevision/api/security/UserUtil/index.d.ts +4 -2
  327. package/types/senselogic/sitevision/api/security/jaas/filter/AuthenticationFilter/index.d.ts +35 -3
  328. package/types/senselogic/sitevision/api/security/jaas/filter/AuthenticationFilterChain/index.d.ts +3 -1
  329. package/types/senselogic/sitevision/api/user/UserIdentityWrapper/index.d.ts +5 -3
  330. package/types/senselogic/sitevision/api/webresource/LinkTarget/index.d.ts +3 -1
  331. package/types/senselogic/sitevision/api/xml/XmlElement/index.d.ts +3 -1
  332. package/types/senselogic/sitevision/api/xml/XmlElementHandler/index.d.ts +4 -2
@@ -1,395 +1,22 @@
1
- import type { Value } from "../Value";
2
- import type { Property } from "../Property";
1
+ import type Value from "../Value";
2
+ import type Property from "../Property";
3
3
 
4
- import type { Binary } from "../Binary";
4
+ import type Binary from "../Binary";
5
5
 
6
- import type { NodeIterator } from "../NodeIterator";
7
- import type { PropertyIterator } from "../PropertyIterator";
8
- import type { Item } from "../Item";
9
- import type { NodeType } from "../nodetype/NodeType";
10
- import type { NodeDefinition } from "../nodetype/NodeDefinition";
11
- import type { Version } from "../version/Version";
12
- import type { VersionHistory } from "../version/VersionHistory";
13
- import type { Lock } from "../lock/Lock";
6
+ import type NodeIterator from "../NodeIterator";
7
+ import type PropertyIterator from "../PropertyIterator";
8
+ import type Item from "../Item";
9
+ import type NodeType from "../nodetype/NodeType";
10
+ import type NodeDefinition from "../nodetype/NodeDefinition";
11
+ import type Version from "../version/Version";
12
+ import type VersionHistory from "../version/VersionHistory";
13
+ import type Lock from "../lock/Lock";
14
14
 
15
15
  /**
16
- * The <code>Node</code> interface represents a node in a workspace.A constant for the JCR name <code>jcr:content</code>. This is the name of
17
- * a child node declared in {@link NodeType#NT_FILE nt:file} and a property
18
- * declared in {@link javax.jcr.nodetype.NodeType#NT_LINKED_FILE
19
- * nt:linkedFile}.A constant for the node name <code>jcr:propertyDefinition</code> declared
20
- * in {@link NodeType#NT_FILE nt:nodeType}.A constant for the node name <code>jcr:childNodeDefinition</code>
21
- * declared in {@link NodeType#NT_FILE nt:nodeType}.A constant for the node name <code>jcr:rootVersion</code> declared in
22
- * {@link NodeType#NT_VERSION_HISTORY nt:versionHistory}.A constant for the node name <code>jcr:versionLabels</code> declared in
23
- * {@link NodeType#NT_VERSION_HISTORY nt:versionHistory}.A constant for the node name <code>jcr:frozenNode</code> declared in
24
- * {@link NodeType#NT_VERSION nt:version}.
25
- * @since JCR 2.0
26
- * @since JCR 2.0
27
- * @since JCR 2.0
28
- * @since JCR 2.0
29
- * @since JCR 2.0
30
- * @since JCR 2.0
31
- */
32
- export type Node = {
33
- /**
34
- * Creates a new node at <code>relPath</code>.
35
- * <p>
36
- * This is <i>session-write</i> method, meaning that the addition of the new
37
- * node is dispatch upon {@link Session#save}.
38
- * <p>
39
- * The <code>relPath</code> provided must not have an index on its final
40
- * element, otherwise a Repository
41
- * <p>
42
- * If ordering is supported by the node type of the parent node of the new
43
- * node then the new node is appended to the end of the child node list.
44
- * <p>
45
- * The new node's primary node type will be determined by the child node
46
- * definitions in the node types of its parent. This may occur either
47
- * immediately, on dispatch (save, whether within or without transactions)
48
- * or on persist (save without transactions, commit within a transaction),
49
- * depending on the implementation.
50
- * <p>
51
- * An <code>ItemExistsException</code> will be thrown either immediately, on
52
- * dispatch (save, whether within or without transactions) or on persist
53
- * (save without transactions, commit within a transaction), if an item at
54
- * the specified path already exists and same-name siblings are not allowed.
55
- * Implementations may differ on when this validation is performed.
56
- * <p>
57
- * A <code>PathNotFoundException</code> will be thrown either immediately,
58
- * on dispatch (save, whether within or without transactions) or on persist
59
- * (save without transactions, commit within a transaction), if the
60
- * specified path implies intermediary nodes that do not exist.
61
- * Implementations may differ on when this validation is performed.
62
- * <p>
63
- * A <code>ConstraintViolationException</code> will be thrown either
64
- * immediately, on dispatch (save, whether within or without transactions)
65
- * or on persist (save without transactions, commit within a transaction),
66
- * if adding the node would violate a node type or implementation-specific
67
- * constraint or if an attempt is made to add a node as the child of a
68
- * property. Implementations may differ on when this validation is
69
- * performed.
70
- * <p>
71
- * A <code>VersionException</code> will be thrown either immediately, on
72
- * dispatch (save, whether within or without transactions) or on persist
73
- * (save without transactions, commit within a transaction), if the node to
74
- * which the new child is being added is read-only due to a checked-in node.
75
- * Implementations may differ on when this validation is performed.
76
- * <p>
77
- * A <code>LockException</code> will be thrown either immediately, on
78
- * dispatch (save, whether within or without transactions) or on persist
79
- * (save without transactions, commit within a transaction), if a lock
80
- * prevents the addition of the node. Implementations may differ on when
81
- * this validation is performed.
82
- *
83
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
84
- * @param relPath The path of the new node to be created.
85
- * @return The node that was added.
86
- * @throws ItemExistsException if an item at the specified path already exists, same-name siblings are not allowed and this implementation performs this validation immediately.
87
- * @throws PathNotFoundException if the specified path implies intermediary <code>Node</code>s that do not exist or the last element of <code>relPath</code> has an index, and this implementation performs this validation immediately.
88
- * @throws ConstraintViolationException if a node type or implementation-specific constraint is violated or if an attempt is made to add a node as the child of a property and this implementation performs this validation immediately.
89
- * @throws VersionException if the node to which the new child is being added is read-only due to a checked-in node and this implementation performs this validation immediately.
90
- * @throws LockException if a lock prevents the addition of the node and this implementation performs this validation immediately.
91
- * @throws RepositoryException If the last element of <code>relPath</code> has an index or if another error occurs.
92
- */
93
- addNode(relPath: string): Node;
94
-
95
- /**
96
- * Creates a new node at <code>relPath</code> of the specified node type.
97
- * The behavior of this method is identical to {@link #addNode(String
98
- * relPath)} except that the primary node type of the new node is explicitly
99
- * specified.
100
- *
101
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
102
- * @param relPath the path of the new node to be created.
103
- * @param primaryNodeTypeName The name of the primary node type of the new node.
104
- * @return the node that was added.
105
- * @throws ItemExistsException if an item at the specified path already exists, same-name siblings are not allowed and this implementation performs this validation immediately instead of waiting until <code>save</code>.
106
- * @throws PathNotFoundException if the specified path implies intermediary <code>Node</code>s that do not exist or the last element of <code>relPath</code> has an index, and this implementation performs this validation immediately instead of waiting until <code>save</code>.
107
- * @throws NoSuchNodeTypeException if the specified node type is not recognized and this implementation performs this validation immediately instead of waiting until <code>save</code>.
108
- * @throws ConstraintViolationException if a node type or implementation-specific constraint is violated or if an attempt is made to add a node as the child of a property and this implementation performs this validation immediately instead of waiting until <code>save</code>.
109
- * @throws VersionException if the node to which the new child is being added is read-only due to a checked-in node and this implementation performs this validation immediately instead of waiting until <code>save</code>.
110
- * @throws LockException if a lock prevents the addition of the node and this implementation performs this validation immediately instead of waiting until <code>save</code>.
111
- * @throws RepositoryException if the last element of <code>relPath</code> has an index or if another error occurs.
112
- */
113
- addNode(relPath: string, primaryNodeTypeName: string): Node;
114
-
115
- /**
116
- * If this node supports child node ordering, this method inserts the child
117
- * node at <code>srcChildRelPath</code> into the child node list at the
118
- * position immediately the child node at <code>destChildRelPath</code>.
119
- * <p>
120
- * To place the node <code>srcChildRelPath</code> at the end of the list, a
121
- * <code>destChildRelPath</code> of <code>null</code> is used.
122
- * <p>
123
- * Note that (apart from the case where <code>destChildRelPath</code> is
124
- * <code>null</code>) both of these arguments must be relative paths of
125
- * depth one, in other words they are the names of the child nodes, possibly
126
- * suffixed with an index.
127
- * <p>
128
- * If <code>srcChildRelPath</code> and <code>destChildRelPath</code> are the
129
- * same, then no change is made.
130
- * <p>
131
- * This is session-write method, meaning that a change made by this method
132
- * is dispatched on <code>save</code>
133
- * <p>
134
- * A <code>ConstraintViolationException</code> will be thrown either
135
- * immediately, on dispatch (save whether within or without transactions) or
136
- * on persist (save without transactions, commit within a transaction), if
137
- * this operation would violate a node type or implementation-specific
138
- * constraint. Implementations may differ on when this validation is
139
- * performed.
140
- * <p>
141
- * A <code>VersionException</code> will be thrown either immediately, on
142
- * dispatch (save whether within or without transactions) or on persist
143
- * (save without transactions, commit within a transaction), if this node is
144
- * read-only due to it or a node above it being checked-in Implementations
145
- * may differ on when this validation is performed.
146
- * <p>
147
- * A <code>LockException</code> will be thrown either immediately (by this
148
- * method), or on <code>save</code>, if a lock prevents the re-ordering.
149
- * Implementations may differ on when this validation is performed.
150
- *
151
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
152
- * @param srcChildRelPath the relative path to the child node (that is, name plus possible index) to be moved in the ordering
153
- * @param destChildRelPath the the relative path to the child node (that is, name plus possible index) before which the node <code>srcChildRelPath</code> will be placed.
154
- * @throws UnsupportedRepositoryOperationException if ordering is not supported on this node.
155
- * @throws ConstraintViolationException if an implementation-specific ordering restriction is violated and this implementation performs this validation immediately.
156
- * @throws ItemNotFoundException if either parameter is not the relative path of a child node of this node.
157
- * @throws VersionException if this node is read-only due to a checked-in node and this implementation performs this validation immediately.
158
- * @throws LockException if a lock prevents the re-ordering and this implementation performs this validation immediately.
159
- * @throws RepositoryException if another error occurs.
160
- */
161
- orderBefore(srcChildRelPath: string, destChildRelPath: string): void;
162
-
163
- /**
164
- * Sets the single-value property of this node called <code>name</code> to
165
- * the specified <code>value</code>.
166
- * <p>
167
- * If the property does not yet exist, it is created and its property type
168
- * determined by the by the node type of this node. If, based on the
169
- * <code>name</code> and <code>value</code> passed, there is more than one
170
- * property definition that applies, the repository chooses one definition
171
- * according to some implementation-specific criteria. Once a property with
172
- * name <code>P</code> has been created, the behavior of a subsequent
173
- * <code>setProperty(P,V)</code> may differ across implementations. Some
174
- * repositories may allow <code>P</code> to be dynamically re-bound to a
175
- * different property definition (based for example, on the new value being
176
- * of a different type than the original value) while other repositories may
177
- * not allow such dynamic re-binding.
178
- * <p>
179
- * If the property type of the supplied <code>Value</code> object is
180
- * different from that required, then a best-effort conversion is
181
- * attempted.
182
- * <p>
183
- * If the node type of this node does not indicate a specific property type,
184
- * then the property type of the supplied <code>Value</code> object is used
185
- * and if the property already exists it assumes both the new value and new
186
- * property type.
187
- * <p>
188
- * Passing a <code>null</code> as the second parameter removes the property.
189
- * It is equivalent to calling <code>remove</code> on the
190
- * <code>Property</code> object itself.
191
- * <p>
192
- * This is a session-write method, meaning that changes made through this
193
- * method are dispatched on {@link Session#save}.
194
- * <p>
195
- * A <code>ConstraintViolationException</code> will be thrown either
196
- * immediately, on dispatch (save whether within or without transactions) or
197
- * on persist (save without transactions, commit within a transaction), if
198
- * the change would violate a node type or implementation-specific
199
- * constraint. Implementations may differ on when this validation is
200
- * performed.
201
- * <p>
202
- * A <code>VersionException</code> will be thrown either immediately, on
203
- * dispatch (save whether within or without transactions) or on persist
204
- * (save without transactions, commit within a transaction), if this node is
205
- * read-only due to a checked-in node. Implementations may differ on when
206
- * this validation is performed.
207
- * <p>
208
- * A <code>LockException</code> will be thrown either immediately, on
209
- * dispatch (save whether within or without transactions) or on persist
210
- * (save without transactions, commit within a transaction), if a lock
211
- * prevents the setting of the property. Implementations may differ on when
212
- * this validation is performed.
213
- *
214
- * <p><strong>Sitevision note:</strong> Limited to nodes of primary {@link javax.jcr.nodetype.NodeType}
215
- * <code>sv:simpleUser</code></p>
216
- * @param name The name of a property of this node
217
- * @param value The value to be assigned
218
- * @return The updated <code>Property</code> object
219
- * @throws ValueFormatException if the specified property is a <code>DATE</code> but the <code>value</code> cannot be expressed in the ISO 8601-based format defined in the JCR 2.0 specification and the implementation does not support dates incompatible with that format or if <code>value</code> cannot be converted to the type of the specified property or if the property already exists and is multi-valued.
220
- * @throws VersionException if this node is read-only due to a checked-in node and this implementation performs this validation immediately.
221
- * @throws LockException if a lock prevents the setting of the property and this implementation performs this validation immediately.
222
- * @throws ConstraintViolationException if the change would violate a node-type or other constraint and this implementation performs this validation immediately.
223
- * @throws RepositoryException if another error occurs.
224
- */
225
- setProperty(name: string, value: Value): Property;
226
-
227
- /**
228
- * Sets the single-value property of this node called <code>name</code> to
229
- * the specified <code>value</code> and the specified <code>type</code>.
230
- * <p>
231
- * The behavior of this method is identical to that of {@link
232
- * #setProperty(String name, Value value)} except that the intended property
233
- * type is explicitly specified.
234
- * <p>
235
- * If the property does not yet exist, it is created. If the property
236
- * already exists it assumes both the new value and the new property type.
237
- *
238
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
239
- * @param name the name of the property to be set.
240
- * @param value a <code>Value</code> object.
241
- * @param type the type of the property.
242
- * @return the <code>Property</code> object set, or <code>null</code> if this method was used to remove a property (by setting its value to <code>null</code>).
243
- * @throws ValueFormatException if <code>value</code> cannot be converted to the specified type or if the property already exists and is multi-valued.
244
- * @throws VersionException if this node is read-only due to a checked-in node and this implementation performs this validation immediately.
245
- * @throws LockException if a lock prevents the setting of the property and this implementation performs this validation immediately.
246
- * @throws ConstraintViolationException if the change would violate a node-type or other constraint and this implementation performs this validation immediately.
247
- * @throws RepositoryException if another error occurs.
248
- */
249
- setProperty(name: string, value: Value, type: number): Property;
250
-
251
- /**
252
- * Sets the multi-value property of this node called <code>name</code> to
253
- * the specified array of values.
254
- * <p>
255
- * If the property does not yet exist, it is created.
256
- * <p>
257
- * The behavior of this method is identical to that of {@link
258
- * #setProperty(String name, Value value)} except that an array of
259
- * <code>Value</code> objects is assigned instead of a single
260
- * <code>Value</code>.
261
- * <p>
262
- * The property type of the property will be that specified by the node type
263
- * of this node. If the property type of one or more of the supplied
264
- * <code>Value</code> objects is different from that required, then a
265
- * best-effort conversion is attempted, according to an
266
- * implemention-dependent definition of "best effort". If the conversion
267
- * fails, a <code>ValueFormatException</code> is thrown.
268
- * <p>
269
- * If the property is not multi-valued then a <code>ValueFormatException</code>
270
- * is also thrown. If another error occurs, a <code>RepositoryException</code>
271
- * is thrown.
272
- * <p>
273
- * If the node type of this node does not indicate a specific property type,
274
- * then the property type of the supplied <code>Value</code> objects is used
275
- * and if the property already exists it assumes both the new values and the
276
- * new property type.
277
- * <p>
278
- * Passing a <code>null</code> as the second parameter removes the property.
279
- * It is equivalent to calling <code>remove</code> on the
280
- * <code>Property</code> object itself. Note that this is different from
281
- * passing an array that contains <code>null</code> elements. In such a
282
- * case, the array is compacted by removing the <code>null</code> values.
283
- * The resulting set of values never contains a null. However, the set may
284
- * be empty: <code>N.setProperty("P", new Value[]{null})</code> would set
285
- * the property to the empty set of values.
286
- *
287
- * <p><strong>Sitevision note:</strong> Limited to nodes of primary {@link javax.jcr.nodetype.NodeType}
288
- * <code>sv:simpleUser</code></p>
289
- * @param name the name of the property to be set.
290
- * @param values an array of <code>Value</code> objects.
291
- * @return the updated <code>Property</code> object.
292
- * @throws ValueFormatException if <code>value</code> cannot be converted to the type of the specified property or if the property already exists and is not multi-valued.
293
- * @throws VersionException if this node is read-only due to a checked-in node and this implementation performs this validation immediately.
294
- * @throws LockException if a lock prevents the setting of the property and this implementation performs this validation immediately.
295
- * @throws ConstraintViolationException if the change would violate a node-type or other constraint and this implementation performs this validation immediately.
296
- * @throws RepositoryException if another error occurs.
297
- */
298
- setProperty(name: string, values: Value): Property;
299
-
300
- /**
301
- * Sets the multi-value property of this node called <code>name</code> to
302
- * the specified array of values.
303
- * <p>
304
- * The behavior of this method is identical to that of {@link
305
- * #setProperty(String name, Value[] values)} except that the type of the
306
- * property is explicitly specified.
307
- * <p>
308
- * If the property does not yet exist, it is created. The type of the
309
- * property is determined by the <code>type</code> parameter specified.
310
- * <p>
311
- * If the property type of one or more of the supplied <code>Value</code>
312
- * objects is different from that specified, then a best-effort conversion
313
- * is attempted, according to an implemention-dependent definition of "best
314
- * effort". If the conversion fails, a <code>ValueFormatException</code> is
315
- * thrown.
316
- * <p>
317
- * If the property already exists it assumes both the new values and the new
318
- * property type.
319
- * </p>
320
- *
321
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
322
- * @param name the name of the property to be set.
323
- * @param values an array of <code>Value</code> objects.
324
- * @param type the type of the property.
325
- * @return the updated <code>Property</code> object.
326
- * @throws ValueFormatException if a value cannot be converted to the specified type or if the property already exists and is not multi-valued.
327
- * @throws VersionException if this node is read-only due to a checked-in node and this implementation performs this validation immediately.
328
- * @throws LockException if a lock prevents the setting of the property and this implementation performs this validation immediately.
329
- * @throws ConstraintViolationException if the change would violate a node-type or other constraint and this implementation performs this validation immediately.
330
- * @throws RepositoryException if another error occurs.
331
- */
332
- setProperty(name: string, values: Value, type: number): Property;
333
-
334
- /**
335
- * Sets the specified property to the specified array of values. Same as
336
- * {@link #setProperty(String name, Value[] values)} except that the values
337
- * are specified as <code>String</code> objects instead of
338
- * <code>Value</code> objects.
339
- *
340
- * <p><strong>Sitevision note:</strong> Limited to nodes of primary {@link javax.jcr.nodetype.NodeType}
341
- * <code>sv:simpleUser</code></p>
342
- * @param name the name of the property to be set.
343
- * @param values an array of <code>Value</code> objects.
344
- * @return the updated <code>Property</code> object.
345
- * @throws ValueFormatException if a value cannot be converted to the type of the specified property or if the property already exists and is not multi-valued.
346
- * @throws VersionException if this node is read-only due to a checked-in node and this implementation performs this validation immediately.
347
- * @throws LockException if a lock prevents the setting of the property and this implementation performs this validation immediately.
348
- * @throws ConstraintViolationException if the change would violate a node-type or other constraint and this implementation performs this validation immediately.
349
- * @throws RepositoryException if another error occurs.
350
- */
351
- setProperty(name: string, values: string): Property;
352
-
353
- /**
354
- * Sets the specified property to the specified array of values and to the
355
- * specified type. Same as {@link #setProperty(String name, Value[] values,
356
- * int type)} except that the values are specified as <code>String</code>
357
- * objects instead of <code>Value</code> objects.
358
- *
359
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
360
- * @param name the name of the property to be set.
361
- * @param values an array of <code>Value</code> objects.
362
- * @param type the type of the property.
363
- * @return the updated <code>Property</code> object.
364
- * @throws ValueFormatException if a value cannot be converted to the specified type or if the property already exists and is not multi-valued.
365
- * @throws VersionException if this node is read-only due to a checked-in node and this implementation performs this validation immediately.
366
- * @throws LockException if a lock prevents the setting of the property and this implementation performs this validation immediately.
367
- * @throws ConstraintViolationException if the change would violate a node-type or other constraint and this implementation performs this validation immediately.
368
- * @throws RepositoryException if another error occurs.
369
- */
370
- setProperty(name: string, values: string, type: number): Property;
371
-
372
- /**
373
- * Sets the specified single-value property to the specified value. The
374
- * behavior of this method is identical to that of {@link
375
- * #setProperty(String name, Value value)} except that the value is
376
- * specified as a <code>String</code>. and, if possible, the type assigned
377
- * to the property is <code>STRING</code>, otherwise a best-effort
378
- * conversion is attempted.
379
- *
380
- * <p><strong>Sitevision note:</strong> Limited to nodes of primary {@link javax.jcr.nodetype.NodeType}
381
- * <code>sv:simpleUser</code></p>
382
- * @param name The name of a property of this node
383
- * @param value The value to assigned
384
- * @return The updated <code>Property</code> object
385
- * @throws ValueFormatException if <code>value</code> cannot be converted to the type of the specified property or if the property already exists and is multi-valued.
386
- * @throws VersionException if this node is read-only due to a checked-in node and this implementation performs this validation immediately.
387
- * @throws LockException if a lock prevents the setting of the property and this implementation performs this validation immediately.
388
- * @throws ConstraintViolationException if the change would violate a node-type or other constraint and this implementation performs this validation immediately.
389
- * @throws RepositoryException if another error occurs.
390
- */
391
- setProperty(name: string, value: string): Property;
392
-
16
+ * The <code>Node</code> interface represents a node in a workspace.
17
+
18
+ */
19
+ type Node = Item & {
393
20
  /**
394
21
  * Sets the specified single-value property to the specified value. If the
395
22
  * property does not yet exist, it is created.
@@ -431,154 +58,6 @@ export type Node = {
431
58
  */
432
59
  setProperty(name: string, value: unknown): Property;
433
60
 
434
- /**
435
- * The behavior of this method is identical to that of {@link
436
- * #setProperty(String name, Value value)} except that the value is
437
- * specified as a {@link Binary} and, if possible, the type assigned to the
438
- * property is <code>BINARY</code>, otherwise a best-effort conversion is
439
- * attempted.
440
- *
441
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
442
- * @param name The name of a property of this node
443
- * @param value The value to assigned
444
- * @return The updated <code>Property</code> object
445
- * @throws ValueFormatException if <code>value</code> cannot be converted to the type of the specified property or if the property already exists and is multi-valued.
446
- * @throws VersionException if this node is read-only due to a checked-in node and this implementation performs this validation immediately.
447
- * @throws LockException if a lock prevents the setting of the property and this implementation performs this validation immediately.
448
- * @throws ConstraintViolationException if the change would violate a node-type or other constraint and this implementation performs this validation immediately.
449
- * @throws RepositoryException if another error occurs.
450
- * @since JCR 2.0
451
- */
452
- setProperty(name: string, value: Binary): Property;
453
-
454
- /**
455
- * The behavior of this method is identical to that of {@link
456
- * #setProperty(String name, Value value)} except that the value is
457
- * specified as a <code>boolean</code> and, if possible, the type assigned
458
- * to the property is <code>BOOLEAN</code>, otherwise a best-effort
459
- * conversion is attempted.
460
- *
461
- * <p><strong>Sitevision note:</strong> Limited to nodes of primary {@link javax.jcr.nodetype.NodeType}
462
- * <code>sv:simpleUser</code></p>
463
- * @param name The name of a property of this node
464
- * @param value The value to assigned
465
- * @return The updated <code>Property</code> object
466
- * @throws ValueFormatException if <code>value</code> cannot be converted to the type of the specified property or if the property already exists and is multi-valued.
467
- * @throws VersionException if this node is read-only due to a checked-in node and this implementation performs this validation immediately.
468
- * @throws LockException if a lock prevents the setting of the property and this implementation performs this validation immediately.
469
- * @throws ConstraintViolationException if the change would violate a node-type or other constraint and this implementation performs this validation immediately.
470
- * @throws RepositoryException if another error occurs.
471
- */
472
- setProperty(name: string, value: boolean): Property;
473
-
474
- /**
475
- * The behavior of this method is identical to that of {@link
476
- * #setProperty(String name, Value value)} except that the value is
477
- * specified as a <code>double</code> and, if possible, the type assigned to
478
- * the property is <code>DOUBLE</code>, otherwise a best-effort conversion
479
- * is attempted.
480
- *
481
- * <p><strong>Sitevision note:</strong> Limited to nodes of primary {@link javax.jcr.nodetype.NodeType}
482
- * <code>sv:simpleUser</code></p>
483
- * @param name The name of a property of this node
484
- * @param value The value to assigned
485
- * @return The updated <code>Property</code> object
486
- * @throws ValueFormatException if <code>value</code> cannot be converted to the type of the specified property or if the property already exists and is multi-valued.
487
- * @throws VersionException if this node is read-only due to a checked-in node and this implementation performs this validation immediately.
488
- * @throws LockException if a lock prevents the setting of the property and this implementation performs this validation immediately.
489
- * @throws ConstraintViolationException if the change would violate a node-type or other constraint and this implementation performs this validation immediately.
490
- * @throws RepositoryException if another error occurs.
491
- */
492
- setProperty(name: string, value: number): Property;
493
-
494
- /**
495
- * The behavior of this method is identical to that of {@link
496
- * #setProperty(String name, Value value)} except that the value is
497
- * specified as a {@link BigDecimal} and, if possible, the type assigned to
498
- * the property is <code>DECIMAL</code>, otherwise a best-effort conversion
499
- * is attempted.
500
- *
501
- * <p><strong>Sitevision note:</strong> Limited to nodes of primary {@link javax.jcr.nodetype.NodeType}
502
- * <code>sv:simpleUser</code></p>
503
- * @param name The name of a property of this node
504
- * @param value The value to assigned
505
- * @return The updated <code>Property</code> object
506
- * @throws ValueFormatException if <code>value</code> cannot be converted to the type of the specified property or if the property already exists and is multi-valued.
507
- * @throws VersionException if this node is read-only due to a checked-in node and this implementation performs this validation immediately.
508
- * @throws LockException if a lock prevents the setting of the property and this implementation performs this validation immediately.
509
- * @throws ConstraintViolationException if the change would violate a node-type or other constraint and this implementation performs this validation immediately.
510
- * @throws RepositoryException if another error occurs.
511
- * @since JCR 2.0
512
- */
513
- setProperty(name: string, value: unknown): Property;
514
-
515
- /**
516
- * The behavior of this method is identical to that of {@link
517
- * #setProperty(String name, Value value)} except that the value is
518
- * specified as a <code>long</code> and, if possible, the type assigned to
519
- * the property is <code>LONG</code>, otherwise a best-effort conversion is
520
- * attempted.
521
- *
522
- * <p><strong>Sitevision note:</strong> Limited to nodes of primary {@link javax.jcr.nodetype.NodeType}
523
- * <code>sv:simpleUser</code></p>
524
- * @param name The name of a property of this node
525
- * @param value The value to assigned
526
- * @return The updated <code>Property</code> object
527
- * @throws ValueFormatException if <code>value</code> cannot be converted to the type of the specified property or if the property already exists and is multi-valued.
528
- * @throws VersionException if this node is read-only due to a checked-in node and this implementation performs this validation immediately.
529
- * @throws LockException if a lock prevents the setting of the property and this implementation performs this validation immediately.
530
- * @throws ConstraintViolationException if the change would violate a node-type or other constraint and this implementation performs this validation immediately.
531
- * @throws RepositoryException if another error occurs.
532
- */
533
- setProperty(name: string, value: number): Property;
534
-
535
- /**
536
- * The behavior of this method is identical to that of {@link
537
- * #setProperty(String name, Value value)} except that the value is
538
- * specified as a {@link Calendar} and, if possible, the type assigned to
539
- * the property is <code>DATE</code>, otherwise a best-effort conversion is
540
- * attempted.
541
- *
542
- * <p><strong>Sitevision note:</strong> Limited to nodes of primary {@link javax.jcr.nodetype.NodeType}
543
- * <code>sv:simpleUser</code></p>
544
- * @param name The name of a property of this node
545
- * @param value The value to assigned
546
- * @return The updated <code>Property</code> object
547
- * @throws ValueFormatException if the specified property is a <code>DATE</code> but the <code>value</code> cannot be expressed in the ISO 8601-based format defined in the JCR 2.0 specification (section 3.6.4.3) and the implementation does not support dates incompatible with that format or if <code>value</code> cannot be converted to the type of the specified property or if the property already exists and is multi-valued.
548
- * @throws VersionException if this node is read-only due to a checked-in node and this implementation performs this validation immediately.
549
- * @throws LockException if a lock prevents the setting of the property and this implementation performs this validation immediately.
550
- * @throws ConstraintViolationException if the change would violate a node-type or other constraint and this implementation performs this validation immediately.
551
- * @throws RepositoryException if another error occurs.
552
- */
553
- setProperty(name: string, value: unknown): Property;
554
-
555
- /**
556
- * The behavior of this method is identical to that of {@link
557
- * #setProperty(String name, Value value)} except that the value is
558
- * specified as a {@link Node} and, if possible, the type assigned to the
559
- * property is <code>REFERENCE</code> or <code>WEAKREFERENCE</code>,
560
- * otherwise a best-effort conversion is attempted.
561
- * <p>
562
- * The value to which the property is set is the identifier of the passed
563
- * node.
564
- * <p>
565
- * If the named property does not yet exist and the repository cannot
566
- * determine whether a <code>REFERENCE</code> or <code>WEAKREFERENCE</code>
567
- * property is intended, then a <code>REFERENCE</code> property is created.
568
- *
569
- * <p><strong>Sitevision note:</strong> Limited to nodes of primary {@link javax.jcr.nodetype.NodeType}
570
- * <code>sv:simpleUser</code></p>
571
- * @param name The name of a property of this node
572
- * @param value The value to assigned
573
- * @return The updated <code>Property</code> object.
574
- * @throws ValueFormatException if this property is not of type <code>REFERENCE</code> or <code>WEAKREFERENCE</code> or the specified node is not referenceable or if the specified property already exists and is multi-valued.
575
- * @throws VersionException if this node is read-only due to a checked-in node and this implementation performs this validation immediately.
576
- * @throws LockException if a lock prevents the setting of the property and this implementation performs this validation immediately.
577
- * @throws ConstraintViolationException if the change would violate a node-type or other constraint and this implementation performs this validation immediately.
578
- * @throws RepositoryException if another error occurs.
579
- */
580
- setProperty(name: string, value: Node): Property;
581
-
582
61
  /**
583
62
  * Returns the node at <code>relPath</code> relative to this node.
584
63
  * <p>
@@ -648,42 +127,6 @@ export type Node = {
648
127
  */
649
128
  getNodes(namePattern: string): NodeIterator;
650
129
 
651
- /**
652
- * Gets all child nodes of this node accessible through the current
653
- * <code>Session</code> that match one or more of the <code>nameGlob</code>
654
- * strings in the passed array.
655
- * <p>
656
- * A glob may be a full name or a partial name with one or more wildcard
657
- * characters ("<code>*</code>"). For example,
658
- * <p>
659
- * <code>N.getNodes(new String[] {"jcr:*", "myapp:report", "my
660
- * doc"})</code>
661
- * <p>
662
- * would return a <code>NodeIterator</code> holding all accessible child
663
- * nodes of <code>N</code> that are either called '<code>myapp:report</code>',
664
- * begin with the prefix '<code>jcr:</code>' or are called '<code>my
665
- * doc</code>'.
666
- * <p>
667
- * Note that unlike in the case of the {@link #getNodes(String)} leading and
668
- * trailing whitespace around a glob is <i>not</i> ignored.
669
- * <p>
670
- * The globs are matched against the names (not the paths) of the immediate
671
- * child nodes of this node.
672
- * <p>
673
- * If this node has no accessible matching child nodes, then an empty
674
- * iterator is returned.
675
- * <p>
676
- * The same reacquisition semantics apply as with <code>{@link
677
- * #getNode(String)}</code>.
678
- *
679
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
680
- * @param nameGlobs an array of globbing strings.
681
- * @return a <code>NodeIterator</code>.
682
- * @throws RepositoryException if an unexpected error occurs.
683
- * @since JCR 2.0
684
- */
685
- getNodes(nameGlobs: string): NodeIterator;
686
-
687
130
  /**
688
131
  * Returns the property at <code>relPath</code> relative to
689
132
  * <code>this</code> node. The same reacquisition semantics apply as with
@@ -743,61 +186,6 @@ export type Node = {
743
186
  */
744
187
  getProperties(namePattern: string): PropertyIterator;
745
188
 
746
- /**
747
- * Gets all properties of this node accessible through the current
748
- * <code>Session</code> that match one or more of the <code>nameGlob</code>
749
- * strings in the passed array.
750
- * <p>
751
- * A glob may be a full name or a partial name with one or more wildcard
752
- * characters ("<code>*</code>"). For example,
753
- * <p>
754
- * <code>N.getProperties(new String[] {"jcr:*", "myapp:report", "my
755
- * doc"})</code>
756
- * <p>
757
- * would return a <code>PropertyIterator</code> holding all accessible
758
- * properties of <code>N</code> that are either called
759
- * '<code>myapp:report</code>', begin with the prefix '<code>jcr:</code>' or
760
- * are called '<code>my doc</code>'.
761
- * <p>
762
- * Note that unlike in the case of the {@link #getProperties(String)}
763
- * leading and trailing whitespace around a glob is <i>not</i> ignored.
764
- * <p>
765
- * The globs are matched against the names (not the paths) of the properties
766
- * of this node.
767
- * <p>
768
- * If this node has no accessible matching properties, then an empty
769
- * iterator is returned.
770
- * <p>
771
- * The same reacquisition semantics apply as with <code>{@link
772
- * #getProperty(String)}</code>.
773
- *
774
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
775
- * @param nameGlobs an array of globbing strings.
776
- * @return a <code>PropertyIterator</code>.
777
- * @throws RepositoryException if an unexpected error occurs.
778
- * @since JCR 2.0
779
- */
780
- getProperties(nameGlobs: string): PropertyIterator;
781
-
782
- /**
783
- * Returns the primary child item of this node. The primary node type of
784
- * this node may specify one child item (child node or property) of this
785
- * node as the <i>primary child item</i>. This method returns that item.
786
- * <p>
787
- * In cases where the primary child item specifies the name of a set
788
- * same-name sibling child nodes, the node returned will be the one among
789
- * the same-name siblings with index [1].
790
- * <p>
791
- * The same reacquisition semantics apply as with <code>{@link
792
- * #getNode(String)}</code>.
793
- *
794
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
795
- * @return the primary child item.
796
- * @throws ItemNotFoundException if this node does not have a primary child item, either because none is declared in the node type or because a declared primary item is not present on this node instance, or because none is accessible through the current <code>Session</code>.
797
- * @throws RepositoryException if another error occurs.
798
- */
799
- getPrimaryItem(): Item;
800
-
801
189
  /**
802
190
  * Returns the UUID of this node as recorded in this node's
803
191
  * <code>jcr:uuid</code> property. This method only works on nodes of mixin
@@ -825,111 +213,6 @@ export type Node = {
825
213
  */
826
214
  getIdentifier(): string;
827
215
 
828
- /**
829
- * This method returns the index of this node within the ordered set of its
830
- * same-name sibling nodes. This index is the one used to address same-name
831
- * siblings using the square-bracket notation, e.g.,
832
- * <code>/a[3]/b[4]</code>. Note that the index always starts at 1 (not 0),
833
- * for compatibility with XPath. As a result, for nodes that do not have
834
- * same-name-siblings, this method will always return 1.
835
- *
836
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
837
- * @return The index of this node within the ordered set of its same-name sibling nodes.
838
- * @throws RepositoryException if an error occurs.
839
- */
840
- getIndex(): number;
841
-
842
- /**
843
- * This method returns all <code>REFERENCE</code> properties that refer to
844
- * this node and that are accessible through the current
845
- * <code>Session</code>. Equivalent to <code>Node.getReferences(null)</code>.
846
- * <p>
847
- * If this node has no referring <code>REFERENCE</code> properties, an
848
- * empty iterator is returned. This includes the case where this node is not referenceable.
849
- *
850
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
851
- * @return A <code>PropertyIterator</code>.
852
- * @throws RepositoryException if an error occurs.
853
- * @see #getReferences(String)
854
- */
855
- getReferences(): PropertyIterator;
856
-
857
- /**
858
- * This method returns all <code>REFERENCE</code> properties that refer to
859
- * this node, have the specified <code>name</code> and that are accessible
860
- * through the current <code>Session</code>.
861
- * <p>
862
- * If the <code>name</code> parameter is <code>null</code> then all
863
- * referring <code>REFERENCES</code> are returned regardless of name.
864
- * <p>
865
- * Some implementations may only return properties that have been persisted.
866
- * Some may return both properties that have been persisted and those that
867
- * have been dispatched but not persisted (for example, those saved within a
868
- * transaction but not yet committed) while others implementations may
869
- * return these two categories of property as well as properties that are
870
- * still pending and not yet dispatched.
871
- * <p>
872
- * In implementations that support versioning, this method does not return
873
- * properties that are part of the frozen state of a version in version
874
- * storage.
875
- * <p>
876
- * If this node has no referring <code>REFERENCE</code> properties with the specified name, an
877
- * empty iterator is returned. This includes the case where this node is not referenceable.
878
- *
879
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
880
- * @param name name of referring <code>REFERENCE</code> properties to be returned; if <code>null</code> then all referring <code>REFERENCE</code>s are returned.
881
- * @return A <code>PropertyIterator</code>.
882
- * @throws RepositoryException if an error occurs.
883
- * @since JCR 2.0
884
- */
885
- getReferences(name: string): PropertyIterator;
886
-
887
- /**
888
- * This method returns all <code>WEAKREFERENCE</code> properties that refer
889
- * to this node and that are accessible through the current
890
- * <code>Session</code>. Equivalent to <code>Node.getWeakReferences(null)</code>.
891
- * <p>
892
- * If this node has no referring <code>WEAKREFERENCE</code> properties, an
893
- * empty iterator is returned. This includes the case where this node is not referenceable.
894
- *
895
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
896
- * @return A <code>PropertyIterator</code>.
897
- * @throws RepositoryException if an error occurs.
898
- * @see #getWeakReferences(String)
899
- * @since JCR 2.0
900
- */
901
- getWeakReferences(): PropertyIterator;
902
-
903
- /**
904
- * This method returns all <code>WEAKREFERENCE</code> properties that refer
905
- * to this node, have the specified <code>name</code> and that are
906
- * accessible through the current <code>Session</code>.
907
- * <p>
908
- * If the <code>name</code> parameter is <code>null</code> then all
909
- * referring <code>WEAKREFERENCE</code> are returned regardless of name.
910
- * <p>
911
- * Some implementations may only return properties that have been persisted.
912
- * Some may return both properties that have been persisted and those that
913
- * have been dispatched but not persisted (for example, those saved within a
914
- * transaction but not yet committed) while others implementations may
915
- * return these two categories of property as well as properties that are
916
- * still pending and not yet dispatched.
917
- * <p>
918
- * In implementations that support versioning, this method does not return
919
- * properties that are part of the frozen state of a version in version
920
- * storage.
921
- * <p>
922
- * If this node has no referring <code>WEAKREFERENCE</code> properties with the specified name, an
923
- * empty iterator is returned. This includes the case where this node is not referenceable.
924
- *
925
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
926
- * @param name name of referring <code>WEAKREFERENCE</code> properties to be returned; if <code>null</code> then all referring <code>WEAKREFERENCE</code>s are returned.
927
- * @return A <code>PropertyIterator</code>.
928
- * @throws RepositoryException if an error occurs.
929
- * @since JCR 2.0
930
- */
931
- getWeakReferences(name: string): PropertyIterator;
932
-
933
216
  /**
934
217
  * Indicates whether a node exists at <code>relPath</code> Returns
935
218
  * <code>true</code> if a node accessible through the current
@@ -1004,800 +287,48 @@ export type Node = {
1004
287
  isNodeType(nodeTypeName: string): boolean;
1005
288
 
1006
289
  /**
1007
- * Changes the primary node type of this node to <code>nodeTypeName</code>.
1008
- * Also immediately changes this node's <code>jcr:primaryType</code>
1009
- * property appropriately. Semantically, the new node type may take effect
1010
- * immediately or on dispatch but <i>must</i> take effect on persist. The
1011
- * behavior adopted must be the same as the behavior adopted for {@link
1012
- * #addMixin} and the behavior that occurs when a node is first created.
1013
- * <p>
1014
- * If the presence of an existing property or child node would cause an
1015
- * incompatibility with the new node type then a <code>ConstraintViolationException</code>
1016
- * is thrown either immediately, on dispatch or on persist.
1017
- * <p>
1018
- * If the new node type would cause this node to be incompatible with the
1019
- * node type of its parent then a <code>ConstraintViolationException</code>
1020
- * is thrown either immediately, on dispatch or on persist.
1021
- * <p>
1022
- * A <code>ConstraintViolationException</code> is also thrown either
1023
- * immediately, on dispatch or on persist if a conflict with an already
1024
- * assigned mixin occurs.
1025
- * <p>
1026
- * A <code>ConstraintViolationException</code> may also be thrown either
1027
- * immediately , on dispatch or on persist if the attempted change violates
1028
- * implementation-specific node type transition rules. A repository that
1029
- * disallows all primary node type changes would simple throw this exception
1030
- * in all cases.
1031
- * <p>
1032
- * If the specified node type is not recognized a <code>NoSuchNodeTypeException</code>
1033
- * is thrown either immediately, on dispatch or on persist.
1034
- * <p>
1035
- * A <code>VersionException</code> is thrown either immediately , on
1036
- * dispatch or on persist if this node is read-only dues to a check-in.
1037
- * <p>
1038
- * A <code>LockException</code> is thrown either immediately, on dispatch or
1039
- * on persist if a lock prevents the change of node type.
1040
- *
1041
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
1042
- * @param nodeTypeName the name of the new node type.
1043
- * @throws ConstraintViolationException if the specified primary node type creates a type conflict and this implementation performs this validation immediately.
1044
- * @throws NoSuchNodeTypeException If the specified <code>nodeTypeName</code> is not recognized and this implementation performs this validation immediately.
1045
- * @throws VersionException if this node is read-only due to a checked-in node and this implementation performs this validation immediately.
1046
- * @throws LockException if a lock prevents the change of the primary node type and this implementation performs this validation immediately.
1047
- * @throws RepositoryException if another error occurs.
290
+ * A constant for the JCR name <code>jcr:content</code>. This is the name of
291
+ * a child node declared in {@link NodeType#NT_FILE nt:file} and a property
292
+ * declared in {@link javax.jcr.nodetype.NodeType#NT_LINKED_FILE
293
+ * nt:linkedFile}.
1048
294
  * @since JCR 2.0
1049
295
  */
1050
- setPrimaryType(nodeTypeName: string): void;
1051
-
1052
- /**
1053
- * Adds the mixin node type named <code>mixinName</code> to this node. If
1054
- * this node is already of type <code>mixinName</code> (either due to a
1055
- * previously added mixin or due to its primary type, through inheritance)
1056
- * then this method has no effect. Otherwise <code>mixinName</code> is added
1057
- * to this node's <code>jcr:mixinTypes</code> property.
1058
- * <p>
1059
- * Semantically, the new node type <i>may</i> take effect immediately, on
1060
- * dispatch or on persist. The behavior adopted must be the same as the
1061
- * behavior adopted for {@link #setPrimaryType} and the behavior that occurs
1062
- * when a node is first created.
1063
- * <p>
1064
- * A <code>ConstraintViolationException</code> is thrown either immediately,
1065
- * on dispatch or on persist, if a conflict with another assigned mixin or
1066
- * the primary node type or for an implementation-specific reason.
1067
- * Implementations may differ on when this validation is done.
1068
- * <p>
1069
- * In some implementations it may only be possible to add mixin types before
1070
- * a a node is persisted <i>for the first time</i>. I such cases any later
1071
- * calls to <code>addMixin</code> will throw a <code>ConstraintViolationException</code>
1072
- * either immediately, on dispatch or on persist.
1073
- * <p>
1074
- * A <code>NoSuchNodeTypeException</code> is thrown either immediately, on
1075
- * dispatch or on persist, if the specified <code>mixinName</code> is not
1076
- * recognized. Implementations may differ on when this validation is done.
1077
- * <p>
1078
- * A <code>VersionException</code> is thrown either immediately, on dispatch
1079
- * or on persist, if this node is read-only due to a checked-in node.
1080
- * Implementations may differ on when this validation is done.
1081
- * <p>
1082
- * A <code>LockException</code> is thrown either immediately, on dispatch or
1083
- * on persist, if a lock prevents the addition of the mixin. Implementations
1084
- * may differ on when this validation is done.
1085
- *
1086
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
1087
- * @param mixinName the name of the mixin node type to be added
1088
- * @throws NoSuchNodeTypeException If the specified <code>mixinName</code> is not recognized and this implementation performs this validation immediately.
1089
- * @throws ConstraintViolationException if the specified mixin node type creates a conflict and this implementation performs this validation immediately.
1090
- * @throws VersionException if this node is read-only due to a checked-in node and this implementation performs this validation immediately.
1091
- * @throws LockException if a lock prevents the addition of the mixin and this implementation performs this validation immediately.
1092
- * @throws RepositoryException if another error occurs.
1093
- */
1094
- addMixin(mixinName: string): void;
1095
-
1096
- /**
1097
- * Removes the specified mixin node type from this node and removes
1098
- * <code>mixinName</code> from this node's <code>jcr:mixinTypes</code>
1099
- * property. Both the semantic change in effective node type and the
1100
- * persistence of the change to the <code>jcr:mixinTypes</code> property
1101
- * occur on persist.
1102
- * <p>
1103
- * If this node does not have the specified mixin, a
1104
- * <code>NoSuchNodeTypeException</code> is thrown either immediately, on
1105
- * dispatch or on persist. Implementations may differ on when this
1106
- * validation is done.
1107
- * <p>
1108
- * A <code>ConstraintViolationException</code> will be thrown either
1109
- * immediately, on dispatch or on persist, if the removal of a mixin is not
1110
- * allowed. Implementations are free to enforce any policy with regard to
1111
- * mixin removal and may differ on when this validation is done.
1112
- * <p>
1113
- * A <code>VersionException</code> is thrown either immediately, on dispatch
1114
- * or on persist, if this node is read-only due to a checked-in node.
1115
- * Implementations may differ on when this validation is done.
1116
- * <p>
1117
- * A <code>LockException</code> is thrown either immediately or on
1118
- * <code>save</code> if a lock prevents the removal of the mixin.
1119
- * Implementations may differ on when this validation is done.
1120
- *
1121
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
1122
- * @param mixinName the name of the mixin node type to be removed.
1123
- * @throws NoSuchNodeTypeException if the specified <code>mixinName</code> is not currently assigned to this node and this implementation performs this validation immediately.
1124
- * @throws ConstraintViolationException if the specified mixin node type is prevented from being removed and this implementation performs this validation immediately.
1125
- * @throws VersionException if this node is read-only due to a checked-in node and this implementation performs this validation immediately.
1126
- * @throws LockException if a lock prevents the removal of the mixin and this implementation performs this validation immediately.
1127
- * @throws RepositoryException if another error occurs.
1128
- */
1129
- removeMixin(mixinName: string): void;
1130
-
1131
- /**
1132
- * Returns <code>true</code> if calling {@link #addMixin} on this node
1133
- * with the mixn node type <code>mixinName</code> will not fail. Returns
1134
- * <code>false</code> otherwise.
1135
- *
1136
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
1137
- * @param mixinName The name of the mixin to be tested.
1138
- * @return <code>true</code> if addMixin will not fail when called on this node with the specified <code>mixinName</code>; <code>false</code> otherwise.
1139
- * @throws NoSuchNodeTypeException if the specified mixin node type name is not recognized.
1140
- * @throws RepositoryException if another error occurs.
1141
- */
1142
- canAddMixin(mixinName: string): boolean;
1143
-
1144
- /**
1145
- * Returns the node definition that applies to this node. In some cases
1146
- * there may appear to be more than one definition that could apply to this
1147
- * node. However, it is assumed that upon creation of this node, a single
1148
- * particular definition was used and it is <i>that</i> definition that this
1149
- * method returns. How this governing definition is selected upon node
1150
- * creation from among others which may have been applicable is an
1151
- * implementation issue and is not covered by this specification. The
1152
- * <code>NodeDefinition</code> returned when this method is called on the
1153
- * root node of a workspace is also up to the implementation.
1154
- *
1155
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
1156
- * @return a <code>NodeDefinition</code> object.
1157
- * @throws RepositoryException if an error occurs.
1158
- * @see NodeType#getChildNodeDefinitions
1159
- */
1160
- getDefinition(): NodeDefinition;
1161
-
1162
- /**
1163
- * Creates a new version of this node and returns that {@link Version}
1164
- * object. The new version becomes the <i>base version</i> of this node. The
1165
- * name of the new version is implementaion determined.
1166
- * <p>
1167
- * This node becomes <i>checked-in</i> and its <code>jcr:checkedOut</code>
1168
- * property is set to false to reflect this. On a successful check-in the
1169
- * change to this property is made as a workspace-write, and therefore does
1170
- * not require a <code>save</code>.
1171
- * <p>
1172
- * The part of the subgraph of this node that is affected by check-in
1173
- * becomes read-only (see the specification for details).
1174
- * <p>
1175
- * If this node is already checked-in, this method has no effect but returns
1176
- * the current base version of this node.
1177
- *
1178
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
1179
- * @return the created version.
1180
- * @throws VersionException if a child item of this node has an <code>OnParentVersion</code> status of <code>ABORT</code>. This includes the case (under full versioning) where an unresolved merge failure exists on this node, as indicated by the presence of a <code>jcr:mergeFailed</code> property. Under full versioning this exception is also thrown if the <code>jcr:predecessors</code> property of the node has no values.
1181
- * @throws UnsupportedRepositoryOperationException if this node is not versionable.
1182
- * @throws InvalidItemStateException if unsaved changes exist on this node.
1183
- * @throws LockException If a lock prevents the operation.
1184
- * @throws RepositoryException If another error occurs.
1185
- * @deprecated As of JCR 2.0, {@link javax.jcr.version.VersionManager#checkin} should be used instead.
1186
- */
1187
- checkin(): Version;
1188
-
1189
- /**
1190
- * Sets this versionable node to checked-out status by setting its
1191
- * <code>jcr:isCheckedOut</code> property to <code>true</code>. Under full
1192
- * versioning it also sets the <code>jcr:predecessors</code> property to be
1193
- * a reference to the current base version (the same value as held in
1194
- * <code>jcr:baseVersion</code>). These changes are made by worksapce-write
1195
- * and therefore do require a <code>save</code>.
1196
- * <p>
1197
- * The part of the subgraph of this node that is affected by the checked-out
1198
- * status of this node becomes no longer read-only.
1199
- * <p>
1200
- * If this node is already checked-out, this method has no effect.
1201
- *
1202
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
1203
- * @throws UnsupportedRepositoryOperationException if this node is not versionable.
1204
- * @throws LockException if a lock prevents the checkout.
1205
- * @throws ActivityViolationException if the checkout conflicts with the activity present on the current session.
1206
- * @throws RepositoryException if another error occurs.
1207
- * @deprecated As of JCR 2.0, {@link javax.jcr.version.VersionManager#checkout} should be used instead.
1208
- */
1209
- checkout(): void;
1210
-
1211
- /**
1212
- * <i>Support for this method is only required under full versioning.</i>
1213
- * <p>
1214
- * Completes the merge process with respect to this node and the specified
1215
- * <code>version</code>.
1216
- * <p>
1217
- * When the {@link #merge} method is called on a node, every versionable
1218
- * node in that subgraph is compared with its corresponding node in the
1219
- * indicated other workspace and a "merge test result" is determined
1220
- * indicating one of the following: <ol> <li> This node will be updated to
1221
- * the state of its correspondee (if the base version of the correspondee is
1222
- * more recent in terms of version history). </li> <li> This node will be
1223
- * left alone (if this node's base version is more recent in terms of
1224
- * version history). </li> <li> This node will be marked as having failed
1225
- * the merge test (if this node's base version is on a different branch of
1226
- * the version history from the base version of its corresponding node in
1227
- * the other workspace, thus preventing an automatic determination of which
1228
- * is more recent). </li> </ol> (See {@link #merge} for more details)
1229
- * <p>
1230
- * In the last case the merging of the subgraph of the versionable node in
1231
- * question must be done by the application (for example, by providing a
1232
- * merge tool for the user).
1233
- * <p>
1234
- * Additionally, once the subgraphs of the nodes has been merged, their
1235
- * version graph branches must also be merged. The JCR versioning system
1236
- * provides for this by keeping a record, for each versionable node that
1237
- * fails the merge test, of the base version of the corresponding node that
1238
- * caused the merge failure. This record is kept in the
1239
- * <code>jcr:mergeFailed</code> property of this node. After a
1240
- * <code>merge</code>, this property will contain one or more (if multiple
1241
- * merges have been performed) <code>REFERENCE</code>s that point to the
1242
- * "failed versions".
1243
- * <p>
1244
- * To complete the merge process, the client calls <code>doneMerge(Version
1245
- * v)</code> passing the version object referred to be the
1246
- * <code>jcr:mergeFailed</code> property that the client wishes to connect
1247
- * to <code>this</code> node in the version graph. This has the effect of
1248
- * moving the reference to the indicated version from the
1249
- * <code>jcr:mergeFailed</code> property of <code>this</code> node to the
1250
- * <code>jcr:predecessors</code>.
1251
- * <p>
1252
- * If the client chooses not to connect this node to a particular version
1253
- * referenced in the <code>jcr:mergeFailed</code> property, he calls {@link
1254
- * #cancelMerge(Version version)}. This has the effect of removing the
1255
- * reference to the specified <code>version</code> from
1256
- * <code>jcr:mergeFailed</code> <i>without</i> adding it to
1257
- * <code>jcr:predecessors</code>.
1258
- * <p>
1259
- * Once the last reference in <code>jcr:mergeFailed</code> has been either
1260
- * moved to <code>jcr:predecessors</code> (with <code>doneMerge</code>) or
1261
- * just removed from <code>jcr:mergeFailed</code> (with
1262
- * <code>cancelMerge</code>) the <code>jcr:mergeFailed</code> property is
1263
- * automatically removed, thus enabling <code>this</code> node to be
1264
- * checked-in, creating a new version (note that before the
1265
- * <code>jcr:mergeFailed</code> is removed, its <code>OnParentVersion</code>
1266
- * setting of <code>ABORT</code> prevents checkin). This new version will
1267
- * have a predecessor connection to each version for which
1268
- * <code>doneMerge</code> was called, thus joining those branches of the
1269
- * version graph.
1270
- * <p>
1271
- * If successful, these changes are persisted immediately, there is no need
1272
- * to call <code>save</code>.
1273
- *
1274
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
1275
- * @param version a version referred to by this node's <code>jcr:mergeFailed</code> property.
1276
- * @throws VersionException if the version specifed is not among those referenced in this node's <code>jcr:mergeFailed</code> or if this node is currently checked-in.
1277
- * @throws InvalidItemStateException if there are unsaved changes pending on this node.
1278
- * @throws UnsupportedRepositoryOperationException if this node is not versionable.
1279
- * @throws RepositoryException if another error occurs.
1280
- * @deprecated As of JCR 2.0, {@link javax.jcr.version.VersionManager#doneMerge} should be used instead.
1281
- */
1282
- doneMerge(version: Version): void;
1283
-
1284
- /**
1285
- * <i>Support for this method is only required under full versioning.</i>
1286
- * <p>
1287
- * Cancels the merge process with respect to this node and specified
1288
- * <code>version</code>.
1289
- * <p>
1290
- * See {@link #doneMerge} for a full explanation. Also see {@link #merge}
1291
- * for more details.
1292
- * <p>
1293
- * If successful, these changes are persisted immediately, there is no need
1294
- * to call <code>save</code>.
1295
- *
1296
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
1297
- * @param version a version referred to by this node's <code>jcr:mergeFailed</code> property.
1298
- * @throws VersionException if the version specified is not among those referenced in this node's <code>jcr:mergeFailed</code> or if this node is currently checked-in.
1299
- * @throws InvalidItemStateException if there are unsaved changes pending on this node.
1300
- * @throws UnsupportedRepositoryOperationException if this node is not versionable.
1301
- * @throws RepositoryException if another error occurs.
1302
- * @deprecated As of JCR 2.0, {@link javax.jcr.version.VersionManager#cancelMerge} should be used instead.
1303
- */
1304
- cancelMerge(version: Version): void;
1305
-
1306
- /**
1307
- * If this node does have a corresponding node in the workspace
1308
- * <code>srcWorkspace</code>, then this replaces this node and its subgraph
1309
- * with a clone of the corresponding node and its subgraph.
1310
- * <p>
1311
- * If this node does not have a corresponding node in the workspace
1312
- * <code>srcWorkspace</code>, then the <code>update</code> method has no
1313
- * effect.
1314
- * <p>
1315
- * If the <code>update</code> succeeds the changes made are persisted
1316
- * immediately, there is no need to call <code>save</code>.
1317
- * <p>
1318
- * Note that <code>update</code> does not respect the checked-in status of
1319
- * nodes. An <code>update</code> may change a node even if it is currently
1320
- * checked-in (This fact is only relevant in an implementation that supports
1321
- * versioning).
1322
- *
1323
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
1324
- * @param srcWorkspace the name of the source workspace.
1325
- * @throws NoSuchWorkspaceException If <code>srcWorkspace</code> does not exist.
1326
- * @throws InvalidItemStateException if this <code>Session</code> (not necessarily this <code>Node</code>) has pending unsaved changes.
1327
- * @throws AccessDeniedException If the current session does not have sufficent access to perform the operation.
1328
- * @throws LockException if a lock prevents the update.
1329
- * @throws RepositoryException If another error occurs.
1330
- */
1331
- update(srcWorkspace: string): void;
296
+ JCR_CONTENT: string;
1332
297
 
1333
298
  /**
1334
- * <i>Support for this method is only required under full versioning.</i>
1335
- * <p>
1336
- * This method can be thought of as a version-sensitive update.
1337
- * <p>
1338
- * It recursively tests each versionable node in the subgraph of this node
1339
- * against its corresponding node in <code>srcWorkspace</code> with respect
1340
- * to the relation between their respective base versions and either updates
1341
- * the node in question or not, depending on the outcome of the test.
1342
- * <p>
1343
- * A <code>MergeException</code> is thrown if <code>bestEffort</code> is
1344
- * <code>false</code> and a versionable node is encountered whose
1345
- * corresponding node's base version is on a divergent branch from this
1346
- * node's base version.
1347
- * <p>
1348
- * If successful, the changes are persisted immediately, there is no need to
1349
- * call <code>save</code>.
1350
- * <p>
1351
- * This method returns a <code>NodeIterator</code> over all versionable
1352
- * nodes in the subgraph that received a merge result of <i>fail</i>. If
1353
- * <code>bestEffort</code> is <code>false</code>, this iterator will be
1354
- * empty (since if <code>merge</code> returns successfully, instead of
1355
- * throwing an exception, it will be because no failures were encountered).
1356
- * If <code>bestEffort</code> is <code>true</code>, this iterator will
1357
- * contain all nodes that received a <i>fail</i> during the course of this
1358
- * <code>merge</code> operation.
1359
- *
1360
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
1361
- * @param srcWorkspace the name of the source workspace.
1362
- * @param bestEffort a boolean
1363
- * @return iterator over all nodes that received a merge result of "fail" in the course of this operation.
1364
- * @throws MergeException if <code>bestEffort</code> is <code>false</code> and a failed merge result is encountered.
1365
- * @throws InvalidItemStateException if this session (not necessarily this <code>node</code>) has pending unsaved changes.
1366
- * @throws NoSuchWorkspaceException if the specified <code>srcWorkspace</code> does not exist.
1367
- * @throws AccessDeniedException if the current session does not have sufficient rights to perform the operation.
1368
- * @throws LockException if a lock prevents the merge.
1369
- * @throws RepositoryException if another error occurs.
1370
- * @deprecated As of JCR 2.0, {@link javax.jcr.version.VersionManager#merge} should be used instead.
1371
- */
1372
- merge(srcWorkspace: string, bestEffort: boolean): NodeIterator;
1373
-
1374
- /**
1375
- * Returns the absolute path of the node in the specified workspace that
1376
- * corresponds to <code>this</code> node.
1377
- *
1378
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
1379
- * @param workspaceName the name of the workspace.
1380
- * @return the absolute path to the corresponding node.
1381
- * @throws ItemNotFoundException if no corresponding node is found.
1382
- * @throws NoSuchWorkspaceException if the workspace is unknown.
1383
- * @throws AccessDeniedException if the current <code>session</code> has insufficent access capabilities to perform this operation.
1384
- * @throws RepositoryException if another error occurs.
1385
- */
1386
- getCorrespondingNodePath(workspaceName: string): string;
1387
-
1388
- /**
1389
- * Returns an iterator over all nodes that are in the shared set of this
1390
- * node. If this node is not shared then the returned iterator contains only
1391
- * this node.
1392
- *
1393
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
1394
- * @return a <code>NodeIterator</code>.
1395
- * @throws RepositoryException if an error occurs.
299
+ * A constant for the node name <code>jcr:propertyDefinition</code> declared
300
+ * in {@link NodeType#NT_FILE nt:nodeType}.
1396
301
  * @since JCR 2.0
1397
302
  */
1398
- getSharedSet(): NodeIterator;
303
+ JCR_PROPERTY_DEFINITION: string;
1399
304
 
1400
305
  /**
1401
- * Removes this node and every other node in the shared set of this node.
1402
- * <p>
1403
- * This removal must be done atomically, i.e., if one of the nodes cannot be
1404
- * removed, the method throws the exception {@link Node#remove()} would have
1405
- * thrown in that case, and none of the nodes are removed.
1406
- * <p>
1407
- * If this node is not shared this method removes only this node.
1408
- *
1409
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
1410
- * @throws VersionException if the parent node of this item is versionable and checked-in or is non-versionable but its nearest versionable ancestor is checked-in and this implementation performs this validation immediately instead of waiting until <code>save</code>.
1411
- * @throws LockException if a lock prevents the removal of this item and this implementation performs this validation immediately instead of waiting until <code>save</code>.
1412
- * @throws ConstraintViolationException if removing the specified item would violate a node type or implementation-specific constraint and this implementation performs this validation immediately instead of waiting until <code>save</code>.
1413
- * @throws RepositoryException if another error occurs.
1414
- * @see #removeShare()
1415
- * @see Item#remove()
1416
- * @see javax.jcr.Session#removeItem(String)
306
+ * A constant for the node name <code>jcr:childNodeDefinition</code>
307
+ * declared in {@link NodeType#NT_FILE nt:nodeType}.
1417
308
  * @since JCR 2.0
1418
309
  */
1419
- removeSharedSet(): void;
310
+ JCR_CHILD_NODE_DEFINITION: string;
1420
311
 
1421
312
  /**
1422
- * Removes this node, but does not remove any other node in the shared set
1423
- * of this node.
1424
- *
1425
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
1426
- * @throws VersionException if the parent node of this item is versionable and checked-in or is non-versionable but its nearest versionable ancestor is checked-in and this implementation performs this validation immediately instead of waiting until <code>save</code>.
1427
- * @throws LockException if a lock prevents the removal of this item and this implementation performs this validation immediately instead of waiting until <code>save</code>.
1428
- * @throws ConstraintViolationException if removing the specified item would violate a node type or implementation-specific constraint and this implementation performs this validation immediately instead of waiting until <code>save</code>.
1429
- * @throws RepositoryException if if this node cannot be removed without removing another node in the shared set of this node or another error occurs.
1430
- * @see #removeSharedSet()
1431
- * @see Item#remove()
1432
- * @see javax.jcr.Session#removeItem(String)
313
+ * A constant for the node name <code>jcr:rootVersion</code> declared in
314
+ * {@link NodeType#NT_VERSION_HISTORY nt:versionHistory}.
1433
315
  * @since JCR 2.0
1434
316
  */
1435
- removeShare(): void;
1436
-
1437
- /**
1438
- * Returns <code>false</code> if this node is currently in the checked-in state
1439
- * (either due to its own status as a versionable node or due to the effect of
1440
- * a versionable node being checked in above it). Otherwise this method returns
1441
- * <code>true</code>. This includes the case where the repository does not
1442
- * support versioning (and therefore all nodes are always "checked-out",
1443
- * by default).
1444
- *
1445
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
1446
- * @return a boolean
1447
- * @throws RepositoryException if an error occurs.
1448
- */
1449
- isCheckedOut(): boolean;
1450
-
1451
- /**
1452
- * Restores <code>this</code> node to the state defined by the version with
1453
- * the specified <code>versionName</code>.
1454
- * <p>
1455
- * This method will work regardless of whether this node is checked-in or
1456
- * not.
1457
- * <p>
1458
- * An identifier collision occurs when a node exists <i>outside the subgraph
1459
- * rooted at this node</i> with the same identifier as a node that would be
1460
- * introduced by the <code>restore</code> operation <i>into the subgraph at
1461
- * this node</i>. The result in such a case is governed by the
1462
- * <code>removeExisting</code> flag. If <code>removeExisting</code> is
1463
- * <code>true</code>, then the incoming node takes precedence, and the
1464
- * existing node (and its subgraph) is removed (if possible; otherwise a
1465
- * <code>RepositoryException</code> is thrown). If <code>removeExisting</code>
1466
- * is <code>false</code>, then a <code>ItemExistsException</code> is thrown
1467
- * and no changes are made. Note that this applies not only to cases where
1468
- * the restored node itself conflicts with an existing node but also to
1469
- * cases where a conflict occurs with any node that would be introduced into
1470
- * the workspace by the restore operation. In particular, conflicts
1471
- * involving subnodes of the restored node that have
1472
- * <code>OnParentVersion</code> settings of <code>COPY</code> or
1473
- * <code>VERSION</code> are also governed by the <code>removeExisting</code>
1474
- * flag.
1475
- *
1476
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
1477
- * @param versionName a <code>Version</code> object
1478
- * @param removeExisting a boolean flag that governs what happens in case of an identifier collision.
1479
- * @throws UnsupportedRepositoryOperationException if this node is not versionable.
1480
- * @throws VersionException if the specified <code>version</code> is not part of this node's version history or if an attempt is made to restore the root version (<code>jcr:rootVersion</code>).
1481
- * @throws ItemExistsException if <code>removeExisting</code> is <code>false</code> and an identifier collision occurs.
1482
- * @throws LockException if a lock prevents the restore.
1483
- * @throws InvalidItemStateException if this <code>Session</code> (not necessarily this <code>Node</code>) has pending unsaved changes.
1484
- * @throws RepositoryException If another error occurs.
1485
- * @deprecated As of JCR 2.0, {@link javax.jcr.version.VersionManager#restore} should be used instead.
1486
- */
1487
- restore(versionName: string, removeExisting: boolean): void;
1488
-
1489
- /**
1490
- * Restores <code>this</code> node to the state defined by the specified
1491
- * <code>version</code>.
1492
- * <p>
1493
- * If successful, the change is persisted immediately and there is no need
1494
- * to call <code>save</code>.
1495
- * <p>
1496
- * This method will work regardless of whether this node is checked-in or
1497
- * not.
1498
- * <p>
1499
- * An identifier collision occurs when a node exists <i>outside the subgraph
1500
- * rooted at this node</i> with the same identifier as a node that would be
1501
- * introduced by the <code>restore</code> operation <i>into the subgraph at
1502
- * this node</i>. The result in such a case is governed by the
1503
- * <code>removeExisting</code> flag. If <code>removeExisting</code> is
1504
- * <code>true</code>, then the incoming node takes precedence, and the
1505
- * existing node (and its subgraph) is removed (if possible; otherwise a
1506
- * <code>RepositoryException</code> is thrown). If <code>removeExisting</code>
1507
- * is <code>false</code>, then a <code>ItemExistsException</code> is thrown
1508
- * and no changes are made. Note that this applies not only to cases where
1509
- * the restored node itself conflicts with an existing node but also to
1510
- * cases where a conflict occurs with any node that would be introduced into
1511
- * the workspace by the restore operation. In particular, conflicts
1512
- * involving subnodes of the restored node that have
1513
- * <code>OnParentVersion</code> settings of <code>COPY</code> or
1514
- * <code>VERSION</code> are also governed by the <code>removeExisting</code>
1515
- * flag.
1516
- *
1517
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
1518
- * @param version a <code>Version</code> object
1519
- * @param removeExisting a boolean flag that governs what happens in case of an identifier collision.
1520
- * @throws UnsupportedRepositoryOperationException if this node is not versionable.
1521
- * @throws VersionException if the specified <code>version</code> is not part of this node's version history or if an attempt is made to restore the root version (<code>jcr:rootVersion</code>).
1522
- * @throws ItemExistsException if <code>removeExisting</code> is <code>false</code> and an identifier collision occurs.
1523
- * @throws InvalidItemStateException if this <code>Session</code> (not necessarily this <code>Node</code>) has pending unsaved changes.
1524
- * @throws LockException if a lock prevents the restore.
1525
- * @throws RepositoryException if another error occurs.
1526
- * @deprecated As of JCR 2.0, {@link javax.jcr.version.VersionManager#restore} should be used instead.
1527
- */
1528
- restore(version: Version, removeExisting: boolean): void;
1529
-
1530
- /**
1531
- * Restores the specified version to <code>relPath</code>, relative to this
1532
- * node.
1533
- * <p>
1534
- * If the <code>restore</code> succeeds, the changes made to this node are
1535
- * persisted immediately, there is no need to call <code>save</code>.
1536
- * <p>
1537
- * A node need not exist at relPath, though the parent of
1538
- * <code>relPath</code> must exist.
1539
- * <p>
1540
- * If a node <i>does</i> exist at relPath then it must correspond to the
1541
- * version being restored (the version must be a version <i>of that
1542
- * node</i>) and must not be a root version (<code>jcr:rootVersion</code>),
1543
- * otherwise a <code>VersionException</code> is thrown.
1544
- * <p>
1545
- * If no node exists at <code>relPath</code> then a <code>VersionException</code>
1546
- * is thrown if the parent node of <code>relPath</code> is read-only due to
1547
- * a check-in. However, If there <i>is</i> a node at <code>relPath</code>
1548
- * then the read-only status of that node itself and the read-only status of
1549
- * its parent are irrelevant. The restore will work even if one or both are
1550
- * read-only due to a checked-in node.
1551
- * <p>
1552
- * An identifier collision occurs when a node exists <i>outside the subgraph
1553
- * rooted at <code>relPath</code></i> with the same identifier as a node
1554
- * that would be introduced by the <code>restore</code> operation <i>into
1555
- * the subgraph at <code>relPath</code></i> (Note that in cases where there
1556
- * is no node at <code>relPath</code>, this amounts to saying that an
1557
- * identifier collision occurs if there exists a node <i>anywhere</i> in
1558
- * this workspace with the same identifier as a node that would be
1559
- * introduced by the <code>restore</code>). The result in such a case is
1560
- * governed by the <code>removeExisting</code> flag. If
1561
- * <code>removeExisting</code> is <code>true</code>, then the incoming node
1562
- * takes precedence, and the existing node (and its subgraph) is removed (if
1563
- * possible; otherwise a <code>RepositoryException</code> is thrown). If
1564
- * <code>removeExisting</code> is <code>false</code>, then a
1565
- * <code>ItemExistsException</code> is thrown and no changes are made. Note
1566
- * that this applies not only to cases where the restored node itself
1567
- * conflicts with an existing node but also to cases where a conflict occurs
1568
- * with any node that would be introduced into the workspace by the restore
1569
- * operation. In particular, conflicts involving subnodes of the restored
1570
- * node that have <code>OnParentVersion</code> settings of <code>COPY</code>
1571
- * or <code>VERSION</code> are also governed by the <code>removeExisting</code>
1572
- * flag.
1573
- *
1574
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
1575
- * @param version a version object
1576
- * @param relPath the path to which the version is to be restored
1577
- * @param removeExisting governs what happens on identifier collision.
1578
- * @throws PathNotFoundException if the parent of <code>relPath</code> does not exist.
1579
- * @throws ItemExistsException if removeExisting is false and an identifier collision occurs
1580
- * @throws ConstraintViolationException if the would-be parent of the location <code>relPath</code> is actually a property, or if a node type restriction would be violated
1581
- * @throws VersionException if the parent node of <code>relPath</code> is read-only due to a checked-in node or if a node exists at relPath that is not the node corresponding to the specified <code>version</code> or if an attempt is made to restore the root version (<code>jcr:rootVersion</code>).
1582
- * @throws UnsupportedRepositoryOperationException if versioning is not supported.
1583
- * @throws LockException if a lock prevents the restore.
1584
- * @throws InvalidItemStateException if this <code>Session</code> (not necessarily this <code>Node</code>) has pending unsaved changes.
1585
- * @throws RepositoryException if another error occurs
1586
- * @deprecated As of JCR 2.0, {@link javax.jcr.version.VersionManager#restore} should be used instead.
1587
- */
1588
- restore(version: Version, relPath: string, removeExisting: boolean): void;
1589
-
1590
- /**
1591
- * Restores the version of this node with the specified version label.
1592
- * <p>
1593
- * If successful, the change is persisted immediately and there is no need
1594
- * to call <code>save</code>.
1595
- * <p>
1596
- * This method will work regardless of whether this node is checked-in or
1597
- * not.
1598
- * <p>
1599
- * An identifier collision occurs when a node exists <i>outside the subgraph
1600
- * rooted at this node</i> with the same identifier as a node that would be
1601
- * introduced by the <code>restoreByLabel</code> operation <i>into the
1602
- * subgraph at this node</i>. The result in such a case is governed by the
1603
- * <code>removeExisting</code> flag. If <code>removeExisting</code> is
1604
- * <code>true</code>, then the incoming node takes precedence, and the
1605
- * existing node (and its subgraph) is removed (if possible; otherwise a
1606
- * <code>RepositoryException</code> is thrown). If <code>removeExisting</code>
1607
- * is <code>false</code>, then a <code>ItemExistsException</code> is thrown
1608
- * and no changes are made. Note that this applies not only to cases where
1609
- * the restored node itself conflicts with an existing node but also to
1610
- * cases where a conflict occurs with any node that would be introduced into
1611
- * the workspace by the restore operation. In particular, conflicts
1612
- * involving subnodes of the restored node that have
1613
- * <code>OnParentVersion</code> settings of <code>COPY</code> or
1614
- * <code>VERSION</code> are also governed by the <code>removeExisting</code>
1615
- * flag.
1616
- * <p>
1617
- * Note the special behavior in case of chained versions where a child node
1618
- * of this node has an on <code>OnParentVersion</code>settings of
1619
- * <code>VERSION</code> and is mix:versionable: If there is a version of the
1620
- * child node with the specified label, then that version is restored;
1621
- * otherwise the determination depends on the configuration of the workspace
1622
- * and is defined by the implementation.
1623
- *
1624
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
1625
- * @param versionLabel a String
1626
- * @param removeExisting a boolean flag that governs what happens in case of an identifier collision.
1627
- * @throws UnsupportedRepositoryOperationException if this node is not versionable.
1628
- * @throws VersionException if the specified <code>versionLabel</code> does not exist in this node's version history.
1629
- * @throws ItemExistsException if <code>removeExisting</code> is <code>false</code> and an identifier collision occurs.
1630
- * @throws LockException if a lock prevents the restore.
1631
- * @throws InvalidItemStateException if this <code>Session</code> (not necessarily this <code>Node</code>) has pending unsaved changes.
1632
- * @throws RepositoryException If another error occurs.
1633
- * @deprecated As of JCR 2.0, {@link javax.jcr.version.VersionManager#restoreByLabel} should be used instead.
1634
- */
1635
- restoreByLabel(versionLabel: string, removeExisting: boolean): void;
317
+ JCR_ROOT_VERSION: string;
1636
318
 
1637
319
  /**
1638
- * Returns the <code>VersionHistory</code> object of this node. Under full
1639
- * versioning this object provides access to the <code>nt:versionHistory</code>
1640
- * node holding this node's versions.
1641
- *
1642
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
1643
- * @return a <code>VersionHistory</code> object
1644
- * @throws UnsupportedRepositoryOperationException if this node is not versionable.
1645
- * @throws RepositoryException if another error occurs.
1646
- * @deprecated As of JCR 2.0, {@link javax.jcr.version.VersionManager#getVersionHistory} should be used instead.
1647
- */
1648
- getVersionHistory(): VersionHistory;
1649
-
1650
- /**
1651
- * Returns the current base version of this versionable node.
1652
- *
1653
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
1654
- * @return a <code>Version</code> object.
1655
- * @throws UnsupportedRepositoryOperationException if this node is not versionable.
1656
- * @throws RepositoryException if another error occurs.
1657
- * @deprecated As of JCR 2.0, {@link javax.jcr.version.VersionManager#getBaseVersion} should be used instead.
1658
- */
1659
- getBaseVersion(): Version;
1660
-
1661
- /**
1662
- * Places a lock on this node. If successful, this node is said to
1663
- * <i>hold</i> the lock.
1664
- * <p>
1665
- * If <code>isDeep</code> is <code>true</code> then the lock applies to this
1666
- * node and all its descendant nodes; if <code>false</code>, the lock
1667
- * applies only to this, the holding node.
1668
- * <p>
1669
- * If <code>isSessionScoped</code> is <code>true</code> then this lock will
1670
- * expire upon the expiration of the current session (either through an
1671
- * automatic or explicit <code>Session.logout</code>); if
1672
- * <code>false</code>, this lock does not expire until explicitly unlocked
1673
- * or automatically unlocked due to a implementation-specific limitation,
1674
- * such as a timeout.
1675
- * <p>
1676
- * Returns a <code>Lock</code> object reflecting the state of the new lock.
1677
- * <p>
1678
- * If the lock is open-scoped the returned lock will include a lock token.
1679
- * <p>
1680
- * The lock token is also automatically added to the set of lock tokens held
1681
- * by the current <code>Session</code>.
1682
- * <p>
1683
- * If successful, then the property <code>jcr:lockOwner</code> is created
1684
- * and set to the value of <code>Session.getUserID</code> for the current
1685
- * session and the property <code>jcr:lockIsDeep</code> is set to the value
1686
- * passed in as <code>isDeep</code>. These changes are persisted
1687
- * automatically; there is no need to call <code>save</code>.
1688
- * <p>
1689
- * Note that it is possible to lock a node even if it is checked-in (the
1690
- * lock-related properties will be changed despite the checked-in status).
1691
- *
1692
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
1693
- * @param isDeep if <code>true</code> this lock will apply to this node and all its descendants; if <code>false</code>, it applies only to this node.
1694
- * @param isSessionScoped if <code>true</code>, this lock expires with the current session; if <code>false</code> it expires when explicitly or automatically unlocked for some other reason.
1695
- * @return A <code>Lock</code> object containing a lock token.
1696
- * @throws UnsupportedRepositoryOperationException if this implementation does not support locking.
1697
- * @throws LockException if this node is not <code>mix:lockable</code> or this node is already locked or <code>isDeep</code> is <code>true</code> and a descendant node of this node already holds a lock or if this node has not yet been persisted.
1698
- * @throws AccessDeniedException if this session does not have sufficient access capabilities to lock this node.
1699
- * @throws InvalidItemStateException if this node has pending unsaved changes.
1700
- * @throws RepositoryException if another error occurs.
1701
- * @deprecated As of JCR 2.0, {@link LockManager#lock(String, boolean, boolean, long, String)} should be used instead.
1702
- */
1703
- lock(isDeep: boolean, isSessionScoped: boolean): Lock;
1704
-
1705
- /**
1706
- * Returns the <code>Lock</code> object that applies to this node. This may
1707
- * be either a lock on this node itself or a deep lock on a node above this
1708
- * node.
1709
- *
1710
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
1711
- * @return The applicable <code>Lock</code> object.
1712
- * @throws UnsupportedRepositoryOperationException if this implementation does not support locking.
1713
- * @throws LockException if no lock applies to this node.
1714
- * @throws AccessDeniedException if the curent session does not have sufficent access to get the lock.
1715
- * @throws RepositoryException if another error occurs.
1716
- * @deprecated As of JCR 2.0, {@link LockManager#getLock(String)} should be used instead.
1717
- */
1718
- getLock(): Lock;
1719
-
1720
- /**
1721
- * Removes the lock on this node. Also removes the properties
1722
- * <code>jcr:lockOwner</code> and <code>jcr:lockIsDeep</code> from this
1723
- * node. These changes are persisted automatically; there is no need to call
1724
- * <code>save</code>. As well, the corresponding lock token is removed from
1725
- * the set of lock tokens held by the current <code>Session</code>.
1726
- * <p>
1727
- * If this node does not currently hold a lock or holds a lock for which
1728
- * this <code>Session</code> is not the owner, then a
1729
- * <code>LockException</code> is thrown. Note however that the system may
1730
- * give permission to a non-owning session to unlock a lock. Typically such
1731
- * "lock-superuser" capability is intended to facilitate administrational
1732
- * clean-up of orphaned open-scoped locks.
1733
- * <p>
1734
- * Note that it is possible to unlock a node even if it is checked-in (the
1735
- * lock-related properties will be changed despite the checked-in status).
1736
- *
1737
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
1738
- * @throws UnsupportedRepositoryOperationException if this implementation does not support locking.
1739
- * @throws LockException if this node does not currently hold a lock or holds a lock for which this Session does not have the correct lock token
1740
- * @throws AccessDeniedException if the current session does not have sufficent access to unlock this node.
1741
- * @throws InvalidItemStateException if this node has pending unsaved changes.
1742
- * @throws RepositoryException if another error occurs.
1743
- * @deprecated As of JCR 2.0, {@link LockManager#unlock(String)} should be used instead.
1744
- */
1745
- unlock(): void;
1746
-
1747
- /**
1748
- * Returns <code>true</code> if this node holds a lock; otherwise returns
1749
- * <code>false</code>. To <i>hold</i> a lock means that this node has
1750
- * actually had a lock placed on it specifically, as opposed to just having
1751
- * a lock <i>apply</i> to it due to a deep lock held by a node above.
1752
- *
1753
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
1754
- * @return a <code>boolean</code>.
1755
- * @throws RepositoryException if an error occurs.
1756
- * @deprecated As of JCR 2.0, {@link LockManager#holdsLock(String)} should be used instead.
1757
- */
1758
- holdsLock(): boolean;
1759
-
1760
- /**
1761
- * Returns <code>true</code> if this node is locked either as a result of a
1762
- * lock held by this node or by a deep lock on a node above this node;
1763
- * otherwise returns <code>false</code>. This includes the case
1764
- * where a repository does not support locking (in which case all
1765
- * nodes are "unlocked" by default).
1766
- *
1767
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
1768
- * @return a <code>boolean</code>.
1769
- * @throws RepositoryException if an error occurs.
1770
- */
1771
- isLocked(): boolean;
1772
-
1773
- /**
1774
- * Causes the lifecycle state of this node to undergo the specified
1775
- * <code>transition</code>.
1776
- * <p>
1777
- * This method may change the value of the <code>jcr:currentLifecycleState</code>
1778
- * property, in most cases it is expected that the implementation will
1779
- * change the value to that of the passed <code>transition</code> parameter,
1780
- * though this is an implementation-specific issue. If the
1781
- * <code>jcr:currentLifecycleState</code> property is changed the change is
1782
- * persisted immediately, there is no need to call <code>save</code>.
1783
- *
1784
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
1785
- * @param transition a state transition
1786
- * @throws UnsupportedRepositoryOperationException if this implementation does not support lifecycle actions or if this node does not have the <code>mix:lifecycle</code> mixin.
1787
- * @throws InvalidLifecycleTransitionException if the lifecycle transition is not successful.
1788
- * @throws RepositoryException if another error occurs.
320
+ * A constant for the node name <code>jcr:versionLabels</code> declared in
321
+ * {@link NodeType#NT_VERSION_HISTORY nt:versionHistory}.
1789
322
  * @since JCR 2.0
1790
323
  */
1791
- followLifecycleTransition(transition: string): void;
324
+ JCR_VERSION_LABELS: string;
1792
325
 
1793
326
  /**
1794
- * Returns the list of valid state transitions for this node.
1795
- *
1796
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
1797
- * @return a <code>String</code> array.
1798
- * @throws UnsupportedRepositoryOperationException if this implementation does not support lifecycle actions or if this node does not have the <code>mix:lifecycle</code> mixin.
1799
- * @throws RepositoryException if another error occurs.
327
+ * A constant for the node name <code>jcr:frozenNode</code> declared in
328
+ * {@link NodeType#NT_VERSION nt:version}.
1800
329
  * @since JCR 2.0
1801
330
  */
1802
- getAllowedLifecycleTransistions(): string;
331
+ JCR_FROZEN_NODE: string;
1803
332
  };
333
+
334
+ export = Node;