@sitevision/api 1.0.20 → 1.1.0-alpha.1

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 (298) hide show
  1. package/hidden/javax/jcr/Binary/index.d.ts +86 -0
  2. package/hidden/javax/jcr/Credentials/index.d.ts +11 -0
  3. package/hidden/javax/jcr/ImportUUIDBehavior/index.d.ts +11 -0
  4. package/hidden/javax/jcr/Item/index.d.ts +353 -0
  5. package/hidden/javax/jcr/ItemVisitor/index.d.ts +41 -0
  6. package/hidden/javax/jcr/NamespaceRegistry/index.d.ts +100 -0
  7. package/hidden/javax/jcr/Node/index.d.ts +2808 -0
  8. package/hidden/javax/jcr/NodeIterator/index.d.ts +18 -0
  9. package/hidden/javax/jcr/Property/index.d.ts +801 -0
  10. package/hidden/javax/jcr/PropertyIterator/index.d.ts +17 -0
  11. package/hidden/javax/jcr/RangeIterator/index.d.ts +75 -0
  12. package/hidden/javax/jcr/Repository/index.d.ts +318 -0
  13. package/hidden/javax/jcr/RepositoryFactory/index.d.ts +90 -0
  14. package/hidden/javax/jcr/Value/index.d.ts +190 -0
  15. package/hidden/javax/jcr/ValueFactory/index.d.ts +179 -0
  16. package/hidden/javax/jcr/Workspace/index.d.ts +1061 -0
  17. package/hidden/javax/jcr/lock/Lock/index.d.ts +142 -0
  18. package/hidden/javax/jcr/lock/LockManager/index.d.ts +217 -0
  19. package/hidden/javax/jcr/nodetype/ItemDefinition/index.d.ts +219 -0
  20. package/hidden/javax/jcr/nodetype/NodeDefinition/index.d.ts +158 -0
  21. package/hidden/javax/jcr/nodetype/NodeDefinitionTemplate/index.d.ts +74 -0
  22. package/hidden/javax/jcr/nodetype/NodeType/index.d.ts +349 -0
  23. package/hidden/javax/jcr/nodetype/NodeTypeDefinition/index.d.ts +248 -0
  24. package/hidden/javax/jcr/nodetype/NodeTypeIterator/index.d.ts +16 -0
  25. package/hidden/javax/jcr/nodetype/NodeTypeManager/index.d.ts +218 -0
  26. package/hidden/javax/jcr/nodetype/NodeTypeTemplate/index.d.ts +98 -0
  27. package/hidden/javax/jcr/nodetype/PropertyDefinition/index.d.ts +536 -0
  28. package/hidden/javax/jcr/nodetype/PropertyDefinitionTemplate/index.d.ts +97 -0
  29. package/hidden/javax/jcr/observation/Event/index.d.ts +133 -0
  30. package/hidden/javax/jcr/observation/EventIterator/index.d.ts +20 -0
  31. package/hidden/javax/jcr/observation/EventJournal/index.d.ts +22 -0
  32. package/hidden/javax/jcr/observation/EventListener/index.d.ts +23 -0
  33. package/hidden/javax/jcr/observation/EventListenerIterator/index.d.ts +20 -0
  34. package/hidden/javax/jcr/observation/ObservationManager/index.d.ts +227 -0
  35. package/hidden/javax/jcr/query/Query/index.d.ts +201 -0
  36. package/hidden/javax/jcr/query/QueryManager/index.d.ts +73 -0
  37. package/hidden/javax/jcr/query/QueryResult/index.d.ts +51 -0
  38. package/hidden/javax/jcr/query/Row/index.d.ts +159 -0
  39. package/hidden/javax/jcr/query/RowIterator/index.d.ts +20 -0
  40. package/hidden/javax/jcr/query/qom/And/index.d.ts +26 -0
  41. package/hidden/javax/jcr/query/qom/BindVariableValue/index.d.ts +15 -0
  42. package/hidden/javax/jcr/query/qom/ChildNode/index.d.ts +27 -0
  43. package/hidden/javax/jcr/query/qom/ChildNodeJoinCondition/index.d.ts +27 -0
  44. package/hidden/javax/jcr/query/qom/Column/index.d.ts +39 -0
  45. package/hidden/javax/jcr/query/qom/Comparison/index.d.ts +82 -0
  46. package/hidden/javax/jcr/query/qom/Constraint/index.d.ts +13 -0
  47. package/hidden/javax/jcr/query/qom/DescendantNode/index.d.ts +31 -0
  48. package/hidden/javax/jcr/query/qom/DescendantNodeJoinCondition/index.d.ts +29 -0
  49. package/hidden/javax/jcr/query/qom/DynamicOperand/index.d.ts +9 -0
  50. package/hidden/javax/jcr/query/qom/EquiJoinCondition/index.d.ts +41 -0
  51. package/hidden/javax/jcr/query/qom/FullTextSearch/index.d.ts +89 -0
  52. package/hidden/javax/jcr/query/qom/FullTextSearchScore/index.d.ts +24 -0
  53. package/hidden/javax/jcr/query/qom/Join/index.d.ts +36 -0
  54. package/hidden/javax/jcr/query/qom/JoinCondition/index.d.ts +9 -0
  55. package/hidden/javax/jcr/query/qom/Length/index.d.ts +24 -0
  56. package/hidden/javax/jcr/query/qom/Literal/index.d.ts +18 -0
  57. package/hidden/javax/jcr/query/qom/LowerCase/index.d.ts +26 -0
  58. package/hidden/javax/jcr/query/qom/NodeLocalName/index.d.ts +16 -0
  59. package/hidden/javax/jcr/query/qom/NodeName/index.d.ts +16 -0
  60. package/hidden/javax/jcr/query/qom/Not/index.d.ts +20 -0
  61. package/hidden/javax/jcr/query/qom/Operand/index.d.ts +9 -0
  62. package/hidden/javax/jcr/query/qom/Or/index.d.ts +30 -0
  63. package/hidden/javax/jcr/query/qom/Ordering/index.d.ts +53 -0
  64. package/hidden/javax/jcr/query/qom/PropertyExistence/index.d.ts +24 -0
  65. package/hidden/javax/jcr/query/qom/PropertyValue/index.d.ts +25 -0
  66. package/hidden/javax/jcr/query/qom/QueryObjectModel/index.d.ts +64 -0
  67. package/hidden/javax/jcr/query/qom/QueryObjectModelConstants/index.d.ts +9 -0
  68. package/hidden/javax/jcr/query/qom/QueryObjectModelFactory/index.d.ts +638 -0
  69. package/hidden/javax/jcr/query/qom/SameNode/index.d.ts +27 -0
  70. package/hidden/javax/jcr/query/qom/SameNodeJoinCondition/index.d.ts +36 -0
  71. package/hidden/javax/jcr/query/qom/Selector/index.d.ts +35 -0
  72. package/hidden/javax/jcr/query/qom/Source/index.d.ts +9 -0
  73. package/hidden/javax/jcr/query/qom/StaticOperand/index.d.ts +10 -0
  74. package/hidden/javax/jcr/query/qom/UpperCase/index.d.ts +26 -0
  75. package/hidden/javax/jcr/retention/Hold/index.d.ts +34 -0
  76. package/hidden/javax/jcr/retention/RetentionManager/index.d.ts +189 -0
  77. package/hidden/javax/jcr/retention/RetentionPolicy/index.d.ts +21 -0
  78. package/hidden/javax/jcr/security/AccessControlEntry/index.d.ts +24 -0
  79. package/hidden/javax/jcr/security/AccessControlList/index.d.ts +91 -0
  80. package/hidden/javax/jcr/security/AccessControlManager/index.d.ts +297 -0
  81. package/hidden/javax/jcr/security/AccessControlPolicy/index.d.ts +11 -0
  82. package/hidden/javax/jcr/security/AccessControlPolicyIterator/index.d.ts +20 -0
  83. package/hidden/javax/jcr/security/NamedAccessControlPolicy/index.d.ts +22 -0
  84. package/hidden/javax/jcr/security/Privilege/index.d.ts +117 -0
  85. package/hidden/javax/jcr/version/Version/index.d.ts +121 -0
  86. package/hidden/javax/jcr/version/VersionHistory/index.d.ts +307 -0
  87. package/hidden/javax/jcr/version/VersionIterator/index.d.ts +20 -0
  88. package/hidden/javax/jcr/version/VersionManager/index.d.ts +1082 -0
  89. package/hidden/senselogic/sitevision/api/base/Builder/index.d.ts +102 -0
  90. package/hidden/senselogic/sitevision/api/base/Filter/index.d.ts +25 -0
  91. package/hidden/senselogic/sitevision/api/base/FilterSplit/index.d.ts +50 -0
  92. package/hidden/senselogic/sitevision/api/base/Loadable/index.d.ts +15 -0
  93. package/hidden/senselogic/sitevision/api/base/Resolver/index.d.ts +31 -0
  94. package/hidden/senselogic/sitevision/api/base/Wrapper/index.d.ts +24 -0
  95. package/hidden/senselogic/sitevision/api/collaboration/CollaborationGroupWrapper/index.d.ts +417 -0
  96. package/hidden/senselogic/sitevision/api/format/NumericFormatter/index.d.ts +80 -0
  97. package/hidden/senselogic/sitevision/api/format/NumericFormatterBuilder/index.d.ts +100 -0
  98. package/hidden/senselogic/sitevision/api/i18n/Currency/index.d.ts +120 -0
  99. package/hidden/senselogic/sitevision/api/link/CustomLinkProcessor/index.d.ts +45 -0
  100. package/hidden/senselogic/sitevision/api/link/CustomLinkRenderData/index.d.ts +65 -0
  101. package/hidden/senselogic/sitevision/api/mail/Mail/index.d.ts +32 -0
  102. package/hidden/senselogic/sitevision/api/message/MessageTextLinker/index.d.ts +15 -0
  103. package/hidden/senselogic/sitevision/api/metadata/value/LinkValue/index.d.ts +23 -0
  104. package/hidden/senselogic/sitevision/api/metadata/value/RelatedValue/index.d.ts +23 -0
  105. package/hidden/senselogic/sitevision/api/property/VersionedPropertyUtil/index.d.ts +642 -0
  106. package/hidden/senselogic/sitevision/api/render/BuddyIconRenderer/BuddyIconInfo/index.d.ts +51 -0
  107. package/hidden/senselogic/sitevision/api/render/ImageScaler/index.d.ts +58 -0
  108. package/hidden/senselogic/sitevision/api/render/TextModuleRenderer/index.d.ts +301 -0
  109. package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/ArticleUtilConstants/index.d.ts +85 -0
  110. package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/ExceptionSuppressingProxyConstants/index.d.ts +31 -0
  111. package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/IndexingUtilConstants/index.d.ts +31 -0
  112. package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/LinkPageUtilConstants/index.d.ts +67 -0
  113. package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/MathInstanceConstants/index.d.ts +25 -0
  114. package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/MimeTypeUtilConstants/index.d.ts +19 -0
  115. package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/NodeTypeUtilConstants/index.d.ts +1243 -0
  116. package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/OutputUtilConstants/index.d.ts +31 -0
  117. package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/PageUtilConstants/index.d.ts +91 -0
  118. package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/PortletContextUtilConstants/index.d.ts +27 -0
  119. package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/PortletUtilConstants/index.d.ts +19 -0
  120. package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/QueryStringUtilConstants/index.d.ts +19 -0
  121. package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/SearchHitConstants/index.d.ts +25 -0
  122. package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/SearchResultConstants/index.d.ts +37 -0
  123. package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/VersionUtilConstants/index.d.ts +25 -0
  124. package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/index.d.ts +8 -0
  125. package/hidden/senselogic/sitevision/api/render/velocity/VelocityContext/index.d.ts +50 -0
  126. package/hidden/senselogic/sitevision/api/render/velocity/VelocityEvaluator/index.d.ts +89 -0
  127. package/hidden/senselogic/sitevision/api/script/RequesterChainable/index.d.ts +119 -0
  128. package/hidden/senselogic/sitevision/api/script/app/RestAppInvoker/index.d.ts +272 -0
  129. package/hidden/senselogic/sitevision/api/script/factory/TypedArgument/index.d.ts +43 -0
  130. package/hidden/senselogic/sitevision/api/script/proxy/ExceptionSuppressingCollection/index.d.ts +94 -0
  131. package/hidden/senselogic/sitevision/api/script/proxy/ExceptionSuppressingIterator/index.d.ts +117 -0
  132. package/hidden/senselogic/sitevision/api/script/proxy/ExceptionSuppressingProxy/index.d.ts +90 -0
  133. package/hidden/senselogic/sitevision/api/search/SearchFieldUtil/index.d.ts +89 -0
  134. package/hidden/senselogic/sitevision/api/search/SearchHighlighter/index.d.ts +45 -0
  135. package/hidden/senselogic/sitevision/api/search/SearchHit/index.d.ts +1176 -0
  136. package/hidden/senselogic/sitevision/api/search/SearchResult/index.d.ts +414 -0
  137. package/hidden/senselogic/sitevision/api/search/facet/SearchFacetField/index.d.ts +27 -0
  138. package/hidden/senselogic/sitevision/api/search/facet/SearchFacetValue/index.d.ts +61 -0
  139. package/hidden/senselogic/sitevision/api/search/searcher/Searcher/index.d.ts +277 -0
  140. package/hidden/senselogic/sitevision/api/search/searcher/component/Filter/index.d.ts +25 -0
  141. package/hidden/senselogic/sitevision/api/search/searcher/component/Highlight/index.d.ts +29 -0
  142. package/hidden/senselogic/sitevision/api/search/searcher/component/Monitor/index.d.ts +25 -0
  143. package/hidden/senselogic/sitevision/api/search/searcher/component/Parser/index.d.ts +35 -0
  144. package/hidden/senselogic/sitevision/api/search/searcher/component/Sort/index.d.ts +25 -0
  145. package/hidden/senselogic/sitevision/api/search/searcher/component/SpellCheck/index.d.ts +29 -0
  146. package/hidden/senselogic/sitevision/api/search/sort/CustomSort/index.d.ts +82 -0
  147. package/hidden/senselogic/sitevision/api/search/suggestion/SearchSuggestion/index.d.ts +21 -0
  148. package/hidden/senselogic/sitevision/api/security/DirectoryAttributes/index.d.ts +70 -0
  149. package/hidden/senselogic/sitevision/api/security/MessageDigester/index.d.ts +50 -0
  150. package/hidden/senselogic/sitevision/api/security/RoleAssignment/index.d.ts +72 -0
  151. package/hidden/senselogic/sitevision/api/security/RoleMatcher/index.d.ts +29 -0
  152. package/hidden/senselogic/sitevision/api/security/SecretStore/index.d.ts +55 -0
  153. package/hidden/senselogic/sitevision/api/security/UserUtil/index.d.ts +80 -0
  154. package/hidden/senselogic/sitevision/api/security/jaas/filter/AuthenticationFilter/index.d.ts +36 -0
  155. package/hidden/senselogic/sitevision/api/security/jaas/filter/AuthenticationFilterChain/index.d.ts +32 -0
  156. package/hidden/senselogic/sitevision/api/user/UserIdentityWrapper/index.d.ts +599 -0
  157. package/hidden/senselogic/sitevision/api/webresource/LinkTarget/index.d.ts +20 -0
  158. package/hidden/senselogic/sitevision/api/xml/XmlElement/index.d.ts +55 -0
  159. package/hidden/senselogic/sitevision/api/xml/XmlElementHandler/index.d.ts +17 -0
  160. package/package.json +2 -4
  161. package/server/AliasUtil/index.d.ts +25 -0
  162. package/server/AliasUtil/index.js +10 -0
  163. package/server/ArchiveUtil/index.d.ts +65 -11
  164. package/server/ArraysInstance/index.d.ts +1846 -0
  165. package/server/ArticleUtil/index.d.ts +381 -69
  166. package/server/AuthenticationUtil/index.d.ts +106 -0
  167. package/server/BookmarkUtil/index.d.ts +36 -28
  168. package/server/BuddyIconRenderer/index.d.ts +240 -0
  169. package/server/ClientUtil/index.d.ts +18 -4
  170. package/server/CollaborationFactory/index.d.ts +42 -25
  171. package/server/CollaborationGroupFolderUtil/index.d.ts +40 -29
  172. package/server/CollaborationGroupTemplateUtil/index.d.ts +71 -39
  173. package/server/CollaborationGroupUtil/index.d.ts +128 -55
  174. package/server/CollectionsInstance/index.d.ts +738 -0
  175. package/server/ColorUtil/index.d.ts +22 -17
  176. package/server/CompoundAndFilterBuilder/index.d.ts +60 -0
  177. package/server/CompoundComparatorBuilder/index.d.ts +63 -0
  178. package/server/CompoundOrFilterBuilder/index.d.ts +59 -0
  179. package/server/ContentNodeUtil/index.d.ts +76 -0
  180. package/server/CurrencyFactory/index.d.ts +135 -0
  181. package/server/DateUtil/index.d.ts +154 -77
  182. package/server/DecorationUtil/index.d.ts +23 -0
  183. package/server/DeviceUtil/index.d.ts +36 -0
  184. package/server/DirectoryUtil/index.d.ts +107 -47
  185. package/server/DocTypeUtil/index.d.ts +149 -0
  186. package/server/EndecUtil/index.d.ts +537 -91
  187. package/server/ExtendedDismaxParserBuilder/index.d.ts +311 -0
  188. package/server/FileIconRenderer/index.d.ts +346 -0
  189. package/server/FileUtil/index.d.ts +462 -0
  190. package/server/FilterBuilder/index.d.ts +120 -0
  191. package/server/FolderUtil/index.d.ts +161 -0
  192. package/server/FontUtil/index.d.ts +49 -0
  193. package/server/FormatterBuilderFactory/index.d.ts +129 -0
  194. package/server/HighlightBuilder/index.d.ts +194 -0
  195. package/server/IconUtil/index.d.ts +37 -0
  196. package/server/ImageLinkRenderer/index.d.ts +134 -0
  197. package/server/ImageRenderer/index.d.ts +613 -231
  198. package/server/ImageUtil/index.d.ts +430 -0
  199. package/server/IndexUtil/index.d.ts +71 -0
  200. package/server/IndexingUtil/index.d.ts +92 -0
  201. package/server/InstanceCreatorUtil/index.d.ts +661 -0
  202. package/server/InstanceTypeUtil/index.d.ts +202 -0
  203. package/server/JwtUtil/index.d.ts +217 -0
  204. package/server/LandingPageUtil/index.d.ts +67 -50
  205. package/server/LinkPageUtil/index.d.ts +468 -0
  206. package/server/LinkRenderer/index.d.ts +1157 -0
  207. package/server/LinkTargetBuilder/index.d.ts +146 -0
  208. package/server/LinkValueBuilder/index.d.ts +129 -52
  209. package/server/ListWrapper/index.d.ts +172 -0
  210. package/server/LocaleUtil/index.d.ts +695 -61
  211. package/server/LogUtil/index.d.ts +118 -77
  212. package/server/MailBuilder/index.d.ts +238 -0
  213. package/server/MailUtil/index.d.ts +98 -0
  214. package/server/MathInstance/index.d.ts +681 -0
  215. package/server/MessageDigesterFactory/index.d.ts +49 -0
  216. package/server/MetadataDefinitionUtil/index.d.ts +118 -0
  217. package/server/MetadataUtil/index.d.ts +524 -79
  218. package/server/MimeTypeUtil/index.d.ts +316 -0
  219. package/server/MonitorBuilder/index.d.ts +51 -0
  220. package/server/NodeComparatorUtil/index.d.ts +397 -0
  221. package/server/NodeFactoryUtil/index.d.ts +32 -0
  222. package/server/NodeFilterUtil/index.d.ts +924 -0
  223. package/server/NodeIteratorUtil/index.d.ts +322 -72
  224. package/server/NodeResolverUtil/index.d.ts +767 -0
  225. package/server/NodeTreeUtil/index.d.ts +339 -63
  226. package/server/NodeTypeUtil/index.d.ts +391 -197
  227. package/server/OfflineVersionPropertyUtil/index.d.ts +30 -0
  228. package/server/OnlineVersionPropertyUtil/index.d.ts +30 -0
  229. package/server/OutputUtil/index.d.ts +641 -0
  230. package/server/PageUtil/index.d.ts +330 -0
  231. package/server/PermissionUtil/index.d.ts +650 -0
  232. package/server/PortletContextUtil/index.d.ts +118 -37
  233. package/server/PortletContextUtil/index.js +1 -0
  234. package/server/PortletUtil/index.d.ts +40 -0
  235. package/server/PrincipalUtil/index.d.ts +51 -0
  236. package/server/Properties/index.d.ts +185 -38
  237. package/server/PropertyUtil/index.d.ts +2330 -406
  238. package/server/PublishingUtil/index.d.ts +385 -49
  239. package/server/QueryStringUtil/index.d.ts +737 -0
  240. package/server/RedirectUtil/index.d.ts +98 -0
  241. package/server/RelatedValueBuilder/index.d.ts +81 -39
  242. package/server/Requester/index.d.ts +441 -65
  243. package/server/ResourceLocatorUtil/index.d.ts +483 -227
  244. package/server/RestApi/index.d.ts +208 -23
  245. package/server/RestAppInvokerFactory/index.d.ts +73 -0
  246. package/server/RoleAssignmentBuilder/index.d.ts +60 -0
  247. package/server/RoleMatcherBuilder/index.d.ts +59 -0
  248. package/server/RoleUtil/index.d.ts +57 -0
  249. package/server/ScriptUtil/index.d.ts +625 -143
  250. package/server/SearchFactory/index.d.ts +133 -0
  251. package/server/SearchUtil/index.d.ts +164 -0
  252. package/server/SearcherBuilder/index.d.ts +260 -0
  253. package/server/Session/index.d.ts +1758 -0
  254. package/server/SimpleUserUtil/index.d.ts +39 -30
  255. package/server/SiteCookieUtil/index.d.ts +78 -53
  256. package/server/SortBuilder/index.d.ts +111 -0
  257. package/server/SpellCheckBuilder/index.d.ts +68 -0
  258. package/server/StandardParserBuilder/index.d.ts +112 -0
  259. package/server/StructureUtil/index.d.ts +167 -0
  260. package/server/SubscriberUtil/index.d.ts +122 -0
  261. package/server/SubscriptionUtil/index.d.ts +197 -0
  262. package/server/SystemUserUtil/index.d.ts +201 -98
  263. package/server/TagUtil/index.d.ts +193 -0
  264. package/server/TemplateUtil/index.d.ts +217 -0
  265. package/server/TemporaryFileNodeBuilder/index.d.ts +63 -0
  266. package/server/TemporaryNodeBuilder/index.d.ts +241 -0
  267. package/server/TextModuleRendererBuilder/index.d.ts +68 -0
  268. package/server/TimestampUtil/index.d.ts +98 -82
  269. package/server/TranslationUtil/index.d.ts +175 -0
  270. package/server/TrashcanUtil/index.d.ts +193 -24
  271. package/server/UserDataUtil/index.d.ts +167 -85
  272. package/server/UserFactory/index.d.ts +45 -30
  273. package/server/UserFieldRenderer/index.d.ts +258 -0
  274. package/server/UserIdentityUtil/index.d.ts +61 -29
  275. package/server/UserUtil/index.d.ts +69 -28
  276. package/server/Utils/index.d.ts +870 -12
  277. package/server/VelocityRenderer/index.d.ts +248 -0
  278. package/server/VersionUtil/index.d.ts +15 -12
  279. package/server/WebContentUtil/index.d.ts +644 -0
  280. package/server/WebResourceFactory/index.d.ts +66 -0
  281. package/server/XSLTUtil/index.d.ts +49 -10
  282. package/server/XmlParserUtil/index.d.ts +82 -81
  283. package/builtins/Binary/index.d.ts +0 -3
  284. package/builtins/Calendar/index.d.ts +0 -3
  285. package/builtins/Collection/index.d.ts +0 -3
  286. package/builtins/Date/index.d.ts +0 -3
  287. package/builtins/InputStream/index.d.ts +0 -3
  288. package/builtins/Instant/index.d.ts +0 -3
  289. package/builtins/List/index.d.ts +0 -3
  290. package/builtins/LocalDateTime/index.d.ts +0 -3
  291. package/builtins/Locale/index.d.ts +0 -3
  292. package/builtins/Node/index.d.ts +0 -3
  293. package/builtins/NodeIterator/index.d.ts +0 -27
  294. package/builtins/Property/index.d.ts +0 -3
  295. package/builtins/Serializable/index.d.ts +0 -3
  296. package/builtins/Set/index.d.ts +0 -3
  297. package/builtins/Throwable/index.d.ts +0 -3
  298. package/builtins/byte/index.d.ts +0 -3
@@ -0,0 +1,924 @@
1
+ import Filter from "../../hidden/senselogic/sitevision/api/base/Filter";
2
+ import FilterSplit from "../../hidden/senselogic/sitevision/api/base/FilterSplit";
3
+ import CompoundAndFilterBuilder from "../CompoundAndFilterBuilder";
4
+ import CompoundOrFilterBuilder from "../CompoundOrFilterBuilder";
5
+
6
+ /**
7
+ * Applies a node filter to a list and gets the result.
8
+ * @param aNodeList the list of nodes
9
+ * @param aNodeFilter a node filter
10
+ * @return a list of all nodes of <code>aNodeList</code> that is accepted by <code>aNodeFilter</code>, never <code>null</code>. <code>aNodeList</code> itself is returned if it's empty or if <code>aNodeFilter</code> is <code>null</code>
11
+ */
12
+ export function getFilteredList(
13
+ aNodeList: unknown[],
14
+ aNodeFilter: Filter
15
+ ): unknown[];
16
+
17
+ /**
18
+ * Applies a node filter to a Map with Node values and gets the result.
19
+ * @param aNodeValueMap a map with node values
20
+ * @param aNodeFilter a node filter
21
+ * @return a Map with all <code>aNodeValueMap</code> entries with a value that is accepted by <code>aNodeFilter</code>, never <code>null</code>. <code>aNodeValueMap</code> itself is returned if it's empty or if <code>aNodeFilter</code> is <code>null</code>
22
+ * @since Sitevision 4.3.1
23
+ */
24
+ export function getFilteredValueMap(
25
+ aNodeValueMap: Record<unknown, unknown>,
26
+ aNodeFilter: Filter
27
+ ): Record<unknown, unknown>;
28
+
29
+ /**
30
+ * Applies a node filter to a Map with Node keys and gets the result.
31
+ * @param aNodeKeyMap a map with node keys
32
+ * @param aNodeFilter a node filter
33
+ * @return a Map with all <code>aNodeKeyMap</code> entries with a key that is accepted by <code>aNodeFilter</code>, never <code>null</code>. <code>aNodeKeyMap</code> itself is returned if it's empty or if <code>aNodeFilter</code> is <code>null</code>
34
+ * @since Sitevision 4.3.1
35
+ */
36
+ export function getFilteredKeyMap(
37
+ aNodeKeyMap: Record<unknown, unknown>,
38
+ aNodeFilter: Filter
39
+ ): Record<unknown, unknown>;
40
+
41
+ /**
42
+ * Gets the filtering result of a split operation for a collection of nodes with a node filter as divider.
43
+ *
44
+ * <p>
45
+ * This method would typically be used instead of {@link #getFilteredList(java.util.List, senselogic.sitevision.api.base.Filter)}
46
+ * when you are also interested in the nodes that does NOT match the filter.
47
+ * </p>
48
+ *
49
+ * <p>
50
+ * When nodes are available via a <code>NodeIterator</code>, you would typically use the
51
+ * {@link senselogic.sitevision.api.node.NodeIteratorUtil#split(javax.jcr.NodeIterator, senselogic.sitevision.api.base.Filter)}
52
+ * instead!
53
+ * </p>
54
+ * @param aNodeCollection a node collection
55
+ * @param aNodeFilter a node filter
56
+ * @return the result of the filtering operation
57
+ * @since Sitevision 3.6.3
58
+ * @see senselogic.sitevision.api.node.NodeIteratorUtil#split(javax.jcr.NodeIterator, senselogic.sitevision.api.base.Filter)
59
+ */
60
+ export function split(
61
+ aNodeCollection: unknown,
62
+ aNodeFilter: Filter
63
+ ): FilterSplit;
64
+
65
+ /**
66
+ * Gets a builder for creating a compound filter that requires that <em>all</em> of the containing filters matches.
67
+ *
68
+ * <p>
69
+ * The CompoundAndFilterBuilder builds a node filter of multiple filters that are combined using the logical
70
+ * <em>AND</em> operator.
71
+ * </p>
72
+ * @return a CompoundAndFilterBuilder
73
+ */
74
+ export function getCompoundAndFilterBuilder(): CompoundAndFilterBuilder;
75
+
76
+ /**
77
+ * Gets a builder for creating a compound filter that requires that <em>any</em> of the containing filters matches.
78
+ *
79
+ * <p>
80
+ * The CompoundOrFilterBuilder builds a node filter of multiple filters that are combined using the logical
81
+ * <em>OR</em> operator.
82
+ * </p>
83
+ * @return a CompoundOrFilterBuilder
84
+ * @see #getAnyOfPrimaryNodeTypesFilter(Collection)
85
+ */
86
+ export function getCompoundOrFilterBuilder(): CompoundOrFilterBuilder;
87
+
88
+ /**
89
+ * Gets a filter that always matches.
90
+ * @return a filter that matches all nodes.
91
+ */
92
+ export function getAlwaysAcceptFilter(): Filter;
93
+
94
+ /**
95
+ * Gets a filter that never matches.
96
+ * @return a filter that never matches any nodes.
97
+ */
98
+ export function getNeverAcceptFilter(): Filter;
99
+
100
+ /**
101
+ * Gets a filter that matches null nodes.
102
+ * @return a filter that matches null nodes.
103
+ * @since Sitevision 4.3.1
104
+ */
105
+ export function getNullFilter(): Filter;
106
+
107
+ /**
108
+ * Gets a filter that matches non-null nodes.
109
+ * @return a filter that matches non-null nodes.
110
+ * @since Sitevision 4.3.1
111
+ */
112
+ export function getNonNullFilter(): Filter;
113
+
114
+ /**
115
+ * Gets a filter that inverts the result of another filter.
116
+ * @param aFilter the filter to invert
117
+ * @return a filter that inverts the result
118
+ * @throws IllegalArgumentException if <code>aFilter</code> is <code>null</code>
119
+ */
120
+ export function getInvertedFilter(aFilter: Filter): Filter;
121
+
122
+ /**
123
+ * Gets a filter that matches by a specified node identifier.
124
+ * @param aIdentifier the node identifier
125
+ * @return a filter that matches all nodes (typically just one) with node identifier <code>aIdentifier</code>
126
+ * @throws IllegalArgumentException if <code>aIdentifier</code> is <code>null</code> or whitespace only
127
+ * @since Sitevision 4.1
128
+ */
129
+ export function getIdentifierFilter(aIdentifier: string): Filter;
130
+
131
+ /**
132
+ * Gets a filter that matches by a specified node identifier prefix.
133
+ * @param aIdentifierPrefix the node identifier prefix
134
+ * @return a filter that matches all nodes with an identifier that starts with <code>aIdentifierPrefix</code>
135
+ * @throws IllegalArgumentException if <code>aIdentifierPrefix</code> is <code>null</code> or whitespace only
136
+ * @since Sitevision 4.1
137
+ */
138
+ export function getIdentifierPrefixFilter(aIdentifierPrefix: string): Filter;
139
+
140
+ /**
141
+ * Gets a filter that matches by a specified node identifier suffix.
142
+ * @param aIdentifierSuffix the node identifier suffix
143
+ * @return a filter that matches all nodes with an identifier that ends with <code>aIdentifierSuffix</code>
144
+ * @throws IllegalArgumentException if <code>aIdentifierSuffix</code> is <code>null</code> or whitespace only
145
+ * @since Sitevision 4.1
146
+ */
147
+ export function getIdentifierSuffixFilter(aIdentifierSuffix: string): Filter;
148
+
149
+ /**
150
+ * Gets a filter that matches by a specified primary node type.
151
+ * @param aPrimaryNodeTypeName the primary node type name
152
+ * @return a filter that matches all nodes that has primary node type <code>aPrimaryNodeTypeName</code>
153
+ * @throws IllegalArgumentException if <code>aPrimaryNodeTypeName</code> is <code>null</code> or whitespace only
154
+ * @see #getAnyOfPrimaryNodeTypesFilter(Collection)
155
+ * @see #getNoneOfPrimaryNodeTypesFilter(Collection)
156
+ * @see senselogic.sitevision.api.node.NodeTypeUtil
157
+ */
158
+ export function getPrimaryNodeTypeFilter(aPrimaryNodeTypeName: string): Filter;
159
+
160
+ /**
161
+ * Gets a filter that matches all nodes that has a primary node type that is present in given collection.
162
+ *
163
+ * <p>
164
+ * This convenience method is conceptually equivalent - but also more efficient - than building a "match any of" filter via
165
+ * {@link #getCompoundOrFilterBuilder() CompoundOrFilter} with a number of {@link #getPrimaryNodeTypeFilter(String) PrimaryNodeTypeFilters}.
166
+ * </p>
167
+ * @param aPrimaryNodeTypeNames a collection of primary node type names, must not be null. Null and blank collection items will be silently ignored (such value are not a valid node type name)
168
+ * @return a filter that matches all Nodes that has a primary node type that is present in aPrimaryNodeTypeNames.
169
+ * @throws NullPointerException if aPrimaryNodeTypeNames is null
170
+ * @see #getNoneOfPrimaryNodeTypesFilter(Collection)
171
+ * @see senselogic.sitevision.api.node.NodeTypeUtil
172
+ * @since Sitevision 8.1
173
+ */
174
+ export function getAnyOfPrimaryNodeTypesFilter(
175
+ aPrimaryNodeTypeNames: unknown
176
+ ): Filter;
177
+
178
+ /**
179
+ * Gets a filter that matches all nodes that does not have a primary node type present in given collection.
180
+ *
181
+ * <p>
182
+ * This convenience method is conceptually equivalent - but also more efficient - than building a "match none of" filter via
183
+ * {@link #getCompoundOrFilterBuilder() CompoundOrFilter} with a number of {@link #getPrimaryNodeTypeFilter(String) PrimaryNodeTypeFilters}
184
+ * and a {@link #getInvertedFilter(Filter) InvertedFilter}
185
+ * </p>
186
+ * @param aExcludedPrimaryNodeTypeNames a collection of primary node type names, must not be null. Null and blank collection items will be silently ignored (such value are not a valid node type name)
187
+ * @return a filter that matches all Nodes that does not have a primary node type present in aExcludedPrimaryNodeTypeNames.
188
+ * @throws NullPointerException if aExcludedPrimaryNodeTypeNames is null
189
+ * @see #getAnyOfPrimaryNodeTypesFilter(Collection)
190
+ * @see senselogic.sitevision.api.node.NodeTypeUtil
191
+ * @since Sitevision 8.1
192
+ */
193
+ export function getNoneOfPrimaryNodeTypesFilter(
194
+ aExcludedPrimaryNodeTypeNames: unknown
195
+ ): Filter;
196
+
197
+ /**
198
+ * Gets a filter that matches by the existence of a specified property.
199
+ * @param aPropertyName the name of the property
200
+ * @return a filter that matches all nodes that has a property named <code>aPropertyName</code>
201
+ * @throws IllegalArgumentException if <code>aPropertyName</code> is <code>null</code> or whitespace only
202
+ * @see javax.jcr.Node#hasProperty(String)
203
+ */
204
+ export function getHasPropertyFilter(aPropertyName: string): Filter;
205
+
206
+ /**
207
+ * Gets a filter that matches by a specified string property.
208
+ * @param aPropertyName the name of the property
209
+ * @param aMatchValue the value of the property
210
+ * @return a filter that matches all nodes that has a string property named <code>aPropertyName</code> with value <code>aMatchValue</code>
211
+ * @throws IllegalArgumentException if <code>aPropertyName</code> or <code>aMatchValue</code> is <code>null</code>
212
+ * @see senselogic.sitevision.api.property.PropertyUtil#getString(javax.jcr.Node, String)
213
+ */
214
+ export function getStringPropertyFilter(
215
+ aPropertyName: string,
216
+ aMatchValue: string
217
+ ): Filter;
218
+
219
+ /**
220
+ * Gets a filter that matches by a specified multi-valued string property.
221
+ * @param aPropertyName the name of the property
222
+ * @param aMatchValue the value of the property
223
+ * @return a filter that matches all nodes that has a string property named <code>aPropertyName</code> with value <code>aMatchValue</code>
224
+ * @throws IllegalArgumentException if <code>aPropertyName</code> or <code>aMatchValue</code> is <code>null</code>
225
+ * @see senselogic.sitevision.api.property.PropertyUtil#getStrings(javax.jcr.Node, String)
226
+ */
227
+ export function getStringMultiPropertyFilter(
228
+ aPropertyName: string,
229
+ aMatchValue: string
230
+ ): Filter;
231
+
232
+ /**
233
+ * Gets a filter that matches case-insensitive by a specified string property.
234
+ * @param aPropertyName the name of the property
235
+ * @param aCaseInsensitiveValue the case-insensitive value of the property
236
+ * @return a filter that matches all nodes that has a string property named <code>aPropertyName</code> with value <code>aCaseInsensitiveValue</code>
237
+ * @throws IllegalArgumentException if <code>aPropertyName</code> or <code>aCaseInsensitiveValue</code> is <code>null</code>
238
+ */
239
+ export function getIgnoreCaseStringPropertyFilter(
240
+ aPropertyName: string,
241
+ aCaseInsensitiveValue: string
242
+ ): Filter;
243
+
244
+ /**
245
+ * Gets a filter that matches by the value-starts-with of a specified string property.
246
+ *
247
+ * <p>
248
+ * <em>The starts-with check is performed using the <code>String.startsWith(String)</code> method.</em>
249
+ * </p>
250
+ * @param aPropertyName the name of the property
251
+ * @param aStartsWithValue the value the property should start with
252
+ * @return a filter that matches all nodes that has a string property named <code>aPropertyName</code> that starts with value <code>aStartsWithValue</code>
253
+ * @throws IllegalArgumentException if <code>aPropertyName</code> or <code>aStartsWithValue</code> is <code>null</code>
254
+ */
255
+ export function getStartsWithStringPropertyFilter(
256
+ aPropertyName: string,
257
+ aStartsWithValue: string
258
+ ): Filter;
259
+
260
+ /**
261
+ * Gets a filter that matches by the value-ends-with of a specified string property.
262
+ *
263
+ * <p>
264
+ * <em>The ends-with check is performed using the <code>String.endsWith(String)</code> method.</em>
265
+ * </p>
266
+ * @param aPropertyName the name of the property
267
+ * @param aEndsWithValue the value the property should end with
268
+ * @return a filter that matches all nodes that has a string property named <code>aPropertyName</code> that ends with value <code>aEndsWithValue</code>
269
+ * @throws IllegalArgumentException if <code>aPropertyName</code> or <code>aEndsWithValue</code> is <code>null</code>
270
+ */
271
+ export function getEndsWithStringPropertyFilter(
272
+ aPropertyName: string,
273
+ aEndsWithValue: string
274
+ ): Filter;
275
+
276
+ /**
277
+ * Gets a filter that matches by the value-contains of a specified string property.
278
+ *
279
+ * <p>
280
+ * <em>The contains check is performed using the <code>String.contains(String)</code> method.</em>
281
+ * </p>
282
+ * @param aPropertyName the name of the property
283
+ * @param aContainsValue the value the property should contain
284
+ * @return a filter that matches all nodes that has a string property named <code>aPropertyName</code> that contains value <code>aContainsValue</code>
285
+ * @throws IllegalArgumentException if <code>aPropertyName</code> or <code>aContainsValue</code> is <code>null</code>
286
+ */
287
+ export function getContainsStringPropertyFilter(
288
+ aPropertyName: string,
289
+ aContainsValue: string
290
+ ): Filter;
291
+
292
+ /**
293
+ * Gets a filter that matches by the value-contains of a specified multi-valued string property.
294
+ *
295
+ * <p>
296
+ * <em>The contains check is performed using the <code>String.contains(String)</code> method for each extracted property value.</em>
297
+ * </p>
298
+ * @param aPropertyName the name of the property
299
+ * @param aContainsValue the value the property should contain
300
+ * @return a filter that matches all nodes that has a string property named <code>aPropertyName</code> that contains value <code>aContainsValue</code>
301
+ * @throws IllegalArgumentException if <code>aPropertyName</code> or <code>aContainsValue</code> is <code>null</code>
302
+ */
303
+ export function getContainsStringMultiPropertyFilter(
304
+ aPropertyName: string,
305
+ aContainsValue: string
306
+ ): Filter;
307
+
308
+ /**
309
+ * Gets a filter that matches by a regular expression of a specified string property.
310
+ *
311
+ * <p>
312
+ * <em>The regular expression is compiled to a <code>Pattern</code> and the check is performed using the
313
+ * <code>matches()</code> method of the <code>Matcher</code> extracted from the compiled pattern via
314
+ * <code>Pattern.matcher(String)</code>.</em>
315
+ * </p>
316
+ * @param aPropertyName the name of the property
317
+ * @param aRegularExpression the regular expression
318
+ * @return a filter that matches all nodes that has a string property named <code>aPropertyName</code> that matches <code>aRegularExpression</code>
319
+ * @throws IllegalArgumentException if <code>aPropertyName</code> or <code>aRegularExpression</code> is <code>null</code>
320
+ * @throws PatternSyntaxException if the compilation of <code>aRegularExpression</code> fails
321
+ */
322
+ export function getPatternStringPropertyFilter(
323
+ aPropertyName: string,
324
+ aRegularExpression: string
325
+ ): Filter;
326
+
327
+ /**
328
+ * Gets a filter that matches by a regular expression of a specified multi-valued string property.
329
+ *
330
+ * <p>
331
+ * <em>The regular expression is compiled to a <code>Pattern</code> and the check for each extracted property value is performed using the
332
+ * <code>matches()</code> method of the <code>Matcher</code> extracted from the compiled pattern via
333
+ * <code>Pattern.matcher(String)</code>.</em>
334
+ * </p>
335
+ * @param aPropertyName the name of the property
336
+ * @param aRegularExpression the regular expression
337
+ * @return a filter that matches all nodes that has a string property named <code>aPropertyName</code> that matches <code>aRegularExpression</code>
338
+ * @throws IllegalArgumentException if <code>aPropertyName</code> or <code>aRegularExpression</code> is <code>null</code>
339
+ * @throws PatternSyntaxException if the compilation of <code>aRegularExpression</code> fails
340
+ */
341
+ export function getPatternStringMultiPropertyFilter(
342
+ aPropertyName: string,
343
+ aRegularExpression: string
344
+ ): Filter;
345
+
346
+ /**
347
+ * Gets a filter that matches by a specified boolean property.
348
+ * @param aPropertyName the name of the property
349
+ * @param aMatchValue the value of the property
350
+ * @return a filter that matches all nodes that has a boolean property named <code>aPropertyName</code> with value <code>aMatchValue</code>
351
+ * @throws IllegalArgumentException if <code>aPropertyName</code> is <code>null</code> or whitespace only
352
+ * @see senselogic.sitevision.api.property.PropertyUtil#getBoolean(javax.jcr.Node, String)
353
+ */
354
+ export function getBooleanPropertyFilter(
355
+ aPropertyName: string,
356
+ aMatchValue: boolean
357
+ ): Filter;
358
+
359
+ /**
360
+ * Gets a filter that matches by a nested node's specified boolean property.
361
+ * @param aNodePropertyName the name of the property for the Node
362
+ * @param aPropertyName the name of the property for the "inner/nested" Node specified by <code>aNodePropertyName</code>
363
+ * @param aMatchValue the value of the property
364
+ * @return a filter that matches all nodes that has a property named <code>aNodePropertyName</code> that can be resolved as a node, which in turn has a property named <code>aNodePropertyName</code> with value <code>aMatchValue</code>
365
+ * @throws IllegalArgumentException if <code>aNodePropertyName</code> or <code>aPropertyName</code> is <code>null</code> or whitespace only
366
+ * @see senselogic.sitevision.api.property.PropertyUtil#getNestedBoolean(javax.jcr.Node, String, String)
367
+ */
368
+ export function getNestedBooleanPropertyFilter(
369
+ aNodePropertyName: string,
370
+ aPropertyName: string,
371
+ aMatchValue: boolean
372
+ ): Filter;
373
+
374
+ /**
375
+ * Gets a filter that matches by a specified int property.
376
+ * @param aPropertyName the name of the property
377
+ * @param aMatchValue the value of the property
378
+ * @return a filter that matches all nodes that has a int property named <code>aPropertyName</code> with value <code>aMatchValue</code>
379
+ * @throws IllegalArgumentException if <code>aPropertyName</code> is <code>null</code> or whitespace only
380
+ * @see senselogic.sitevision.api.property.PropertyUtil#getInt(javax.jcr.Node, String)
381
+ */
382
+ export function getIntPropertyFilter(
383
+ aPropertyName: string,
384
+ aMatchValue: number
385
+ ): Filter;
386
+
387
+ /**
388
+ * Gets a filter that matches by the min value of a specified int property.
389
+ * @param aPropertyName the name of the property
390
+ * @param aMinValue the min value of the property
391
+ * @return a filter that matches all nodes that has a int property named <code>aPropertyName</code> with value <code>aMinValue</code> or higher
392
+ * @throws IllegalArgumentException if <code>aPropertyName</code> is <code>null</code> or whitespace only
393
+ */
394
+ export function getMinIntPropertyFilter(
395
+ aPropertyName: string,
396
+ aMinValue: number
397
+ ): Filter;
398
+
399
+ /**
400
+ * Gets a filter that matches by the max value of a specified int property.
401
+ * @param aPropertyName the name of the property
402
+ * @param aMaxValue the max value of the property
403
+ * @return a filter that matches all nodes that has a int property named <code>aPropertyName</code> with value <code>aMaxValue</code> or lower
404
+ * @throws IllegalArgumentException if <code>aPropertyName</code> is <code>null</code> or whitespace only
405
+ */
406
+ export function getMaxIntPropertyFilter(
407
+ aPropertyName: string,
408
+ aMaxValue: number
409
+ ): Filter;
410
+
411
+ /**
412
+ * Gets a filter that matches by the range of a specified int property.
413
+ *
414
+ * <p>
415
+ * <em>This is a convenience method that combines the min int filter ({@link #getMinIntPropertyFilter(String, int)})
416
+ * and the max int filter ({@link #getMinIntPropertyFilter(String, int)}) to check a range for an integer.</em>
417
+ * </p>
418
+ * @param aPropertyName the name of the property
419
+ * @param aMinValue the min value of the property
420
+ * @param aMaxValue the max value of the property
421
+ * @return a filter that matches all nodes that has a int property named <code>aPropertyName</code> with value within inclusive range <code>[aMinValue..aMaxValue]</code>
422
+ * @throws IllegalArgumentException if <code>aPropertyName</code> is <code>null</code> or whitespace only, or if <code>aMinValue</code> is greater than <code>aMaxValue</code>
423
+ */
424
+ export function getRangeIntPropertyFilter(
425
+ aPropertyName: string,
426
+ aMinValue: number,
427
+ aMaxValue: number
428
+ ): Filter;
429
+
430
+ /**
431
+ * Gets a filter that matches by a nested node's specified int property.
432
+ * @param aNodePropertyName the name of the property for the Node
433
+ * @param aPropertyName the name of the property for the "inner/nested" Node specified by <code>aNodePropertyName</code>
434
+ * @param aMatchValue the value of the property
435
+ * @return a filter that matches all nodes that has a property named <code>aNodePropertyName</code> that can be resolved as a node, which in turn has a property named <code>aNodePropertyName</code> with value <code>aMatchValue</code>
436
+ * @throws IllegalArgumentException if <code>aNodePropertyName</code> or <code>aPropertyName</code> is <code>null</code> or whitespace only
437
+ * @see senselogic.sitevision.api.property.PropertyUtil#getNestedInt(javax.jcr.Node, String, String)
438
+ */
439
+ export function getNestedIntPropertyFilter(
440
+ aNodePropertyName: string,
441
+ aPropertyName: string,
442
+ aMatchValue: number
443
+ ): Filter;
444
+
445
+ /**
446
+ * Gets a filter that matches by a nested node's min value of a specified int property.
447
+ * @param aNodePropertyName the name of the property for the Node
448
+ * @param aPropertyName the name of the property for the "inner/nested" Node specified by <code>aNodePropertyName</code>
449
+ * @param aMinValue the min value of the property
450
+ * @return a filter that matches all nodes that has a property named <code>aNodePropertyName</code> that can be resolved as a node, which in turn has a property named <code>aNodePropertyName</code> with value <code>aMatchValue</code> or higher
451
+ * @throws IllegalArgumentException if <code>aNodePropertyName</code> or <code>aPropertyName</code> is <code>null</code> or whitespace only
452
+ * @see senselogic.sitevision.api.property.PropertyUtil#getNestedInt(javax.jcr.Node, String, String)
453
+ */
454
+ export function getMinNestedIntPropertyFilter(
455
+ aNodePropertyName: string,
456
+ aPropertyName: string,
457
+ aMinValue: number
458
+ ): Filter;
459
+
460
+ /**
461
+ * Gets a filter that matches by a nested node's max value of a specified int property.
462
+ * @param aNodePropertyName the name of the property for the Node
463
+ * @param aPropertyName the name of the property for the "inner/nested" Node specified by <code>aNodePropertyName</code>
464
+ * @param aMaxValue the max value of the property
465
+ * @return a filter that matches all nodes that has a property named <code>aNodePropertyName</code> that can be resolved as a node, which in turn has a property named <code>aNodePropertyName</code> with value <code>aMatchValue</code> or lower
466
+ * @throws IllegalArgumentException if <code>aNodePropertyName</code> or <code>aPropertyName</code> is <code>null</code> or whitespace only
467
+ * @see senselogic.sitevision.api.property.PropertyUtil#getNestedInt(javax.jcr.Node, String, String)
468
+ */
469
+ export function getMaxNestedIntPropertyFilter(
470
+ aNodePropertyName: string,
471
+ aPropertyName: string,
472
+ aMaxValue: number
473
+ ): Filter;
474
+
475
+ /**
476
+ * Gets a filter that matches by a nested node's range of a specified int property.
477
+ *
478
+ * <p>
479
+ * <em>This is a convenience method that combines the nested min int filter ({@link #getMinNestedIntPropertyFilter(String, String, int)})
480
+ * and the nested max int filter ({@link #getMaxNestedIntPropertyFilter(String, String, int)}) to check a range for an integer.</em>
481
+ * </p>
482
+ * @param aNodePropertyName the name of the property for the Node
483
+ * @param aPropertyName the name of the property for the "inner/nested" Node specified by <code>aNodePropertyName</code>
484
+ * @param aMinValue the min value of the property
485
+ * @param aMaxValue the max value of the property
486
+ * @return a filter that matches all nodes that has a property named <code>aNodePropertyName</code> that can be resolved as a node, which in turn has a property named <code>aNodePropertyName</code> with value within inclusive range <code>[aMinValue..aMaxValue]</code>
487
+ * @throws IllegalArgumentException if <code>aNodePropertyName</code> or <code>aPropertyName</code> is <code>null</code> or whitespace only, or if <code>aMinValue</code> is greater than <code>aMaxValue</code>
488
+ */
489
+ export function getRangeNestedIntPropertyFilter(
490
+ aNodePropertyName: string,
491
+ aPropertyName: string,
492
+ aMinValue: number,
493
+ aMaxValue: number
494
+ ): Filter;
495
+
496
+ /**
497
+ * Gets a filter that matches by a specified double property.
498
+ * @param aPropertyName the name of the property
499
+ * @param aMatchValue the value of the property
500
+ * @return a filter that matches all nodes that has a double property named <code>aPropertyName</code> with value <code>aMatchValue</code>
501
+ * @throws IllegalArgumentException if <code>aPropertyName</code> is <code>null</code> or whitespace only
502
+ * @see senselogic.sitevision.api.property.PropertyUtil#getDouble(javax.jcr.Node, String)
503
+ */
504
+ export function getDoublePropertyFilter(
505
+ aPropertyName: string,
506
+ aMatchValue: number
507
+ ): Filter;
508
+
509
+ /**
510
+ * Gets a filter that matches by a nested node's specified double property.
511
+ * @param aNodePropertyName the name of the property for the Node
512
+ * @param aPropertyName the name of the property for the "inner/nested" Node specified by <code>aNodePropertyName</code>
513
+ * @param aMatchValue the value of the property
514
+ * @return a filter that matches all nodes that has a property named <code>aNodePropertyName</code> that can be resolved as a node, which in turn has a property named <code>aNodePropertyName</code> with value <code>aMatchValue</code>
515
+ * @throws IllegalArgumentException if <code>aNodePropertyName</code> or <code>aPropertyName</code> is <code>null</code> or whitespace only
516
+ * @see senselogic.sitevision.api.property.PropertyUtil#getNestedDouble(javax.jcr.Node, String, String)
517
+ */
518
+ export function getNestedDoublePropertyFilter(
519
+ aNodePropertyName: string,
520
+ aPropertyName: string,
521
+ aMatchValue: number
522
+ ): Filter;
523
+
524
+ /**
525
+ * Gets a filter that matches by the min value of a specified double property.
526
+ * @param aPropertyName the name of the property
527
+ * @param aMinValue the min value of the property
528
+ * @return a filter that matches all nodes that has a double property named <code>aPropertyName</code> with value <code>aMinValue</code> or higher
529
+ * @throws IllegalArgumentException if <code>aPropertyName</code> is <code>null</code> or whitespace only
530
+ */
531
+ export function getMinDoublePropertyFilter(
532
+ aPropertyName: string,
533
+ aMinValue: number
534
+ ): Filter;
535
+
536
+ /**
537
+ * Gets a filter that matches by the max value of a specified double property.
538
+ * @param aPropertyName the name of the property
539
+ * @param aMaxValue the max value of the property
540
+ * @return a filter that matches all nodes that has a double property named <code>aPropertyName</code> with value <code>aMaxValue</code> or lower
541
+ * @throws IllegalArgumentException if <code>aPropertyName</code> is <code>null</code> or whitespace only
542
+ */
543
+ export function getMaxDoublePropertyFilter(
544
+ aPropertyName: string,
545
+ aMaxValue: number
546
+ ): Filter;
547
+
548
+ /**
549
+ * Gets a filter that matches by the range of a specified double property.
550
+ *
551
+ * <p>
552
+ * <em>This is a convenience method that combines the min double filter ({@link #getMinDoublePropertyFilter(String, double)})
553
+ * and the max double filter ({@link #getMaxDoublePropertyFilter(String, double)}) to check a range for a double.</em>
554
+ * </p>
555
+ * @param aPropertyName the name of the property
556
+ * @param aMinValue the min value of the property
557
+ * @param aMaxValue the max value of the property
558
+ * @return a filter that matches all nodes that has a double property named <code>aPropertyName</code> with value within inclusive range <code>[aMinValue..aMaxValue]</code>
559
+ * @throws IllegalArgumentException if <code>aPropertyName</code> is <code>null</code> or whitespace only, or if <code>aMinValue</code> is greater than <code>aMaxValue</code>
560
+ */
561
+ export function getRangeDoublePropertyFilter(
562
+ aPropertyName: string,
563
+ aMinValue: number,
564
+ aMaxValue: number
565
+ ): Filter;
566
+
567
+ /**
568
+ * Gets a filter that matches by a specified Calendar property.
569
+ * @param aPropertyName the name of the property
570
+ * @param aMatchValue the value of the property
571
+ * @return a filter that matches all nodes that has a Calendar property named <code>aPropertyName</code> with value <code>aMatchValue</code>
572
+ * @throws IllegalArgumentException if <code>aPropertyName</code> is <code>null</code> or whitespace only, or <code>aMatchValue</code> is <code>null</code>
573
+ * @see senselogic.sitevision.api.property.PropertyUtil#getCalendar(javax.jcr.Node, String)
574
+ */
575
+ export function getCalendarPropertyFilter(
576
+ aPropertyName: string,
577
+ aMatchValue: unknown
578
+ ): Filter;
579
+
580
+ /**
581
+ * Gets a filter that matches by a nested node's specified Calendar property.
582
+ * @param aNodePropertyName the name of the property for the Node
583
+ * @param aPropertyName the name of the property for the "inner/nested" Node specified by <code>aNodePropertyName</code>
584
+ * @param aMatchValue the value of the property
585
+ * @return a filter that matches all nodes that has a property named <code>aNodePropertyName</code> that can be resolved as a node, which in turn has a property named <code>aNodePropertyName</code> with value <code>aMatchValue</code>
586
+ * @throws IllegalArgumentException if <code>aNodePropertyName</code> or <code>aPropertyName</code> is <code>null</code> or whitespace only, or if <code>aMatchValue</code> is <code>null</code>
587
+ * @see senselogic.sitevision.api.property.PropertyUtil#getNestedCalendar(javax.jcr.Node, String, String)
588
+ */
589
+ export function getNestedCalendarPropertyFilter(
590
+ aNodePropertyName: string,
591
+ aPropertyName: string,
592
+ aMatchValue: unknown
593
+ ): Filter;
594
+
595
+ /**
596
+ * Gets a filter that matches by a before value for a specified Calendar property.
597
+ * @param aPropertyName the name of the property
598
+ * @param aBeforeThresholdValue the before threshold value of the property
599
+ * @return a filter that matches all nodes that has a Calendar property named <code>aPropertyName</code> with value before <code>aBeforeThresholdValue</code>
600
+ * @throws IllegalArgumentException if <code>aPropertyName</code> is <code>null</code> or whitespace only, or <code>aBeforeThresholdValue</code> is <code>null</code>
601
+ */
602
+ export function getBeforeCalendarPropertyFilter(
603
+ aPropertyName: string,
604
+ aBeforeThresholdValue: unknown
605
+ ): Filter;
606
+
607
+ /**
608
+ * Gets a filter that matches by a before value of a nested node's specified Calendar property.
609
+ * @param aNodePropertyName the name of the property for the Node
610
+ * @param aPropertyName the name of the property for the "inner/nested" Node specified by <code>aNodePropertyName</code>
611
+ * @param aBeforeThresholdValue the before threshold value of the property
612
+ * @return a filter that matches all nodes that has a property named <code>aNodePropertyName</code> that can be resolved as a node, which in turn has a property named <code>aNodePropertyName</code> with value before <code>aBeforeThresholdValue</code>
613
+ * @throws IllegalArgumentException if <code>aNodePropertyName</code> or <code>aPropertyName</code> is <code>null</code> or whitespace only, or if <code>aBeforeThresholdValue</code> is <code>null</code>
614
+ */
615
+ export function getBeforeNestedCalendarPropertyFilter(
616
+ aNodePropertyName: string,
617
+ aPropertyName: string,
618
+ aBeforeThresholdValue: unknown
619
+ ): Filter;
620
+
621
+ /**
622
+ * Gets a filter that matches by an after value for a specified Calendar property.
623
+ * @param aPropertyName the name of the property
624
+ * @param aAfterThresholdValue the after threshold value of the property
625
+ * @return a filter that matches all nodes that has a Calendar property named <code>aPropertyName</code> with value after <code>aAfterThresholdValue</code>
626
+ * @throws IllegalArgumentException if <code>aPropertyName</code> is <code>null</code> or whitespace only, or <code>aAfterThresholdValue</code> is <code>null</code>
627
+ */
628
+ export function getAfterCalendarPropertyFilter(
629
+ aPropertyName: string,
630
+ aAfterThresholdValue: unknown
631
+ ): Filter;
632
+
633
+ /**
634
+ * Gets a filter that matches by an after value of a nested node's specified Calendar property.
635
+ * @param aNodePropertyName the name of the property for the Node
636
+ * @param aPropertyName the name of the property for the "inner/nested" Node specified by <code>aNodePropertyName</code>
637
+ * @param aAfterThresholdValue the after threshold value of the property
638
+ * @return a filter that matches all nodes that has a property named <code>aNodePropertyName</code> that can be resolved as a node, which in turn has a property named <code>aNodePropertyName</code> with value after <code>aAfterThresholdValue</code>
639
+ * @throws IllegalArgumentException if <code>aNodePropertyName</code> or <code>aPropertyName</code> is <code>null</code> or whitespace only, or if <code>aAfterThresholdValue</code> is <code>null</code>
640
+ */
641
+ export function getAfterNestedCalendarPropertyFilter(
642
+ aNodePropertyName: string,
643
+ aPropertyName: string,
644
+ aAfterThresholdValue: unknown
645
+ ): Filter;
646
+
647
+ /**
648
+ * Gets a filter that matches by the between range of a specified Calendar property.
649
+ *
650
+ * <p>
651
+ * <em>This is a convenience method that combines the after calendar filter
652
+ * ({@link #getAfterCalendarPropertyFilter(String, java.util.Calendar)})
653
+ * and the before calendar filter ({@link #getBeforeCalendarPropertyFilter(String, java.util.Calendar)}) to check a range for a Calendar.</em>
654
+ * </p>
655
+ * @param aPropertyName the name of the property
656
+ * @param aAfterThresholdValue the after threshold value of the property
657
+ * @param aBeforeThresholdValue the before threshold value of the property
658
+ * @return a filter that matches all nodes that has a Calendar property named <code>aPropertyName</code> with value between exclusive range <code>[aAfterThresholdValue..aBeforeThresholdValue]</code>
659
+ * @throws IllegalArgumentException IllegalArgumentException if <code>aPropertyName</code> is <code>null</code> or whitespace only, or if <code>aAfterThresholdValue</code> or <code>aBeforeThresholdValue</code> is <code>null</code>, or if <code>aAfterThresholdValue</code> is after <code>aBeforeThresholdValue</code>
660
+ */
661
+ export function getRangeCalendarPropertyFilter(
662
+ aPropertyName: string,
663
+ aAfterThresholdValue: unknown,
664
+ aBeforeThresholdValue: unknown
665
+ ): Filter;
666
+
667
+ /**
668
+ * Gets a filter that matches by the between range of a nested node's specified Calendar property.
669
+ *
670
+ * <p>
671
+ * <em>This is a convenience method that combines the nested after calendar filter
672
+ * ({@link #getAfterNestedCalendarPropertyFilter(String, String, java.util.Calendar)}) and the nested before calendar filter
673
+ * ({@link #getBeforeNestedCalendarPropertyFilter(String, String, java.util.Calendar)}) to check a range for a Calendar.</em>
674
+ * </p>
675
+ * @param aNodePropertyName the name of the property for the Node
676
+ * @param aPropertyName the name of the property
677
+ * @param aAfterThresholdValue the after threshold value of the property
678
+ * @param aBeforeThresholdValue the before threshold value of the property
679
+ * @return a filter that matches all nodes that has a property named <code>aNodePropertyName</code> that can be resolved as a node, which in turn has a property named <code>aNodePropertyName</code> with value between exclusive range <code>[aAfterThresholdValue..aBeforeThresholdValue]</code>
680
+ * @throws IllegalArgumentException IllegalArgumentException if <code>aNodePropertyName</code> or <code>aPropertyName</code> is <code>null</code> or whitespace only, or if <code>aAfterThresholdValue</code> or <code>aBeforeThresholdValue</code> is <code>null</code>, or if <code>aAfterThresholdValue</code> is after <code>aBeforeThresholdValue</code>
681
+ */
682
+ export function getRangeNestedCalendarPropertyFilter(
683
+ aNodePropertyName: string,
684
+ aPropertyName: string,
685
+ aAfterThresholdValue: unknown,
686
+ aBeforeThresholdValue: unknown
687
+ ): Filter;
688
+
689
+ /**
690
+ * Node filter utility interface.
691
+ *
692
+ * <p>
693
+ * A node filter is used to <em>match</em> a node against one or more criteria as specified by the filter.
694
+ * </p>
695
+ *
696
+ * <ul>
697
+ * <li>
698
+ * In its simplest form it can replace a <code>null</code> check and an <code>equals</code> check for a certain value
699
+ * of a node (e.g. see {@link #getStringPropertyFilter(String, String)}).
700
+ * </li>
701
+ * <li>
702
+ * In its most complex form it can be a <em>Compound</em> filter that executes multiple checks to deliver the
703
+ * aggregated result of individual filters that are combined together using the logical <em>AND</em> and <em>OR</em>
704
+ * operators in between (e.g. see {@link #getCompoundAndFilterBuilder()}).
705
+ * </li>
706
+ * </ul>
707
+ *
708
+ * <p>
709
+ * A filter can be used "standalone" to simplify your code, but can also be used in utilities with methods that supports node filters.
710
+ * Examples of such utilities are {@link senselogic.sitevision.api.node.NodeIteratorUtil} and {@link senselogic.sitevision.api.node.NodeTreeUtil}.
711
+ * </p>
712
+ *
713
+ * <h3>A Velocity example</h3>
714
+ * <p>
715
+ * This example uses Velocity to demonstrate how to build a filter that matches <em>image</em> nodes that has a <em>width</em> of at least 700
716
+ * or a <em>height</em> of at least 500.
717
+ * </p>
718
+ * <pre><code> #set ($nodeFilterUtil = $sitevisionUtils.NodeFilterUtil)
719
+ * #set ($nodeTypeUtil = $sitevisionUtils.NodeTypeUtil)
720
+ *
721
+ * <em>## Set up individual filters needed</em>
722
+ * #set ($imageFilter = $nodeFilterUtil.getPrimaryNodeTypeFilter($nodeTypeUtil.IMAGE_TYPE))
723
+ * #set ($minWidthFilter = $nodeFilterUtil.getMinIntPropertyFilter('width', 700))
724
+ * #set ($minHeightFilter = $nodeFilterUtil.getMinIntPropertyFilter('height', 500))
725
+ *
726
+ * <em>## The width and the height filters should be logically combined with the OR operator</em>
727
+ * #set ($sizeFilterBuilder = $nodeFilterUtil.CompoundOrFilterBuilder)
728
+ * #set ($sizeFilter = $sizeFilterBuilder.addFilter($minWidthFilter).addFilter($minHeightFilter).build())
729
+ *
730
+ * <em>## The type and the size filters should be logically combined with the AND operator</em>
731
+ * #set ($sizedImageFilterBuilder = $nodeFilterUtil.CompoundAndFilterBuilder)
732
+ * #set ($sizedImageFilter = $sizedImageFilterBuilder.addFilter($imageFilter).addFilter($sizeFilter).build())</code></pre>
733
+ * <p>
734
+ * Now the <em>$sizedImageFilter</em> can be used to match individual nodes, for example:
735
+ * </p>
736
+ * <pre><code> #if ($sizedImageFilter.accept($myNode))
737
+ * <em>## Handle matching image</em>
738
+ * ...
739
+ * #end</code></pre>
740
+ * <p>
741
+ * The <em>$sizedImageFilter</em> can also be used to match multiple nodes via a filter-supporting utility.
742
+ * {@link senselogic.sitevision.api.node.NodeIteratorUtil} is an example of such utility.
743
+ * It provides support to find the <em>first</em>, <em>all</em> or a <em>given number</em> of matches of the nodes provided by
744
+ * a <code>NodeIterator</code>, for example:
745
+ * </p>
746
+ * <pre><code> #set ($nodeIteratorUtil = $sitevisionUtils.NodeIteratorUtil)
747
+ * #set ($matches = $nodeIteratorUtil.findNodes($aNodeIterator, $sizedImageFilter, 5)) <em>## Max 5 matches</em>
748
+ * #if (!$matches.isEmpty())
749
+ * <em>## Handle matching images</em>
750
+ * ...
751
+ * #end</code></pre>
752
+ * <p>
753
+ * <strong>Tip!</strong> See {@link senselogic.sitevision.api.base.Builder} for how to work with builders.
754
+ * </p>
755
+ *
756
+ * <p>
757
+ * <strong>Beware of nulls!</strong> Invoking the {@link Filter#accept(Object) accept} method on a node filter with
758
+ * <code>null</code> should always be avoided! Filters returned from this class are forgiving and will typically handle <code>null</code>
759
+ * but the result might be unexpected, depending on what the filter is actually used for.
760
+ * For instance: Invoking a {@link #getHasPropertyFilter(String) HasPropertyfilter} with <code>null</code> will return
761
+ * <code>false</code> <em>(i.e. "null is not accepted")</em>. But consequently will the same filter wrapped in a
762
+ * {@link #getInvertedFilter(Filter) InvertedFilter} return <code>true</code> <em>(i.e. "null is accepted")</em>.
763
+ * </p>
764
+ *
765
+ * <p>
766
+ * <em>
767
+ * <strong>Disclaimer!</strong> The Property-based filters for the Java native <code>int</code> type (i.e. <code>get*IntPropertyValue</code>)
768
+ * is <strong>not</strong> guaranteed to always deliver proper result for the native's "edge" values.
769
+ * Such filter invoked with <code>Integer.MIN_VALUE</code> or <code>Integer.MAX_VALUE</code> can under very rare circumstances
770
+ * return false when it actually should have returned true. This is a performance consideration and should under normal circumstances
771
+ * never cause any trouble (the value of a int property for a Node is extremely seldom, if ever, an "edge" value).
772
+ * </em>
773
+ * </p>
774
+ *
775
+ * <p>
776
+ * An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getNodeFilterUtil()}.
777
+ * See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
778
+ * </p>Applies a node filter to a list and gets the result.Applies a node filter to a Map with Node values and gets the result.Applies a node filter to a Map with Node keys and gets the result.Gets the filtering result of a split operation for a collection of nodes with a node filter as divider.
779
+ *
780
+ * <p>
781
+ * This method would typically be used instead of {@link #getFilteredList(java.util.List, senselogic.sitevision.api.base.Filter)}
782
+ * when you are also interested in the nodes that does NOT match the filter.
783
+ * </p>
784
+ *
785
+ * <p>
786
+ * When nodes are available via a <code>NodeIterator</code>, you would typically use the
787
+ * {@link senselogic.sitevision.api.node.NodeIteratorUtil#split(javax.jcr.NodeIterator, senselogic.sitevision.api.base.Filter)}
788
+ * instead!
789
+ * </p>Gets a builder for creating a compound filter that requires that <em>all</em> of the containing filters matches.
790
+ *
791
+ * <p>
792
+ * The CompoundAndFilterBuilder builds a node filter of multiple filters that are combined using the logical
793
+ * <em>AND</em> operator.
794
+ * </p>Gets a builder for creating a compound filter that requires that <em>any</em> of the containing filters matches.
795
+ *
796
+ * <p>
797
+ * The CompoundOrFilterBuilder builds a node filter of multiple filters that are combined using the logical
798
+ * <em>OR</em> operator.
799
+ * </p>Gets a filter that always matches.Gets a filter that never matches.Gets a filter that matches null nodes.Gets a filter that matches non-null nodes.Gets a filter that inverts the result of another filter.Gets a filter that matches by a specified node identifier.Gets a filter that matches by a specified node identifier prefix.Gets a filter that matches by a specified node identifier suffix.Gets a filter that matches by a specified primary node type.Gets a filter that matches all nodes that has a primary node type that is present in given collection.
800
+ *
801
+ * <p>
802
+ * This convenience method is conceptually equivalent - but also more efficient - than building a "match any of" filter via
803
+ * {@link #getCompoundOrFilterBuilder() CompoundOrFilter} with a number of {@link #getPrimaryNodeTypeFilter(String) PrimaryNodeTypeFilters}.
804
+ * </p>Gets a filter that matches all nodes that does not have a primary node type present in given collection.
805
+ *
806
+ * <p>
807
+ * This convenience method is conceptually equivalent - but also more efficient - than building a "match none of" filter via
808
+ * {@link #getCompoundOrFilterBuilder() CompoundOrFilter} with a number of {@link #getPrimaryNodeTypeFilter(String) PrimaryNodeTypeFilters}
809
+ * and a {@link #getInvertedFilter(Filter) InvertedFilter}
810
+ * </p>Gets a filter that matches by the existence of a specified property.Gets a filter that matches by a specified string property.Gets a filter that matches by a specified multi-valued string property.Gets a filter that matches case-insensitive by a specified string property.Gets a filter that matches by the value-starts-with of a specified string property.
811
+ *
812
+ * <p>
813
+ * <em>The starts-with check is performed using the <code>String.startsWith(String)</code> method.</em>
814
+ * </p>Gets a filter that matches by the value-ends-with of a specified string property.
815
+ *
816
+ * <p>
817
+ * <em>The ends-with check is performed using the <code>String.endsWith(String)</code> method.</em>
818
+ * </p>Gets a filter that matches by the value-contains of a specified string property.
819
+ *
820
+ * <p>
821
+ * <em>The contains check is performed using the <code>String.contains(String)</code> method.</em>
822
+ * </p>Gets a filter that matches by the value-contains of a specified multi-valued string property.
823
+ *
824
+ * <p>
825
+ * <em>The contains check is performed using the <code>String.contains(String)</code> method for each extracted property value.</em>
826
+ * </p>Gets a filter that matches by a regular expression of a specified string property.
827
+ *
828
+ * <p>
829
+ * <em>The regular expression is compiled to a <code>Pattern</code> and the check is performed using the
830
+ * <code>matches()</code> method of the <code>Matcher</code> extracted from the compiled pattern via
831
+ * <code>Pattern.matcher(String)</code>.</em>
832
+ * </p>Gets a filter that matches by a regular expression of a specified multi-valued string property.
833
+ *
834
+ * <p>
835
+ * <em>The regular expression is compiled to a <code>Pattern</code> and the check for each extracted property value is performed using the
836
+ * <code>matches()</code> method of the <code>Matcher</code> extracted from the compiled pattern via
837
+ * <code>Pattern.matcher(String)</code>.</em>
838
+ * </p>Gets a filter that matches by a specified boolean property.Gets a filter that matches by a nested node's specified boolean property.Gets a filter that matches by a specified int property.Gets a filter that matches by the min value of a specified int property.Gets a filter that matches by the max value of a specified int property.Gets a filter that matches by the range of a specified int property.
839
+ *
840
+ * <p>
841
+ * <em>This is a convenience method that combines the min int filter ({@link #getMinIntPropertyFilter(String, int)})
842
+ * and the max int filter ({@link #getMinIntPropertyFilter(String, int)}) to check a range for an integer.</em>
843
+ * </p>Gets a filter that matches by a nested node's specified int property.Gets a filter that matches by a nested node's min value of a specified int property.Gets a filter that matches by a nested node's max value of a specified int property.Gets a filter that matches by a nested node's range of a specified int property.
844
+ *
845
+ * <p>
846
+ * <em>This is a convenience method that combines the nested min int filter ({@link #getMinNestedIntPropertyFilter(String, String, int)})
847
+ * and the nested max int filter ({@link #getMaxNestedIntPropertyFilter(String, String, int)}) to check a range for an integer.</em>
848
+ * </p>Gets a filter that matches by a specified double property.Gets a filter that matches by a nested node's specified double property.Gets a filter that matches by the min value of a specified double property.Gets a filter that matches by the max value of a specified double property.Gets a filter that matches by the range of a specified double property.
849
+ *
850
+ * <p>
851
+ * <em>This is a convenience method that combines the min double filter ({@link #getMinDoublePropertyFilter(String, double)})
852
+ * and the max double filter ({@link #getMaxDoublePropertyFilter(String, double)}) to check a range for a double.</em>
853
+ * </p>Gets a filter that matches by a specified Calendar property.Gets a filter that matches by a nested node's specified Calendar property.Gets a filter that matches by a before value for a specified Calendar property.Gets a filter that matches by a before value of a nested node's specified Calendar property.Gets a filter that matches by an after value for a specified Calendar property.Gets a filter that matches by an after value of a nested node's specified Calendar property.Gets a filter that matches by the between range of a specified Calendar property.
854
+ *
855
+ * <p>
856
+ * <em>This is a convenience method that combines the after calendar filter
857
+ * ({@link #getAfterCalendarPropertyFilter(String, java.util.Calendar)})
858
+ * and the before calendar filter ({@link #getBeforeCalendarPropertyFilter(String, java.util.Calendar)}) to check a range for a Calendar.</em>
859
+ * </p>Gets a filter that matches by the between range of a nested node's specified Calendar property.
860
+ *
861
+ * <p>
862
+ * <em>This is a convenience method that combines the nested after calendar filter
863
+ * ({@link #getAfterNestedCalendarPropertyFilter(String, String, java.util.Calendar)}) and the nested before calendar filter
864
+ * ({@link #getBeforeNestedCalendarPropertyFilter(String, String, java.util.Calendar)}) to check a range for a Calendar.</em>
865
+ * </p>
866
+ * @author Magnus Lövgren
867
+ * @since Sitevision 3.6.2
868
+ */
869
+ declare namespace NodeFilterUtil {
870
+ export {
871
+ getFilteredList,
872
+ getFilteredValueMap,
873
+ getFilteredKeyMap,
874
+ split,
875
+ getCompoundAndFilterBuilder,
876
+ getCompoundOrFilterBuilder,
877
+ getAlwaysAcceptFilter,
878
+ getNeverAcceptFilter,
879
+ getNullFilter,
880
+ getNonNullFilter,
881
+ getInvertedFilter,
882
+ getIdentifierFilter,
883
+ getIdentifierPrefixFilter,
884
+ getIdentifierSuffixFilter,
885
+ getPrimaryNodeTypeFilter,
886
+ getAnyOfPrimaryNodeTypesFilter,
887
+ getNoneOfPrimaryNodeTypesFilter,
888
+ getHasPropertyFilter,
889
+ getStringPropertyFilter,
890
+ getStringMultiPropertyFilter,
891
+ getIgnoreCaseStringPropertyFilter,
892
+ getStartsWithStringPropertyFilter,
893
+ getEndsWithStringPropertyFilter,
894
+ getContainsStringPropertyFilter,
895
+ getContainsStringMultiPropertyFilter,
896
+ getPatternStringPropertyFilter,
897
+ getPatternStringMultiPropertyFilter,
898
+ getBooleanPropertyFilter,
899
+ getNestedBooleanPropertyFilter,
900
+ getIntPropertyFilter,
901
+ getMinIntPropertyFilter,
902
+ getMaxIntPropertyFilter,
903
+ getRangeIntPropertyFilter,
904
+ getNestedIntPropertyFilter,
905
+ getMinNestedIntPropertyFilter,
906
+ getMaxNestedIntPropertyFilter,
907
+ getRangeNestedIntPropertyFilter,
908
+ getDoublePropertyFilter,
909
+ getNestedDoublePropertyFilter,
910
+ getMinDoublePropertyFilter,
911
+ getMaxDoublePropertyFilter,
912
+ getRangeDoublePropertyFilter,
913
+ getCalendarPropertyFilter,
914
+ getNestedCalendarPropertyFilter,
915
+ getBeforeCalendarPropertyFilter,
916
+ getBeforeNestedCalendarPropertyFilter,
917
+ getAfterCalendarPropertyFilter,
918
+ getAfterNestedCalendarPropertyFilter,
919
+ getRangeCalendarPropertyFilter,
920
+ getRangeNestedCalendarPropertyFilter,
921
+ };
922
+ }
923
+
924
+ export default NodeFilterUtil;