| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <meta name="viewport" content="width=device-width,initial-scale=1"> |
| <title>Annotations :: causeway</title> |
| <link rel="canonical" href="https://causeway.apache.org/refguide/latest/applib-ant/about.html"> |
| <meta name="generator" content="Antora 3.1.14"> |
| <link rel="stylesheet" href="../../../_/css/site.css"> |
| <link rel="stylesheet" href="../../../_/css/site-custom.css"> |
| <link rel="home" href="https://causeway.apache.org" title="causeway"> |
| </head> |
| <body class="article"> |
| <header class="header"> |
| <nav class="navbar"> |
| <div class="navbar-brand"> |
| <a class="navbar-item" href="https://causeway.apache.org"> |
| <span class="icon"> |
| <img src="../../../_/img/causeway-logo-no-words-65x48.png"></img> |
| </span> |
| <span class="navbar-title">causeway</span> |
| </a> |
| <button class="navbar-burger" data-target="topbar-nav"> |
| <span></span> |
| <span></span> |
| <span></span> |
| </button> |
| </div> |
| <div id="topbar-nav" class="navbar-menu"> |
| <a class="navbar-end"> |
| <div class="navbar-item has-dropdown is-hoverable"> |
| <a class="navbar-link" href="#">Quick Start</a> |
| <div class="navbar-dropdown"> |
| <span class="navbar-item navbar-heading">Starter Apps</span> |
| <a class="navbar-item" href="../../../docs/latest/starters/helloworld.html">Hello World</a> |
| <a class="navbar-item" href="../../../docs/latest/starters/simpleapp.html">Simple App</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Learning & Tutorials</span> |
| <a class="navbar-item" href="../../../docs/latest/reference/about.html">Reference App</a> |
| <a class="navbar-item" href="https://danhaywood.gitlab.io/isis-petclinic-tutorial-docs/petclinic/1.16.2/intro.html">Petclinic</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Resources</span> |
| <a class="navbar-item" href="../../../docs/latest/resources/cheatsheet.html">Cheatsheet</a> |
| <a class="navbar-item" href="../../../docs/latest/resources/icons.html">Icons</a> |
| </div> |
| </div> |
| <div class="navbar-item has-dropdown is-hoverable"> |
| <a class="navbar-link" href="#">Guides</a> |
| <div class="navbar-dropdown"> |
| <span class="navbar-item navbar-heading">Core</span> |
| <a class="navbar-item" href="../../../userguide/latest/about.html">User Guide</a> |
| <a class="navbar-item" href="../../../refguide/latest/about.html">Reference Guide</a> |
| <a class="navbar-item" href="../../../testing/latest/about.html">Testing Guide</a> |
| <a class="navbar-item" href="../../../security/latest/about.html">Security Guide</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">For use in apps</span> |
| <a class="navbar-item" href="../../../valuetypes/latest/about.html">Value Types</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Development</span> |
| <a class="navbar-item" href="../../../setupguide/latest/about.html">Setup Guide</a> |
| <a class="navbar-item" href="../../../conguide/latest/about.html">Contributors' Guide</a> |
| </div> |
| </div> |
| <div class="navbar-item has-dropdown is-hoverable"> |
| <a class="navbar-link" href="#">Components</a> |
| <div class="navbar-dropdown"> |
| <span class="navbar-item navbar-heading">Security</span> |
| <a class="navbar-item" href="../../../security/latest/bypass/about.html">Bypass</a> |
| <a class="navbar-item" href="../../../security/latest/simple/about.html">Simple</a> |
| <a class="navbar-item" href="../../../security/latest/spring/about.html">Spring</a> |
| <a class="navbar-item" href="../../../security/latest/keycloak/about.html">Keycloak</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Viewers</span> |
| <a class="navbar-item" href="../../../vw/latest/about.html">Web UI (Wicket)</a> |
| <a class="navbar-item" href="../../../gqlv/latest/about.html">GraphQL API</a> |
| <a class="navbar-item" href="../../../vro/latest/about.html">REST API (Restful Objects)</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Persistence</span> |
| <a class="navbar-item" href="../../../pjpa/latest/about.html">JPA (EclipseLink)</a> |
| </div> |
| </div> |
| <div class="navbar-item has-dropdown is-hoverable"> |
| <a class="navbar-link" href="#">Extensions</a> |
| <div class="navbar-dropdown"> |
| <span class="navbar-item navbar-heading">Core</span> |
| <a class="navbar-item" href="../../../userguide/latest/commandlog/about.html">Command Log</a> |
| <a class="navbar-item" href="../../../userguide/latest/docgen/about.html">Doc Gen</a> |
| <a class="navbar-item" href="../../../userguide/latest/executionlog/about.html">Execution Log</a> |
| <a class="navbar-item" href="../../../userguide/latest/executionoutbox/about.html">Execution Outbox</a> |
| <a class="navbar-item" href="../../../userguide/latest/executionrepublisher/about.html">Execution Republisher</a> |
| <a class="navbar-item" href="../../../userguide/latest/excel/about.html">Excel</a> |
| <a class="navbar-item" href="../../../userguide/latest/flyway/about.html">Flyway</a> |
| <a class="navbar-item" href="../../../userguide/latest/layoutloaders/about.html">Layout Loaders</a> |
| <a class="navbar-item" href="../../../userguide/latest/titlecache/about.html">Title Cache</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Security</span> |
| <a class="navbar-item" href="../../../security/latest/secman/about.html">Secman</a> |
| <a class="navbar-item" href="../../../security/latest/audittrail/about.html">Audit Trail</a> |
| <a class="navbar-item" href="../../../security/latest/spring-oauth2/about.html">Spring OAuth2 Integration</a> |
| <a class="navbar-item" href="../../../security/latest/sessionlog/about.html">Session Log</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Web UI (Wicket)</span> |
| <a class="navbar-item" href="../../../vw/latest/fullcalendar/about.html">Full Calendar</a> |
| <a class="navbar-item" href="../../../vw/latest/pdfjs/about.html">pdf.js</a> |
| <a class="navbar-item" href="../../../vw/latest/sse/about.html">Server Side Events</a> |
| <a class="navbar-item" href="../../../vw/latest/tabular/about.html">Tabular Download</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">REST API (Restful Objects)</span> |
| <a class="navbar-item" href="../../../vro/latest/cors/about.html">CORS</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Persistence</span> |
| <a class="navbar-item" href="../../../querydsl/latest/about.html">QueryDSL</a> |
| </div> |
| </div> |
| <div class="navbar-item has-dropdown is-hoverable"> |
| <a class="navbar-link" href="#">Support</a> |
| <div class="navbar-dropdown"> |
| <span class="navbar-item navbar-heading">Contact</span> |
| <a class="navbar-item" href="../../../docs/latest/support/slack-channel.html">Slack</a> |
| <a class="navbar-item" href="../../../docs/latest/support/mailing-list.html">Mailing Lists</a> |
| <a class="navbar-item" href="https://issues.apache.org/jira/browse/CAUSEWAY">JIRA</a> |
| <a class="navbar-item" href="https://stackoverflow.com/questions/tagged/causeway">Stack Overflow</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Releases</span> |
| <a class="navbar-item" href="../../../docs/latest/downloads/how-to.html">Downloads</a> |
| <a class="navbar-item" href="../../../relnotes/latest/about.html">Release Notes</a> |
| <hr class="navbar-divider"/> |
| </div> |
| </div> |
| <div class="navbar-item has-dropdown is-hoverable"> |
| <a class="navbar-link" href="#">Framework</a> |
| <div class="navbar-dropdown"> |
| <span class="navbar-item navbar-heading">Process</span> |
| <a class="navbar-item" href="../../../comguide/latest/about.html">Committers' Guide</a> |
| <a class="navbar-item" href="../../../tooling/latest/about.html">Tooling</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Automated Analysis</span> |
| <a class="navbar-item" href="https://sonarcloud.io/dashboard?id=apache_causeway">SonarCloud.io</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Interim Builds</span> |
| <a class="navbar-item" href="../../../comguide/latest/nightly-builds.html">Nightly builds</a> |
| <a class="navbar-item" href="../../../comguide/latest/weekly-builds.html">Weekly builds</a> |
| <a class="navbar-item" href="https://apache-causeway-committers.github.io/causeway-nightly">Website Preview (not ASF hosted)</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Development</span> |
| <a class="navbar-item" href="../../../core/latest/about.html">Internal Design Docs</a> |
| <a class="navbar-item" href="../../../regressiontests/latest/about.html">Regression Tests</a> |
| <a class="navbar-item" href="../../../incubator/latest/about.html">Incubator</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Thanks</span> |
| <a class="navbar-item" href="../../../more-thanks/latest/more-thanks.html">Acknowledgements</a> |
| </div> |
| </div> |
| <div class="navbar-item has-dropdown is-hoverable"> |
| <a class="navbar-link" href="#">ASF</a> |
| <div class="navbar-dropdown"> |
| <a class="navbar-item" href="http://www.apache.org/">Apache Homepage</a> |
| <a class="navbar-item" href="https://www.apache.org/events/current-event">Events</a> |
| <a class="navbar-item" href="https://www.apache.org/licenses/">License</a> |
| <a class="navbar-item" href="https://www.apache.org/security/">Security</a> |
| <a class="navbar-item" href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy</a> |
| <a class="navbar-item" href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a> |
| <a class="navbar-item" href="https://www.apache.org/foundation/thanks.html">Thanks</a> |
| <hr class="navbar-divider"/> |
| <a class="navbar-item" href="https://whimsy.apache.org/board/minutes/Causeway.html">PMC board minutes</a> |
| </div> |
| </div> |
| <a class="navbar-item" href="../../../docs/latest/about.html"> |
| <span class="icon"> |
| <img src="../../../_/img/home.png"></img> |
| </span> |
| </a> |
| </div> |
| </div> |
| </nav> |
| </header> |
| <div class="body "> |
| <div class="nav-container" data-component="refguide" data-version="3.2.0"> |
| <aside class="nav"> |
| <div class="panels"> |
| <div class="nav-panel-search hide-for-print"> |
| <input id="algolia-search-input" placeholder="Search"></span> |
| </div> |
| <div class="nav-panel-pagination"> |
| <a class="page-previous disabled" rel="prev" href="" title=""><span></span></a> |
| <a class="page-next disabled" rel="next" |
| href="" title=""><span></span></a> |
| <!-- |
| page.parent doesn't seem to be set... |
| <a class="page-parent disabled" rel="prev" href="" title=""><span></span></a> |
| --> |
| </div> |
| <div class="nav-panel-menu is-active" data-panel="menu"> |
| <nav class="nav-menu"> |
| <h3 class="title"><a href="../about.html">Reference Guide</a></h3> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="0"> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../latest/applib-svc/about.html">Domain Services</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/acceptheader/AcceptHeaderService.html">AcceptHeaderService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/appfeatui/ApplicationFeatureMenu.html">ApplicationFeatureMenu</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/appfeat/ApplicationFeatureRepository.html">ApplicationFeatureRepository</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/bookmark/BookmarkService.html">BookmarkService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/bookmarkui/BookmarkUiService.html">BookmarkUiService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/clock/ClockService.html">ClockService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/commanddto/processor/spi/CommandDtoProcessorService.html">CommandDtoProcessorService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/command/CommandExecutorService.html">CommandExecutorService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../latest/applib/index/services/publishing/spi/CommandSubscriber.html">CommandSubscriber</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../latest/applib/index/services/publishing/log/CommandLogger.html">CommandLogger</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/confview/ConfigurationMenu.html">ConfigurationMenu</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/confview/ConfigurationViewService.html">ConfigurationViewService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../latest/applib/index/services/conmap/ContentMappingService.html">ContentMappingService</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../latest/applib/index/services/commanddto/conmap/ContentMappingServiceForCommandDto.html">ContentMappingServiceForCommandDto</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../latest/applib/index/services/commanddto/conmap/ContentMappingServiceForCommandsDto.html">ContentMappingServiceForCommandsDto</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/linking/DeepLinkService.html">DeepLinkService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/userreg/EmailNotificationService.html">EmailNotificationService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/email/EmailService.html">EmailService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../latest/applib/index/services/publishing/spi/EntityChangesSubscriber.html">EntityChangesSubscriber</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../latest/applib/index/services/publishing/log/EntityChangesLogger.html">EntityChangesLogger</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../latest/applib/index/services/publishing/spi/EntityPropertyChangeSubscriber.html">EntityPropertyChangeSubscriber</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../latest/applib/index/services/publishing/log/EntityPropertyChangeLogger.html">EntityPropertyChangeLogger</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../latest/applib/index/services/publishing/spi/ExecutionSubscriber.html">ExecutionSubscriber</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../latest/applib/index/services/publishing/log/ExecutionLogger.html">ExecutionLogger</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/error/ErrorReportingService.html">ErrorReportingService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/eventbus/EventBusService.html">EventBusService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/exceprecog/ExceptionRecognizerService.html">ExceptionRecognizerService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/factory/FactoryService.html">FactoryService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="#refguide:applib:index/services/grid/GridLoaderService.adoc">GridLoaderService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/grid/GridService.html">GridService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="#refguide:applib:index/services/grid/GridSystemService.adoc">GridSystemService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/health/HealthCheckService.html">HealthCheckService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/hint/HintIdProvider.html">HintIdProvider</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/hint/HintStore.html">HintStore</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/homepage/HomePageResolverService.html">HomePageResolverService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/bookmark/IdStringifier.html">IdStringifier</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/user/ImpersonateMenu.html">ImpersonateMenu</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/user/ImpersonateMenuAdvisor.html">ImpersonateMenuAdvisor</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/iactn/InteractionProvider.html">InteractionProvider</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="#refguide:applib:index/services/iactnlayer/InteractionLayerTracker.adoc">InteractionLayerTracker</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="#refguide:applib:index/services/iactnlayer/InteractionService.adoc">InteractionService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/jaxb/JaxbService.html">JaxbService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/layout/LayoutService.html">LayoutService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/layout/LayoutServiceMenu.html">LayoutServiceMenu</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/i18n/LanguageProvider.html">LanguageProvider</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/locale/LocaleChoiceProvider.html">LocaleChoiceProvider</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/menu/MenuBarsLoaderService.html">MenuBarsLoaderService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/menu/MenuBarsService.html">MenuBarsService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/message/MessageService.html">MessageService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/metamodel/MetaModelService.html">MetaModelService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/metamodel/MetaModelServiceMenu.html">MetaModelServiceMenu</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/metrics/MetricsService.html">MetricsService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/queryresultscache/QueryResultsCache.html">QueryResultsCache</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/repository/RepositoryService.html">RepositoryService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/routing/RoutingService.html">RoutingService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/scratchpad/Scratchpad.html">Scratchpad</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/inject/ServiceInjector.html">ServiceInjector</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/registry/ServiceRegistry.html">ServiceRegistry</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/session/SessionSubscriber.html">SessionSubscriber</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/sitemap/SitemapService.html">SitemapService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/sitemap/SitemapServiceMenu.html">SitemapServiceMenu</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/sudo/SudoService.html">SudoService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/swagger/SwaggerService.html">SwaggerService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/tablecol/TableColumnOrderService.html">TableColumnOrderService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/tablecol/TableColumnVisibilityService.html">TableColumnVisibilityService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/title/TitleService.html">TitleService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/i18n/TranslationService.html">TranslationService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/i18n/TranslationsResolver.html">TranslationsResolver</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/xactn/TransactionalProcessor.html">TransactionProcessor</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/xactn/TransactionService.html">TransactionService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/urlencoding/UrlEncodingService.html">UrlEncodingService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/userui/UserMenu.html">UserMenu</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/userreg/UserRegistrationService.html">UserRegistrationService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/user/UserService.html">UserService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/wrapper/WrapperFactory.html">WrapperFactory</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/xml/XmlService.html">XmlService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/services/xmlsnapshot/XmlSnapshotService.html">XmlSnapshotService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <span class="nav-text">Core Transaction</span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../latest/core/index/transaction/changetracking/EntityChangeTracker.html">EntityChangeTracker</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../latest/core/index/transaction/changetracking/EntityChangesPublisher.html">EntityChangesPublisher</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <span class="nav-text">Viewer Common Applib</span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../latest/viewer/index/commons/applib/services/userprof/UserProfileUiService.html">UserProfileUiService</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <span class="nav-text">Persistence JPA Applib</span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../latest/persistence/index/jpa/applib/services/JpaSupportService.html">JpaSupportService</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <span class="nav-text">Persistence QueryDsl Applib</span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../latest/persistence/index/querydsl/applib/services/auto/AutoCompleteGeneratedQueryService.html">AutoCompleteGeneratedQueryService</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../latest/persistence/index/querydsl/applib/services/repo/QueryDslRepository.html">QueryDslRepository</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../latest/persistence/index/querydsl/applib/services/support/DetachedQueryFactory.html">DetachedQueryFactory</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../latest/persistence/index/querydsl/applib/services/support/QueryDslSupport.html">QueryDslSupport</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../latest/applib-ant/about.html">Annotations</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/annotation/Action.html">@Action</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/annotation/ActionLayout.html">@ActionLayout</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/annotation/Collection.html">@Collection</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/annotation/CollectionLayout.html">@CollectionLayout</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/annotation/DomainObject.html">@DomainObject</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/annotation/DomainObjectLayout.html">@DomainObjectLayout</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/annotation/DomainService.html">@DomainService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/annotation/DomainServiceLayout.html">@DomainServiceLayout</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/annotation/Parameter.html">@Parameter</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/annotation/ParameterLayout.html">@ParameterLayout</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/annotation/Property.html">@Property</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib/index/annotation/PropertyLayout.html">@PropertyLayout</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <span class="nav-text">Other Causeway Annotations</span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../latest/applib/index/annotation/HomePage.html">@HomePage</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../latest/applib/index/annotation/Title.html">@Title</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../latest/applib/index/annotation/MinLength.html">@MinLength</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <button class="nav-item-toggle"></button> |
| <span class="nav-text">include/exclude</span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../../latest/applib/index/annotation/Domain_Include.html">@Domain.Include</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../../latest/applib/index/annotation/Domain_Exclude.html">@Domain.Exclude</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../../latest/applib/index/annotation/MemberSupport.html">@MemberSupport</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../../latest/applib/index/annotation/ObjectSupport.html">@ObjectSupport</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../../latest/applib/index/annotation/ObjectLifecycle.html">@ObjectLifecycle</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../../latest/applib/index/annotation/Programmatic.html">@Programmatic</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <button class="nav-item-toggle"></button> |
| <span class="nav-text">architecture</span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../../latest/applib/index/annotation/Module.html">@Module</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../../latest/applib/index/annotation/InteractionScope.html">@InteractionScope</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <button class="nav-item-toggle"></button> |
| <span class="nav-text">custom value type support</span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../../latest/applib/index/annotation/Value.html">@Value</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../../latest/applib/index/annotation/ValueSemantics.html">@ValueSemantics</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <span class="nav-text">Java EE Annotations</span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../latest/applib-ant/Digits.html">@Digits</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../latest/applib-ant/Nullable.html">@Nullable</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../latest/applib-ant/Pattern.html">@Pattern</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <span class="nav-text">JAXB</span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../latest/applib-ant/XmlJavaTypeAdapter.html">@XmlJavaTypeAdapter</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../latest/applib-ant/XmlRootElement.html">@XmlRootElement</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <span class="nav-text">JPA</span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../latest/applib-ant/Entity.html">@Entity</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../latest/applib-ant/Table.html">@Table</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../latest/applib-ant/Transient.html">@Transient</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../latest/applib-ant/Column.html">@Column</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../latest/applib-methods/about.html">Methods</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib-methods/prefixes.html">Supporting Methods</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib-methods/ui-hints.html">UI Hint Methods</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/applib-methods/lifecycle.html">Lifecycle Methods</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../applib-classes/about.html">Classes</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib-classes/events.html">Events</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../applib-classes/non-persisted-objects.html">Non-persisted objects</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../applib/index/ViewModel.html">ViewModel</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib-classes/layout.html">Layout</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../applib-classes/value-types.html">Value Types</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../applib/index/value/Blob.html">Blob</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../applib/index/value/Clob.html">Clob</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../applib/index/value/Markup.html">Markup</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../applib/index/value/LocalResourcePath.html">LocalResourcePath</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../applib/index/value/Password.html">Password</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../applib-classes/utility.html">Utility Classes</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../applib/index/util/Enums.html">Enums</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../applib/index/util/ObjectContracts.html">ObjectContracts</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../applib/index/util/Reasons.html">Reasons</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../applib/index/util/ReasonBuffer.html">ReasonBuffer</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../applib/index/util/ReasonBuffer2.html">ReasonBuffer2</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../applib/index/util/TitleBuffer.html">TitleBuffer</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../applib-classes/mixees-and-mixins.html">Mixees and Mixins</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../applib/index/mixins/layout/Object_downloadLayout.html">Object_downloadLayout</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../latest/applib/index/mixins/metamodel/Object_downloadMetamodelXml.html">Object_downloadMetamodelXml</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../applib/index/mixins/metamodel/Object_rebuildMetamodel.html">Object_rebuildMetamodel</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../latest/applib/index/mixins/metamodel/Object_logicalTypeName.html">Object_logicalTypeName</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../latest/applib/index/mixins/metamodel/Object_objectIdentifier.html">Object_objectIdentifier</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../viewer/index/wicket/applib/mixins/Object_clearHints.html">Object_clearHints</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../applib/index/mixins/rest/Object_openRestApi.html">Object_openRestApi</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../latest/applib/index/mixins/dto/Dto_downloadXml.html">Dto_downloadXml</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../latest/applib/index/mixins/dto/Dto_downloadXsd.html">Dto_downloadXsd</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <button class="nav-item-toggle"></button> |
| <span class="nav-text">Command Log</span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../../latest/extensions/index/commandlog/applib/contributions/Object_recentCommands.html">Object_recentCommands</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../../latest/extensions/index/commandlog/applib/contributions/HasInteractionId_commandLogEntry.html">HasInteraction_commandLogEntry</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../../latest/extensions/index/commandlog/applib/contributions/HasUsername_recentCommandsByUser.html">HasUsername_recentCommandsByUser</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <button class="nav-item-toggle"></button> |
| <span class="nav-text">Execution Log</span> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../../latest/extensions/index/executionlog/applib/contributions/Object_recentExecutions.html">Object_recentExecutions</a> |
| </li> |
| <li class="nav-item" data-depth="4"> |
| <a class="nav-link" href="../../latest/extensions/index/executionlog/applib/contributions/HasInteractionId_executionLogEntries.html">HasInteractionId_executionLogEntries</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../../latest/applib/index/mixins/system/HasTarget_openTargetObject.html">HasTarget_openTargetObject</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib-classes/spec.html">Specification pattern</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../latest/config/about.html">Configuration</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/config/sections/causeway.applib.html">Applib</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/config/sections/causeway.core.config.html">Core Configuration</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/config/sections/causeway.core.meta-model.html">Core MetaModel</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/config/sections/causeway.core.meta-model.introspector.html">Core MetaModel Introspection</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/config/sections/causeway.core.meta-model.validator.html">Core MetaModel Validator</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/config/sections/causeway.core.runtime.html">Core Runtime</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/config/sections/causeway.core.runtime-services.html">Core Runtime Services</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/config/sections/causeway.persistence.schema.html">Core Persistence Schema</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/config/sections/causeway.persistence.commons.html">Core Persistence Commons</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/config/sections/causeway.prototyping.html">Prototyping</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/config/sections/causeway.security.keycloak.html">Keycloak Security Implementation</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/config/sections/causeway.security.spring.html">Spring Security Implementation</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/config/sections/causeway.viewer.common.html">Common Config for Viewers</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/config/sections/causeway.viewer.graphql.html">GraphQL API</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/config/sections/causeway.viewer.restfulobjects.html">REST API (Restful Objects Viewer)</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/config/sections/causeway.viewer.wicket.html">Wicket Viewer</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/config/sections/eclipselink.html">Eclipselink Configuration</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/config/sections/causeway.extensions.html">Extensions</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/config/sections/causeway.value-types.html">Value types</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/config/sections/causeway.testing.html">Testing</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/config/sections/Other.html">Other</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../../latest/schema/about.html">Schema</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/schema/mml.html">MetaModel</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/schema/cmd.html">Command</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/schema/ixn.html">Interaction</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/schema/chg.html">Changes</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../../latest/schema/common.html">Common</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </nav> |
| </div> |
| <div class="nav-panel-explore" data-panel="explore"> |
| <div class="context"> |
| <span class="title">Reference Guide</span> |
| <span class="version">3.2.0</span> |
| </div> |
| <ul class="components"> |
| <li class="component"> |
| <span class="title"> </span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../../docs/latest/about.html">4.0.0-M2</a> |
| </li> |
| <li class="version"> |
| <a href="../../../docs/4.0.0-M1/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../../docs/3.6.0/about.html">3.6.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../docs/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../docs/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../docs/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../docs/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../docs/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../docs/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../docs/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../docs/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Committers' Guide</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../../comguide/latest/about.html">4.0.0-M2</a> |
| </li> |
| <li class="version"> |
| <a href="../../../comguide/4.0.0-M1/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../../comguide/3.6.0/about.html">3.6.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../comguide/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../comguide/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../comguide/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../comguide/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../comguide/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../comguide/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../comguide/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../comguide/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Contributors' Guide</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../../conguide/latest/about.html">4.0.0-M2</a> |
| </li> |
| <li class="version"> |
| <a href="../../../conguide/4.0.0-M1/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../../conguide/3.6.0/about.html">3.6.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../conguide/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../conguide/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../conguide/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../conguide/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../conguide/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../conguide/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../conguide/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../conguide/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Design Docs</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../../core/latest/about.html">4.0.0-M2</a> |
| </li> |
| <li class="version"> |
| <a href="../../../core/4.0.0-M1/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../../core/3.6.0/about.html">3.6.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../core/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../core/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../core/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../core/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../core/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../core/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../core/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../core/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Extensions</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../../extensions/latest/about.html">4.0.0-M2</a> |
| </li> |
| <li class="version"> |
| <a href="../../../extensions/4.0.0-M1/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../../extensions/3.6.0/about.html">3.6.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../extensions/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../extensions/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../extensions/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../extensions/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../extensions/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../extensions/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../extensions/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../extensions/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">GraphQL Viewer</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../../gqlv/latest/about.html">4.0.0-M2</a> |
| </li> |
| <li class="version"> |
| <a href="../../../gqlv/4.0.0-M1/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../../gqlv/3.6.0/about.html">3.6.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../gqlv/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../gqlv/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../gqlv/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../gqlv/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../gqlv/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../gqlv/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../gqlv/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../gqlv/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Incubator Catalog</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../../incubator/latest/about.html">4.0.0-M2</a> |
| </li> |
| <li class="version"> |
| <a href="../../../incubator/4.0.0-M1/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../../incubator/3.6.0/about.html">3.6.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../incubator/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../incubator/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../incubator/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../incubator/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../incubator/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../incubator/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../incubator/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../incubator/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">JDO/DataNucleus</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../../pjdo/latest/about.html">3.6.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../pjdo/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../pjdo/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../pjdo/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../pjdo/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../pjdo/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../pjdo/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../pjdo/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../pjdo/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">JPA</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../../pjpa/latest/about.html">4.0.0-M2</a> |
| </li> |
| <li class="version"> |
| <a href="../../../pjpa/4.0.0-M1/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../../pjpa/3.6.0/about.html">3.6.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../pjpa/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../pjpa/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../pjpa/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../pjpa/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../pjpa/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../pjpa/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../pjpa/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../pjpa/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">QueryDSL</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../../querydsl/latest/about.html">4.0.0-M2</a> |
| </li> |
| <li class="version"> |
| <a href="../../../querydsl/4.0.0-M1/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../../querydsl/3.6.0/about.html">3.6.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../querydsl/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../querydsl/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../querydsl/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../querydsl/3.2.0/about.html">3.2.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component is-current"> |
| <span class="title">Reference Guide</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../latest/about.html">4.0.0-M2</a> |
| </li> |
| <li class="version"> |
| <a href="../../4.0.0-M1/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../3.6.0/about.html">3.6.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version is-current"> |
| <a href="../about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">regressiontests</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../../regressiontests/latest/index.html">4.0.0-M2</a> |
| </li> |
| <li class="version"> |
| <a href="../../../regressiontests/4.0.0-M1/index.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../../regressiontests/3.6.0/index.html">3.6.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../regressiontests/3.5.0/index.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../regressiontests/3.4.0/index.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../regressiontests/3.3.0/index.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../regressiontests/3.2.0/index.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../regressiontests/3.1.0/index.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../regressiontests/3.0.0/index.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../regressiontests/2.1.0/index.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../regressiontests/2.0.0/index.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Release Notes</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../../relnotes/latest/about.html">4.0.0-M2</a> |
| </li> |
| <li class="version"> |
| <a href="../../../relnotes/4.0.0-M1/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../../relnotes/3.6.0/about.html">3.6.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../relnotes/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../relnotes/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../relnotes/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../relnotes/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../relnotes/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../relnotes/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../relnotes/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../relnotes/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">REST API (Restful Objects Viewer)</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../../vro/latest/about.html">4.0.0-M2</a> |
| </li> |
| <li class="version"> |
| <a href="../../../vro/4.0.0-M1/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../../vro/3.6.0/about.html">3.6.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../vro/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../vro/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../vro/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../vro/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../vro/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../vro/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../vro/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../vro/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Security Guide</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../../security/latest/about.html">4.0.0-M2</a> |
| </li> |
| <li class="version"> |
| <a href="../../../security/4.0.0-M1/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../../security/3.6.0/about.html">3.6.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../security/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../security/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../security/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../security/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../security/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../security/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../security/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../security/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Setup Guide</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../../setupguide/latest/about.html">4.0.0-M2</a> |
| </li> |
| <li class="version"> |
| <a href="../../../setupguide/4.0.0-M1/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../../setupguide/3.6.0/about.html">3.6.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../setupguide/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../setupguide/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../setupguide/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../setupguide/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../setupguide/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../setupguide/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../setupguide/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../setupguide/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Testing Guide</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../../testing/latest/about.html">4.0.0-M2</a> |
| </li> |
| <li class="version"> |
| <a href="../../../testing/4.0.0-M1/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../../testing/3.6.0/about.html">3.6.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../testing/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../testing/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../testing/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../testing/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../testing/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../testing/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../testing/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../testing/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Tutorials</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../../tutorials/latest/about.html">4.0.0-M2</a> |
| </li> |
| <li class="version"> |
| <a href="../../../tutorials/4.0.0-M1/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../../tutorials/3.6.0/about.html">3.6.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../tutorials/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../tutorials/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../tutorials/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../tutorials/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../tutorials/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../tutorials/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../tutorials/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../tutorials/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">User Guide</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../../userguide/latest/about.html">4.0.0-M2</a> |
| </li> |
| <li class="version"> |
| <a href="../../../userguide/4.0.0-M1/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../../userguide/3.6.0/about.html">3.6.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../userguide/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../userguide/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../userguide/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../userguide/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../userguide/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../userguide/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../userguide/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../userguide/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Value Types Catalog</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../../valuetypes/latest/about.html">4.0.0-M2</a> |
| </li> |
| <li class="version"> |
| <a href="../../../valuetypes/4.0.0-M1/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../../valuetypes/3.6.0/about.html">3.6.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../valuetypes/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../valuetypes/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../valuetypes/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../valuetypes/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../valuetypes/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../valuetypes/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../valuetypes/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../valuetypes/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Web UI (Wicket Viewer)</span> |
| <ul class="versions"> |
| <li class="version"> |
| <a href="../../../vw/latest/about.html">4.0.0-M2</a> |
| </li> |
| <li class="version"> |
| <a href="../../../vw/4.0.0-M1/about.html">4.0.0-M1</a> |
| </li> |
| <li class="version"> |
| <a href="../../../vw/3.6.0/about.html">3.6.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../vw/3.5.0/about.html">3.5.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../vw/3.4.0/about.html">3.4.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../vw/3.3.0/about.html">3.3.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../vw/3.2.0/about.html">3.2.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../vw/3.1.0/about.html">3.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../vw/3.0.0/about.html">3.0.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../vw/2.1.0/about.html">2.1.0</a> |
| </li> |
| <li class="version"> |
| <a href="../../../vw/2.0.0/about.html">2.0.0</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </aside> |
| </div> |
| <main role="main"> |
| <div class="toolbar" role="navigation"> |
| <button class="nav-toggle"></button> |
| <a href="../../../docs/latest/about.html" class="home-link"></a> |
| <nav class="breadcrumbs" aria-label="breadcrumbs"> |
| <ul> |
| <li><a href="../about.html">Reference Guide</a></li> |
| <li><a href="about.html">Annotations</a></li> |
| </ul> |
| </nav> |
| <div class="page-versions"> |
| <button class="version-menu-toggle" title="Show other versions of page">3.2.0</button> |
| <div class="version-menu"> |
| <a class="version" href="../../latest/applib-ant/about.html">4.0.0-M2</a> |
| <a class="version" href="../../4.0.0-M1/applib-ant/about.html">4.0.0-M1</a> |
| <a class="version" href="../../3.6.0/applib-ant/about.html">3.6.0</a> |
| <a class="version" href="../../3.5.0/applib-ant/about.html">3.5.0</a> |
| <a class="version" href="../../3.4.0/applib-ant/about.html">3.4.0</a> |
| <a class="version" href="../../3.3.0/applib-ant/about.html">3.3.0</a> |
| <a class="version is-current" href="about.html">3.2.0</a> |
| <a class="version" href="../../3.1.0/applib-ant/about.html">3.1.0</a> |
| <a class="version" href="../../3.0.0/applib-ant/about.html">3.0.0</a> |
| <a class="version" href="../../2.1.0/applib-ant/about.html">2.1.0</a> |
| <a class="version" href="../../2.0.0/applib-ant/about.html">2.0.0</a> |
| </div> |
| </div> |
| <div class="edit-this-page"><a href="https://github.com/apache/causeway/edit/3.2.0/antora/components/refguide/modules/applib-ant/pages/about.adoc">Edit</a></div> |
| </div> |
| <article class="doc"> |
| <a name="section-top"></a> |
| <h1 class="page">Annotations</h1> |
| <div id="preamble"> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>This guide describes the various annotations used by Apache Causeway to provide additional metadata about the domain objects. |
| Most of these are defined by the framework itself, but some are from other libraries. |
| It also identifies a number of annotations that are now deprecated, and indicates their replacement.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The annotations supported by Apache Causeway break out into several categories.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="core-annotations"><a class="anchor" href="#core-annotations"></a>Core annotations</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>In Apache Causeway every domain object is either a domain entity, a view model or a domain service. And each of these are made up of properties, collections and actions (domain services only have actions).</p> |
| </div> |
| <div class="paragraph"> |
| <p>For each of these domain types and members there are two annotations. One covers the semantics intrinsic to the domain (eg whether an action parameter is optional or not), then other (suffix <code>…​Layout</code>) captures semantics relating to the UI/presentation layer.</p> |
| </div> |
| <div class="admonitionblock tip"> |
| <table> |
| <tr> |
| <td class="icon"> |
| <i class="fa icon-tip" title="Tip"></i> |
| </td> |
| <td class="content"> |
| <div class="paragraph"> |
| <p>Most UI semantics can also be specified using <a href="../../../userguide/latest/ui-layout-and-hints.html#object-layout" class="xref page">dynamic object layout</a>.</p> |
| </div> |
| </td> |
| </tr> |
| </table> |
| </div> |
| <div class="paragraph"> |
| <p>The table below summarizes these most commonly used annotations in Apache Causeway.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 1. Core annotations for domain objects, services and members</caption> |
| <colgroup> |
| <col style="width: 25%;"> |
| <col style="width: 50%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Annotation</th> |
| <th class="tableblock halign-left valign-top">Purpose</th> |
| <th class="tableblock halign-left valign-top">Layer</th> |
| <th class="tableblock halign-left valign-top"><a href="../../../userguide/latest/ui-layout-and-hints.html#object-layout" class="xref page">File-based layout</a>?</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../../latest/applib/index/annotation/Action.html" class="xref page">@Action</a></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Domain semantics for actions</p> |
| </div></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Domain</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../../latest/applib/index/annotation/ActionLayout.html" class="xref page">@ActionLayout</a></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>User interface hints for actions</p> |
| </div></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">UI</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Yes</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../../latest/applib/index/annotation/Collection.html" class="xref page">@Collection</a></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Domain semantics for collections</p> |
| </div></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Domain</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../../latest/applib/index/annotation/CollectionLayout.html" class="xref page">@CollectionLayout</a></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>User interface hints for collections</p> |
| </div></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">UI</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Yes</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../../latest/applib/index/annotation/DomainObject.html" class="xref page">@DomainObject</a></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Domain semantics for domain object (entities and optionally view models)</p> |
| </div></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Domain</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../../latest/applib/index/annotation/DomainObjectLayout.html" class="xref page">@DomainObjectLayout</a></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>User interface hints for domain object (entities and optionally view models)</p> |
| </div></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">UI</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Yes</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../../latest/applib/index/annotation/DomainService.html" class="xref page">@DomainService</a></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Class is a domain service (rather than an entity or view model)</p> |
| </div></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Domain</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../../latest/applib/index/annotation/DomainServiceLayout.html" class="xref page">@DomainServiceLayout</a></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>User interface hints for domain services</p> |
| </div></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">UI</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../../latest/applib/index/annotation/Parameter.html" class="xref page">@Parameter</a></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Domain semantics for action parameters</p> |
| </div></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Domain</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../../latest/applib/index/annotation/ParameterLayout.html" class="xref page">@ParameterLayout</a></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Layout hints for an action parameter (currently: its label position either to top or the left).</p> |
| </div></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">UI</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Yes</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../../latest/applib/index/annotation/Property.html" class="xref page">@Property</a></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Domain semantics for properties</p> |
| </div></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Domain</p></td> |
| <td class="tableblock halign-left valign-top"></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../../latest/applib/index/annotation/PropertyLayout.html" class="xref page">@PropertyLayout</a></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Layout hints for a property</p> |
| </div></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">UI</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Yes</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="other-causeway-annotations"><a class="anchor" href="#other-causeway-annotations"></a>Other Causeway Annotations</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>There are a number of other annotations defined by the framework, for a variety of purposes.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The following are commonly used:</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 2. Commonly annotations</caption> |
| <colgroup> |
| <col style="width: 28.5714%;"> |
| <col style="width: 57.1428%;"> |
| <col style="width: 14.2858%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Annotation</th> |
| <th class="tableblock halign-left valign-top">Purpose</th> |
| <th class="tableblock halign-left valign-top">Layer</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../../latest/applib/index/annotation/HomePage.html" class="xref page">@HomePage</a></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Query-only action (on domain service) to be invoked, result of which is rendered as the user’s home page.</p> |
| </div></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">UI</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../../latest/applib/index/annotation/MinLength.html" class="xref page">@MinLength</a></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Minimum number of characters required for an auto-complete search argument.</p> |
| </div></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">UI</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../../latest/applib/index/annotation/Title.html" class="xref page">@Title</a></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Indicates which of the object’s properties should be used to build up a title for the object.</p> |
| </div></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">UI</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <div class="paragraph"> |
| <p>The following are used to indicate whether a given should be included or excluded in the metamodel. |
| Whether they are required depends on the setting of <a href="../../latest/config/sections/causeway.core.meta-model.introspector.html#causeway.core.meta-model.introspector.policy" class="xref page">causeway.core.meta-model.introspector.policy</a>, but it is always safe to use them.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 3. Programming Model Inclusion/Exclusion</caption> |
| <colgroup> |
| <col style="width: 28.5714%;"> |
| <col style="width: 57.1428%;"> |
| <col style="width: 14.2858%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Annotation</th> |
| <th class="tableblock halign-left valign-top">Purpose</th> |
| <th class="tableblock halign-left valign-top">Layer</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../../latest/applib/index/annotation/Domain_Include.html" class="xref page">@Domain.Include</a></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Explicitly include the method as part of the metamodel.</p> |
| </div></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">UI/Domain</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../../latest/applib/index/annotation/Domain_Exclude.html" class="xref page">@Domain.Exclude</a></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Explicitly exclude the method as part of the metamodel.</p> |
| </div></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">UI/Domain</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../../latest/applib/index/annotation/MemberSupport.html" class="xref page">@MemberSupport</a></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Intended to be annotated on <code>hideXxx()</code>, <code>disableXxx()</code> and other supporting methods, explicitly include the method as part of the metamodel. |
| Equivalent to <a href="../../latest/applib/index/annotation/Domain_Include.html" class="xref page">@Domain.Include</a></p> |
| </div></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Domain</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../../latest/applib/index/annotation/ObjectSupport.html" class="xref page">@ObjectSupport</a></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Intended to be annotated on <code>title()</code>, <code>iconName()</code> and other UI hint methods, explicitly include the method as part of the metamodel. |
| Equivalent to <a href="../../latest/applib/index/annotation/Domain_Include.html" class="xref page">@Domain.Include</a></p> |
| </div></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">UI</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../../latest/applib/index/annotation/ObjectLifecycle.html" class="xref page">@ObjectLifecycle</a></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Intended to be annotated on <code>created()</code>, <code>updated()</code> and other lifecycle methods, explicitly include the method as part of the metamodel. |
| Equivalent to <a href="../../latest/applib/index/annotation/Domain_Include.html" class="xref page">@Domain.Include</a></p> |
| </div></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Persistence</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../../latest/applib/index/annotation/Programmatic.html" class="xref page">@Programmatic</a></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Indicates that a method is to be called only programmatically, and so is <em>not</em> part of the metamodel. |
| Equivalent to (and the original name of) <a href="../../latest/applib/index/annotation/Domain_Exclude.html" class="xref page">@Domain.Exclude</a></p> |
| </div></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">UI/Domain</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <div class="paragraph"> |
| <p>The next annotations relate to the overall system architecture.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 4. Architecture</caption> |
| <colgroup> |
| <col style="width: 28.5714%;"> |
| <col style="width: 57.1428%;"> |
| <col style="width: 14.2858%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Annotation</th> |
| <th class="tableblock halign-left valign-top">Purpose</th> |
| <th class="tableblock halign-left valign-top">Layer</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../../latest/applib/index/annotation/Module.html" class="xref page">@Module</a></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>An alias for Spring’s own <code>@Configuration</code>, identifies a logical module consisting of a set of services, entities, mixins, fixtures etc.</p> |
| </div></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Domain</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../../latest/applib/index/annotation/InteractionScope.html" class="xref page">@InteractionScope</a></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Annotated on a domain service to indicate that it should be scoped by the interaction (roughly equivalent to an HTTP request).</p> |
| </div></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Domain</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <div class="paragraph"> |
| <p>The final annotations relate to the definition of custom value types:</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 5. Custom value type support</caption> |
| <colgroup> |
| <col style="width: 28.5714%;"> |
| <col style="width: 57.1428%;"> |
| <col style="width: 14.2858%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Annotation</th> |
| <th class="tableblock halign-left valign-top">Purpose</th> |
| <th class="tableblock halign-left valign-top">Layer</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../../latest/applib/index/annotation/Value.html" class="xref page">@Value</a></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Marker annotation that indicates the object is a value type (as opposed to a domain service, entity, view model or mixin).</p> |
| </div> |
| <div class="paragraph"> |
| <p>Value types also require an implementation of a <a href="../../latest/applib/index/value/semantics/ValueSemanticsProvider.html" class="xref page">ValueSemanticsProvider</a>.</p> |
| </div></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Domain</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../../latest/applib/index/annotation/ValueSemantics.html" class="xref page">@ValueSemantics</a></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Annotated on a property or parameter, indicating that the property/parameter’s type should be considered a value type, and supplying details of the service implementing <a href="../../latest/applib/index/value/semantics/ValueSemanticsProvider.html" class="xref page">ValueSemanticsProvider</a> that describes how the framework should interact with the value type.</p> |
| </div></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Domain</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="java-ee-annotations"><a class="anchor" href="#java-ee-annotations"></a>Java EE Annotations</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>While Apache Causeway does define many of its own annotations, the policy is to reuse standard Java/JEE annotations wherever they exist or are added to the Java platform.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The table below lists the JEE annotations currently recognized.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 6. Java EE Annotations</caption> |
| <colgroup> |
| <col style="width: 28.5714%;"> |
| <col style="width: 57.1428%;"> |
| <col style="width: 14.2858%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Annotation</th> |
| <th class="tableblock halign-left valign-top">Purpose</th> |
| <th class="tableblock halign-left valign-top">Layer</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../../latest/applib-ant/Digits.html" class="xref page"><code>@javax.validation.</code><br> |
| <code>constraints.</code><br> |
| <code>Digits</code></a></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Precision/scale for BigDecimal values.</p> |
| </div></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Domain</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../../latest/applib-ant/Pattern.html" class="xref page"><code>@javax.validation.</code><br> |
| <code>constraints.</code><br> |
| <code>Pattern</code></a></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Regular expressions for strings</p> |
| </div></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Domain</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../../latest/applib-ant/Digits.html" class="xref page"><code>@javax.annotation.</code><br> |
| <code>Nullable</code></a></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Specify that a property/parameter is optional.</p> |
| </div></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Domain</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="jaxb-annotations"><a class="anchor" href="#jaxb-annotations"></a>JAXB Annotations</h2> |
| <div class="sectionbody"> |
| <table class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 7. JAXB Annotations</caption> |
| <colgroup> |
| <col style="width: 28.5714%;"> |
| <col style="width: 57.1428%;"> |
| <col style="width: 14.2858%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Annotation</th> |
| <th class="tableblock halign-left valign-top">Purpose</th> |
| <th class="tableblock halign-left valign-top">Layer</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../../latest/applib-ant/XmlRootElement.html" class="xref page"><code>javax.xml.bind</code><br> |
| <code>.annotation</code><br> |
| <code>XmlRootElement</code></a></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>JAXB annotation indicating the XML root element when serialized to XML; also used by the framework for view models (whose memento is the XML), often also acting as a DTO.</p> |
| </div></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Application</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../../latest/applib-ant/XmlJavaTypeAdapter.html" class="xref page"><code>javax.xml.bind</code><br> |
| <code>.annotation</code><br> |
| <code>XmlJavaTypeAdapter</code></a></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>JAXB annotation defining how to serialize an entity. Used in conjunction with the (framework provided) <code>PersistentEntityAdapter</code> class to serialize persistent entities into a canonical OID (equivalent to the <code>Bookmark</code> provided by the <a href="../../latest/applib/index/services/bookmark/BookmarkService.html" class="xref page">BookmarkService</a>).</p> |
| </div></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Domain</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="jpa-annotations"><a class="anchor" href="#jpa-annotations"></a>JPA Annotations</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>The table below lists the <a href="../../../pjpa/latest/about.html" class="xref page">JPA/EclipseLink</a> annotations currently recognized by Apache Causeway.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 8. JPA Annotations</caption> |
| <colgroup> |
| <col style="width: 25%;"> |
| <col style="width: 50%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Annotation</th> |
| <th class="tableblock halign-left valign-top">Purpose</th> |
| <th class="tableblock halign-left valign-top">Layer</th> |
| <th class="tableblock halign-left valign-top">Applies to</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../../latest/applib-ant/Entity.html" class="xref page">@javax.persistence.<br> |
| Entity</a></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Flags that the class is an entity, creating an abstraction layer through which the Causeway framework interacts with the underlying persistent domain object.</p> |
| </div></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Domain / persistence</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Class</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <div class="paragraph"> |
| <p>Causeway also parses the following JPA annotations, but the metadata is currently unused.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 9. JPA Annotations (unused within Apache Causeway)</caption> |
| <colgroup> |
| <col style="width: 25%;"> |
| <col style="width: 50%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Annotation</th> |
| <th class="tableblock halign-left valign-top">Purpose</th> |
| <th class="tableblock halign-left valign-top">Layer</th> |
| <th class="tableblock halign-left valign-top">Applies to</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>@javax.persistence.<br> |
| Transient</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Unused</p> |
| </div></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Persistence</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Property</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><code>@javax.persistence.<br> |
| Table</code></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Unused</p> |
| </div></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Persistence</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Class</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="jdo-annotations"><a class="anchor" href="#jdo-annotations"></a>JDO Annotations</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>The table below lists the <a href="../../../pjdo/latest/about.html" class="xref page">JDO/DataNucleus</a> annotations currently recognized by Apache Causeway.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 10. JDO Annotations</caption> |
| <colgroup> |
| <col style="width: 25%;"> |
| <col style="width: 50%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Annotation</th> |
| <th class="tableblock halign-left valign-top">Purpose</th> |
| <th class="tableblock halign-left valign-top">Layer</th> |
| <th class="tableblock halign-left valign-top">Applies to</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="../../latest/applib-ant/Column.html" class="xref page">@javax.jdo.annotations.<br> |
| Column</a></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Used to determine whether a property is mandatory or optional. For <code>String</code> and <code>BigDecimal</code> properties, used to determine length/precision/scale.</p> |
| </div></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Domain / persistence</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Property</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#refguide:applib-ant:Discriminator.adoc" class="xref unresolved">@javax.jdo.annotations.<br> |
| Discriminator</a></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Infer the logical type name. |
| This takes precedence of <code>@PersistenceCapable</code> (below). |
| However, <code>@DomainObject#logicalTypeName</code> takes precedence over this.</p> |
| </div></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Domain / persistence</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Class</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#refguide:applib-ant:NotPersistent.adoc" class="xref unresolved">@javax.jdo.annotations.<br> |
| NotPersistent</a></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Used to determine whether to enforce or skip some metamodel validation on nullability (<code>@Column</code> vs equivalent Causeway annotations).</p> |
| </div></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Domain / persistence</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Property</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#refguide:applib-ant:PersistenceCapable.adoc" class="xref unresolved">@javax.jdo.annotations.<br> |
| PersistenceCapable</a></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>The <code>schema</code> attribute plus table name is used to the logical type name. |
| However, <code>@Discriminator</code> (above) takes precedence, as does <code>@DomainObject#logicalTypeName</code>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Internally, it also flags that the class is an entity, creating an abstraction layer through which the Causeway framework interacts with the underlying persistent domain object.</p> |
| </div></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Domain / persistence</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Class</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#refguide:applib-ant:PrimaryKey.adoc" class="xref unresolved">@javax.jdo.annotations.<br> |
| PrimaryKey</a></p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Used to ensure Apache Causeway does not overwrite application-defined primary keys, and to ensure is read-only in the UI.</p> |
| </div></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Domain / persistence</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Property</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <div class="paragraph"> |
| <p>Causeway also parses the following JDO annotations, but the metadata is currently unused.</p> |
| </div> |
| <table class="tableblock frame-all grid-all stretch"> |
| <caption class="title">Table 11. JDO Annotations (unused within Apache Causeway)</caption> |
| <colgroup> |
| <col style="width: 25%;"> |
| <col style="width: 50%;"> |
| <col style="width: 12.5%;"> |
| <col style="width: 12.5%;"> |
| </colgroup> |
| <thead> |
| <tr> |
| <th class="tableblock halign-left valign-top">Annotation</th> |
| <th class="tableblock halign-left valign-top">Purpose</th> |
| <th class="tableblock halign-left valign-top">Layer</th> |
| <th class="tableblock halign-left valign-top">Applies to</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">@javax.jdo.annotations.<br> |
| DataStoreIdentity</p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Unused</p> |
| </div></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Persistence</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Class</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">@javax.jdo.annotations.<br> |
| Queries</p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Unused</p> |
| </div></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Persistence</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Class</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">@javax.jdo.annotations.<br> |
| Query</p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Unused</p> |
| </div></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Persistence</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Class</p></td> |
| </tr> |
| <tr> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">@javax.jdo.annotations.<br> |
| Version</p></td> |
| <td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph"> |
| <p>Unused</p> |
| </div></div></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Persistence</p></td> |
| <td class="tableblock halign-left valign-top"><p class="tableblock">Class</p></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="examples"><a class="anchor" href="#examples"></a>Examples</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>To give just a few examples of annotations supported by Apache Causeway:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>if a property is read-only, then this can be annotated with <code>@Property(editing=Editing.DISABLED)</code>.</p> |
| </li> |
| <li> |
| <p>if a class has a small fixed set of instances (eg a picklist), then it can be annotated using <code>@DomainObject(bounded=true)</code></p> |
| </li> |
| <li> |
| <p>if a class is a domain service and should be automatically instantiated as a singleton, then it can be annotated using <code>@DomainService</code></p> |
| </li> |
| <li> |
| <p>if an action is idempotent, then it can be annotated using <code>@Action(semantics=SemanticsOf.IDEMPOTENT)</code>.</p> |
| </li> |
| <li> |
| <p>if an action parameter is optional, it can be annotated using <code>@Parameter(optionality=Optionality.OPTIONAL)</code></p> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>Some annotations act as UI hints, for example:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>if a collection should be rendered "open" rather than collapsed, it can be annotated using <code>@CollectionLayout(defaultView="table")</code></p> |
| </li> |
| <li> |
| <p>if an action has a tooltip, it can be annotated using <code>@ActionLayout(describedAs=…​)</code></p> |
| </li> |
| <li> |
| <p>if a domain object is bookmarkable, it can be annotated using <code>@DomainObjectLayout(bookmarking=BookmarkPolicy.AS_ROOT</code>).</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| </article> |
| <aside class="article-aside toc hide-for-print" role="navigation"> |
| <p class="toc-title">On this page</p> |
| <div id="article-toc"></div> |
| </aside> |
| </main> |
| </div> |
| <footer class="footer"> |
| <div class="content"> |
| <div class="copyright"> |
| <p> |
| Copyright © 2010~2024 The Apache Software Foundation, licensed under the Apache License, v2.0. |
| <br/> |
| Apache, the Apache feather logo, Apache Causeway, and the Apache Causeway project logo are all trademarks of The Apache Software Foundation. |
| </p> |
| </div> |
| <div class="revision"> |
| <p>Revision: build-website.20260712-1517</p> |
| </div> |
| </div> |
| </footer> |
| <script src="../../../_/js/site.js"></script> |
| <script async src="../../../_/js/vendor/highlight.js"></script> |
| <script src="../../../_/js/vendor/jquery-3.4.1.min.js"></script> |
| <script src="../../../_/js/vendor/jquery-ui-1.12.1.custom.widget-only.min.js"></script> |
| <script src="../../../_/js/vendor/jquery.tocify.min.js"></script> |
| |
| <script> |
| $(function() { |
| $("#article-toc").tocify( { |
| showEffect: "slideDown", |
| hashGenerator: "pretty", |
| hideEffect: "slideUp", |
| selectors: "h2, h3", |
| scrollTo: 120, |
| smoothScroll: true, |
| theme: "jqueryui", |
| highlightOnScroll: true |
| } ); |
| }); |
| </script> |
| |
| <script src="../../../_/js/vendor/docsearch.min.js"></script> |
| <script> |
| function focusSearchInput () { document.querySelector('#algolia-search-input').focus() } |
| var search = docsearch({ |
| appId: '5ISP5TFAEN', |
| apiKey: '0fc51c28b4ad46e7318e96d4e97fab7c', |
| indexName: 'causeway-apache-org', |
| inputSelector: '#algolia-search-input', |
| autocompleteOptions: { hint: false, keyboardShortcuts: ['s'] }, |
| debug: false, |
| }).autocomplete |
| search.on('autocomplete:closed', function () { search.autocomplete.setVal() }) |
| focusSearchInput() |
| window.addEventListener('load', focusSearchInput); |
| </script> |
| |
| <!-- |
| docsearch options: |
| https://docsearch.algolia.com/docs/behavior/ |
| --> |
| <!-- |
| https://www.algolia.com/doc/api-reference/api-parameters/ |
| algoliaOptions: { hitsPerPage: 6 }, |
| --> |
| </body> |
| </html> |