| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <meta name="viewport" content="width=device-width,initial-scale=1"> |
| <title>Common Schema :: Apache Isis</title> |
| <link rel="canonical" href="https://isis.apache.org/refguide/2.0.0-M5/schema/common.html"> |
| <meta name="generator" content="Antora 2.3.4"> |
| <link rel="stylesheet" href="../../../_/css/site.css"> |
| <link rel="stylesheet" href="../../../_/css/site-custom.css"> |
| <link href="https://fonts.googleapis.com/css?family=Open+Sans:300,300i,400,400i,700,700i|Raleway:300,400,500,700,800|Montserrat:300,400,700" rel="stylesheet"> |
| <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css"/> |
| <link rel="home" href="https://isis.apache.org" title="Apache Isis"> |
| <link rel="prev" href="chg.html" title="Changes"> |
| </head> |
| <body class="article"> |
| <header class="header"> |
| <nav class="navbar"> |
| <div class="navbar-brand"> |
| <a class="navbar-item" href="https://isis.apache.org"> |
| <span class="icon"> |
| <img src="../../../_/img/isis-logo-48x48.png"></img> |
| </span> |
| <span>Apache Isis</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 hide-for-print"> |
| <span> |
| <input id="algolia-search-input" placeholder="Search"></span> |
| </span> |
| </div> |
| <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/2.0.0-M5/starters/helloworld.html">Hello World</a> |
| <a class="navbar-item" href="../../../docs/2.0.0-M5/starters/simpleapp.html">Simple App</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Demos & Tutorials</span> |
| <a class="navbar-item" href="../../../docs/2.0.0-M5/demo/about.html">Demo App</a> |
| <a class="navbar-item" href="https://danhaywood.gitlab.io/isis-petclinic-tutorial-docs/petclinic/1.16.2/intro.html">Petclinic (tutorial)</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Resources</span> |
| <a class="navbar-item" href="../../../docs/2.0.0-M5/resources/cheatsheet.html">Cheatsheet</a> |
| <a class="navbar-item" href="../../../docs/2.0.0-M5/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">Development</span> |
| <a class="navbar-item" href="../../../setupguide/2.0.0-M5/about.html">Setup Guide</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Core</span> |
| <a class="navbar-item" href="../../../userguide/2.0.0-M5/about.html">User Guide</a> |
| <a class="navbar-item" href="../../../refguide/2.0.0-M5/about.html">Reference Guide</a> |
| <a class="navbar-item" href="../../../testing/2.0.0-M5/about.html">Testing Guide</a> |
| </div> |
| </div> |
| <div class="navbar-item has-dropdown is-hoverable"> |
| <a class="navbar-link" href="#">Libraries</a> |
| <div class="navbar-dropdown"> |
| <span class="navbar-item navbar-heading">For Use in Apps</span> |
| <a class="navbar-item" href="../../../subdomains/2.0.0-M5/about.html">Subdomain Libraries</a> |
| <a class="navbar-item" href="../../../valuetypes/2.0.0-M5/about.html">Value Types</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Integrate between Apps</span> |
| <a class="navbar-item" href="../../../mappings/2.0.0-M5/about.html">Bounded Context Mapping Libraries</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Other</span> |
| <a class="navbar-item" href="../../../incubator/2.0.0-M5/about.html">Incubator</a> |
| <a class="navbar-item" href="../../../legacy/2.0.0-M5/about.html">Legacy</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">Viewers</span> |
| <a class="navbar-item" href="../../../vw/2.0.0-M5/about.html">Web UI (Wicket)</a> |
| <a class="navbar-item" href="../../../vro/2.0.0-M5/about.html">REST API (Restful Objects)</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Security</span> |
| <a class="navbar-item" href="../../../security/2.0.0-M5/about.html">Security Guide</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Persistence</span> |
| <a class="navbar-item" href="../../../pjpa/2.0.0-M5/about.html">JPA (EclipseLink)</a> |
| <a class="navbar-item" href="../../../pjdo/2.0.0-M5/about.html">JDO (DataNucleus)</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Extensions</span> |
| <a class="navbar-item" href="../../../extensions/2.0.0-M5/about.html">Extensions Catalog</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/2.0.0-M5/support/slack-channel.html">Slack</a> |
| <a class="navbar-item" href="../../../docs/2.0.0-M5/support/mailing-list.html">Mailing Lists</a> |
| <a class="navbar-item" href="https://issues.apache.org/jira/browse/ISIS">JIRA</a> |
| <a class="navbar-item" href="https://stackoverflow.com/questions/tagged/isis">Stack Overflow</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Releases</span> |
| <a class="navbar-item" href="../../../docs/2.0.0-M5/downloads/how-to.html">Downloads</a> |
| <a class="navbar-item" href="../../../relnotes/2.0.0-M5/about.html">Release Notes</a> |
| <a class="navbar-item" href="../../../docs/2.0.0-M5/archive/1-x.html">Archive (1.x)</a> |
| <hr class="navbar-divider"/> |
| <span class="navbar-item navbar-heading">Framework</span> |
| <a class="navbar-item" href="../../../conguide/2.0.0-M5/about.html">Contributors' Guide</a> |
| <a class="navbar-item" href="../../../comguide/2.0.0-M5/about.html">Committers' Guide</a> |
| <a class="navbar-item" href="../../../core/2.0.0-M5/about.html">Core Design</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/">Licenses</a> |
| <a class="navbar-item" href="https://www.apache.org/security/">Security</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/Isis.html">PMC board minutes</a> |
| </div> |
| </div> |
| <a class="navbar-item" href="../../../docs/2.0.0-M5/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="2.0.0-M5"> |
| <aside class="nav"> |
| <div class="panels"> |
| <div class="nav-panel-pagination"> |
| <a class="page-previous" rel="prev" href="chg.html" title="Changes"><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" rel="prev" href="about.html" title="Changes"><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="../applib-svc/about.html">Domain Services</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/acceptheader/AcceptHeaderService.html">AcceptHeaderService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/appfeat/ApplicationFeatureRepository.html">ApplicationFeatureRepository</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/bookmark/BookmarkService.html">BookmarkService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/bookmarkui/BookmarkUiService.html">BookmarkUiService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/clock/ClockService.html">ClockService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/commanddto/processor/spi/CommandDtoProcessorService.html">CommandDtoProcessorService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/command/CommandExecutorService.html">CommandExecutorService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/publishing/spi/CommandSubscriber.html">CommandSubscriber</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/confview/ConfigurationMenu.html">ConfigurationMenu</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/confview/ConfigurationViewService.html">ConfigurationViewService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/conmap/ContentMappingService.html">ContentMappingService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/linking/DeepLinkService.html">DeepLinkService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/userreg/EmailNotificationService.html">EmailNotificationService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/email/EmailService.html">EmailService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/publishing/spi/EntityChangesSubscriber.html">EntityChangesSubscriber</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/publishing/spi/EntityPropertyChangeSubscriber.html">EntityPropertyChangeSubscriber</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/error/ErrorReportingService.html">ErrorReportingService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/eventbus/EventBusService.html">EventBusService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/exceprecog/ExceptionRecognizerService.html">ExceptionRecognizerService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/factory/FactoryService.html">FactoryService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/grid/GridLoaderService.html">GridLoaderService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/grid/GridService.html">GridService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/grid/GridSystemService.html">GridSystemService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/health/HealthCheckService.html">HealthCheckService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/hint/HintStore.html">HintStore</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/homepage/HomePageResolverService.html">HomePageResolverService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/iactn/InteractionContext.html">InteractionContext</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/jaxb/JaxbService.html">JaxbService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/layout/LayoutService.html">LayoutService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/layout/LayoutServiceMenu.html">LayoutServiceMenu</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/i18n/LocaleProvider.html">LocaleProvider</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/menu/MenuBarsLoaderService.html">MenuBarsLoaderService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/menu/MenuBarsService.html">MenuBarsService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/message/MessageService.html">MessageService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/metamodel/MetaModelService.html">MetamodelService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/metamodel/MetaModelServiceMenu.html">MetamodelServiceMenu</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/metrics/MetricsService.html">MetricsService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/publishing/spi/ExecutionSubscriber.html">ExecutionSubscriber</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/queryresultscache/QueryResultsCache.html">QueryResultsCache</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/repository/RepositoryService.html">RepositoryService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/routing/RoutingService.html">RoutingService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/scratchpad/Scratchpad.html">Scratchpad</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/inject/ServiceInjector.html">ServiceInjector</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/registry/ServiceRegistry.html">ServiceRegistry</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/session/SessionLoggingService.html">SessionLoggingService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/sudo/SudoService.html">SudoService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/swagger/SwaggerService.html">SwaggerService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/tablecol/TableColumnOrderService.html">TableColumnOrderService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/title/TitleService.html">TitleService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/i18n/TranslationService.html">TranslationService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/i18n/TranslationsResolver.html">TranslationsResolver</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/xactn/TransactionalProcessor.html">TransactionProcessor</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/xactn/TransactionService.html">TransactionService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/urlencoding/UrlEncodingService.html">UrlEncodingService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/userprof/UserProfileService.html">UserProfileService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/userreg/UserRegistrationService.html">UserRegistrationService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/user/UserService.html">UserService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/wrapper/WrapperFactory.html">WrapperFactory</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/xml/XmlService.html">XmlService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/services/xmlsnapshot/XmlSnapshotService.html">XmlSnapshotService</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../applib-ant/about.html">Annotations</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/annotation/Action.html">Action</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/annotation/ActionLayout.html">ActionLayout</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/annotation/Collection.html">Collection</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/annotation/CollectionLayout.html">CollectionLayout</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib-ant/Column.html">Column</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib-ant/Digits.html">Digits</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib-ant/Discriminator.html">Discriminator</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/annotation/DomainObject.html">DomainObject</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/annotation/DomainObjectLayout.html">DomainObjectLayout</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/annotation/DomainService.html">DomainService</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/annotation/DomainServiceLayout.html">DomainServiceLayout</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/annotation/Facets.html">Facets</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/annotation/HomePage.html">HomePage</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/annotation/MemberOrder.html">MemberOrder</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib-ant/NotPersistent.html">NotPersistent.</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib-ant/Nullable.html">Nullable</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/annotation/MinLength.html">MinLength</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/annotation/Parameter.html">Parameter</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/annotation/ParameterLayout.html">ParameterLayout</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib-ant/Pattern.html">Pattern</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib-ant/PersistenceCapable.html">PersistenceCapable</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib-ant/PrimaryKey.html">PrimaryKey</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/annotation/Programmatic.html">Programmatic</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/annotation/Property.html">Property</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/annotation/PropertyLayout.html">PropertyLayout</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/annotation/InteractionScope.html">RequestScoped</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib/index/annotation/Title.html">Title</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib-ant/XmlJavaTypeAdapter.html">XmlJavaTypeAdapter</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib-ant/XmlRootElement.html">XmlRootElement</a> |
| </li> |
| </ul> |
| </li> |
| <li class="nav-item" data-depth="1"> |
| <button class="nav-item-toggle"></button> |
| <a class="nav-link" href="../applib-methods/about.html">Methods</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib-methods/prefixes.html">Supporting Methods</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../applib-methods/ui-hints.html">UI Hint Methods</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../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> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../applib/index/RecreatableDomainObject.html">RecreatableDomainObject</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/JaxbUtil.html">JaxbUtil</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_downloadLayoutXml.html">Object_downloadLayoutXml</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../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="../applib/index/mixins/metamodel/Object_objectType.html">Object_objectType</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../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/viewer/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="../applib/index/mixins/dto/Dto_downloadXml.html">Dto_downloadXml</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../applib/index/mixins/dto/Dto_downloadXsd.html">Dto_downloadXsd</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../persistence/index/jdo/datanucleus/mixins/Persistable_downloadJdoMetadata.html">Persistable_downloadJdoMetadata</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../persistence/index/jdo/datanucleus/mixins/Persistable_datanucleusIdLong.html">Persistable_datanucleusIdLong</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../persistence/index/jdo/datanucleus/mixins/Persistable_datanucleusVersionLong.html">Persistable_datanucleusVersionLong</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../persistence/index/jdo/datanucleus/mixins/Persistable_datanucleusVersionTimestamp.html">Persistable_datanucleusVersionTimestamp</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../extensions/index/commandlog/impl/mixins/HasInteractionId_command.html">HasInteractionId_command</a> |
| </li> |
| <li class="nav-item" data-depth="3"> |
| <a class="nav-link" href="../applib/index/mixins/system/DomainChangeRecord_openTargetObject.html">DomainChangeRecord_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="../config/about.html">Configuration</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../config/sections/isis.applib.html">Applib</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../config/sections/isis.core.config.html">Core Configuration</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../config/sections/isis.core.meta-model.html">Core MetaModel</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../config/sections/isis.core.meta-model.introspector.html">Core MetaModel Introspection</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../config/sections/isis.core.meta-model.validator.html">MetaModel Validator</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../config/sections/isis.core.runtime.html">Core Runtime</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../config/sections/isis.core.runtime-services.html">Core Runtime Services</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../config/sections/isis.persistence.schema.html">Core Persistence Schema</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../config/sections/isis.security.shiro.html">Shiro Security Implementation</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../config/sections/isis.security.spring.html">Spring Security Implementation</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../config/sections/isis.viewer.restfulobjects.html">Restful Objects Viewer</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../config/sections/isis.viewer.wicket.html">Wicket Viewer</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../config/sections/datanucleus.html">DataNucleus Configuration</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../config/sections/resteasy.html">RestEasy Configuration</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../config/sections/isis.extensions.html">Extensions</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../config/sections/isis.value-types.html">Value types</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../config/sections/isis.testing.html">Testing</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../config/sections/isis.legacy.html">Legacy</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="../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="about.html">Schema</a> |
| <ul class="nav-list"> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="mml.html">MetaModel</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="cmd.html">Command</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="ixn.html">Interaction</a> |
| </li> |
| <li class="nav-item" data-depth="2"> |
| <a class="nav-link" href="chg.html">Changes</a> |
| </li> |
| <li class="nav-item is-current-page" data-depth="2"> |
| <a class="nav-link" href="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">2.0.0-M5</span> |
| </div> |
| <ul class="components"> |
| <li class="component"> |
| <span class="title"> </span> |
| <ul class="versions"> |
| <li class="version is-latest"> |
| <a href="../../../docs/2.0.0-M5/about.html">2.0.0-M5</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">BC Mapping Libraries</span> |
| <ul class="versions"> |
| <li class="version is-latest"> |
| <a href="../../../mappings/2.0.0-M5/about.html">2.0.0-M5</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Committers' Guide</span> |
| <ul class="versions"> |
| <li class="version is-latest"> |
| <a href="../../../comguide/2.0.0-M5/about.html">2.0.0-M5</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Contributors' Guide</span> |
| <ul class="versions"> |
| <li class="version is-latest"> |
| <a href="../../../conguide/2.0.0-M5/about.html">2.0.0-M5</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Design Docs</span> |
| <ul class="versions"> |
| <li class="version is-latest"> |
| <a href="../../../core/2.0.0-M5/about.html">2.0.0-M5</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Extensions Catalog</span> |
| <ul class="versions"> |
| <li class="version is-latest"> |
| <a href="../../../extensions/2.0.0-M5/about.html">2.0.0-M5</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Incubator Catalog</span> |
| <ul class="versions"> |
| <li class="version is-latest"> |
| <a href="../../../incubator/2.0.0-M5/about.html">2.0.0-M5</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">JDO/DataNucleus</span> |
| <ul class="versions"> |
| <li class="version is-latest"> |
| <a href="../../../pjdo/2.0.0-M5/about.html">2.0.0-M5</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">JPA</span> |
| <ul class="versions"> |
| <li class="version is-latest"> |
| <a href="../../../pjpa/2.0.0-M5/about.html">2.0.0-M5</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Legacy Catalog</span> |
| <ul class="versions"> |
| <li class="version is-latest"> |
| <a href="../../../legacy/2.0.0-M5/about.html">2.0.0-M5</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component is-current"> |
| <span class="title">Reference Guide</span> |
| <ul class="versions"> |
| <li class="version is-current is-latest"> |
| <a href="../about.html">2.0.0-M5</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Release Notes</span> |
| <ul class="versions"> |
| <li class="version is-latest"> |
| <a href="../../../relnotes/2.0.0-M5/about.html">2.0.0-M5</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">REST API (Restful Objects Viewer)</span> |
| <ul class="versions"> |
| <li class="version is-latest"> |
| <a href="../../../vro/2.0.0-M5/about.html">2.0.0-M5</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Security Guide</span> |
| <ul class="versions"> |
| <li class="version is-latest"> |
| <a href="../../../security/2.0.0-M5/about.html">2.0.0-M5</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Setup Guide</span> |
| <ul class="versions"> |
| <li class="version is-latest"> |
| <a href="../../../setupguide/2.0.0-M5/about.html">2.0.0-M5</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Subdomains Catalog</span> |
| <ul class="versions"> |
| <li class="version is-latest"> |
| <a href="../../../subdomains/2.0.0-M5/about.html">2.0.0-M5</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Testing Guide</span> |
| <ul class="versions"> |
| <li class="version is-latest"> |
| <a href="../../../testing/2.0.0-M5/about.html">2.0.0-M5</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Tooling</span> |
| <ul class="versions"> |
| <li class="version is-latest"> |
| <a href="../../../tooling/2.0.0-M5/about.html">2.0.0-M5</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">User Guide</span> |
| <ul class="versions"> |
| <li class="version is-latest"> |
| <a href="../../../userguide/2.0.0-M5/about.html">2.0.0-M5</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Value Types Catalog</span> |
| <ul class="versions"> |
| <li class="version is-latest"> |
| <a href="../../../valuetypes/2.0.0-M5/about.html">2.0.0-M5</a> |
| </li> |
| </ul> |
| </li> |
| <li class="component"> |
| <span class="title">Web UI (Wicket Viewer)</span> |
| <ul class="versions"> |
| <li class="version is-latest"> |
| <a href="../../../vw/2.0.0-M5/about.html">2.0.0-M5</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/2.0.0-M5/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">Schema</a></li> |
| <li><a href="common.html">Common</a></li> |
| </ul> |
| </nav> |
| <div class="edit-this-page"><a href="https://github.com/apache/isis/edit/2.0.0-M5/api/schema/src/main/adoc/modules/schema/pages/common.adoc">Edit</a></div> |
| </div> |
| <article class="doc"> |
| <a name="section-top"></a> |
| <h1 class="page">Common Schema</h1> |
| <div id="preamble"> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>The "common" schema defines a number of complex types that are used by other higher-level schemas.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="oiddto"><a class="anchor" href="#oiddto"></a><code>oidDto</code></h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>The <code>oidDto</code> complex type captures an object’s type and its identifier. |
| This is basically a formal XML equivalent to the <code>Bookmark</code> object obtained from the <a href="../applib/index/services/bookmark/BookmarkService.html" class="page">BookmarkService</a>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Although simple, this is an enormously powerful concept, in that it represents a URI to any domain object managed by a given Apache Isis application. |
| With it, we have the ability to lookup any arbitrary object. |
| Further discussion and examples can be found <a href="../../../userguide/2.0.0-M5/fun/overview.html#oid" class="page">here</a>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The <code>oidDto</code> complex type is defined as:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><xs:schema targetNamespace="http://isis.apache.org/schema/common" <i class="conum" data-value="1"></i><b>(1)</b> |
| elementFormDefault="qualified" |
| xmlns="http://isis.apache.org/schema/common" |
| xmlns:xs="http://www.w3.org/2001/XMLSchema"> |
| |
| <xs:complexType name="oidDto"> <i class="conum" data-value="2"></i><b>(2)</b> |
| <xs:sequence/> |
| <xs:attribute name="type" type="xs:string"/> <i class="conum" data-value="3"></i><b>(3)</b> |
| <xs:attribute name="id" type="xs:string"/> <i class="conum" data-value="4"></i><b>(4)</b> |
| <xs:attribute name="objectState" type="bookmarkObjectState"/> |
| </xs:complexType> |
| |
| <xs:simpleType name="bookmarkObjectState"> <i class="conum" data-value="5"></i><b>(5)</b> |
| <xs:restriction base="xs:string"> |
| <xs:enumeration value="persistent"/> |
| <xs:enumeration value="transient"/> |
| <xs:enumeration value="viewModel"/> |
| </xs:restriction> |
| </xs:simpleType> |
| |
| <xs:complexType name="oidsDto"> <i class="conum" data-value="6"></i><b>(6)</b> |
| <xs:sequence> |
| <xs:element name="oid" type="oidDto" minOccurs="1" maxOccurs="unbounded"/> |
| </xs:sequence> |
| </xs:complexType> |
| ... |
| </xs:schema></code></pre> |
| </div> |
| </div> |
| <div class="colist arabic"> |
| <table> |
| <tr> |
| <td><i class="conum" data-value="1"></i><b>1</b></td> |
| <td>the common schema has a namespace URI of "http://isis.apache.org/schema/common". |
| Although URIs are not the same as URLs, you will find that the schemas are also downloadable from this location.</td> |
| </tr> |
| <tr> |
| <td><i class="conum" data-value="2"></i><b>2</b></td> |
| <td>the <code>oidDto</code> complex type defines the unique identifier for any domain object: its type, and an identifier. |
| The <code>objectState</code> attribute can usually be omitted (indicating a persistent object)</td> |
| </tr> |
| <tr> |
| <td><i class="conum" data-value="3"></i><b>3</b></td> |
| <td>the object type, corresponding to either the <a href="../applib/index/annotation/DomainObject.html#objectType" class="page">@DomainObject#objectType()</a> attribute, or to the (JDO) |
| <a href="../applib-ant/PersistenceCapable.html" class="page">@PersistenceCapable</a> annotation (<code>schema</code> and/or <code>table</code> attributes), or to the (JDO) <a href="../applib-ant/Discriminator.html" class="page">@Discriminator</a> annotation. |
| If none is specified, then the fully qualified class name will be used.</td> |
| </tr> |
| <tr> |
| <td><i class="conum" data-value="4"></i><b>4</b></td> |
| <td>the object identifier (aka primary key), converted to string form.</td> |
| </tr> |
| <tr> |
| <td><i class="conum" data-value="5"></i><b>5</b></td> |
| <td>the <code>bookmarkObjectState</code> enumerates the possible persistence states of the referenced object. |
| In previous versions of the schema the attribute was defaulted to "persistent"; the "persistent" state is assumed if the attribute is omitted.</td> |
| </tr> |
| <tr> |
| <td><i class="conum" data-value="6"></i><b>6</b></td> |
| <td>Models a list of OIDs. |
| This is used by the <a href="cmd.html" class="page">"cmd" schema</a> to represent the |
| intention to perform a bulk actions (against a number of selected objects).</td> |
| </tr> |
| </table> |
| </div> |
| <div class="paragraph"> |
| <p>In previous versions of the schema the object type and object identifers of <code>oidDto</code> were modelled as an element rather than an attribute. |
| The element form can still be used, but is deprecated.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The <code>oidDto</code> complex type is used in a number of places by the framework:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p>first, as a means of serializing JAXB view model/DTOs (annotated with |
| <a href="../applib-ant/XmlRootElement.html" class="page">@XmlRootElement</a>), that reference domain entities.</p> |
| <div class="paragraph"> |
| <p>These references are serialized instead into OIDs</p> |
| </div> |
| </li> |
| <li> |
| <p>second, as references to the target of a command representing the <em>intention</em> to invoke an action or edit a property, as described by the <a href="cmd.html" class="page">"cmd" (command)</a> schema.</p> |
| <div class="paragraph"> |
| <p>They are also used to represent references to any action arguments/properties that take domain object entities/view models.</p> |
| </div> |
| </li> |
| <li> |
| <p>third, as references to the target of an interaction capturing the actual execution of an action invocation or property edit, as described by the <a href="ixn.html" class="page">"ixn" (interaction)</a> schema.</p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="collectiondto-etc"><a class="anchor" href="#collectiondto-etc"></a><code>collectionDto</code> etc</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>The <code>collectionDto</code> type defines a collection of values, also capturing the type of those values (for example <code>string</code>s, or <code>OidDto</code>s). |
| It is used primarily to model invocations of actions with collection parameters.</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><xs:schema targetNamespace="http://isis.apache.org/schema/common" ... > |
| ... |
| <xs:complexType name="collectionDto"> |
| <xs:sequence> |
| <xs:element name="value" type="valueDto" minOccurs="1" maxOccurs="unbounded"/> |
| </xs:sequence> |
| <xs:attribute name="type" use="required" type="valueType"/> |
| <xs:attribute name="null" use="optional" type="xs:boolean"/> |
| </xs:complexType> |
| ... |
| </xs:schema></code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="valuedto-etc"><a class="anchor" href="#valuedto-etc"></a><code>valueDto</code> etc</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>The common schema also defines two types representing values: the <code>valueDto</code> complex type, the <code>valueType</code> simple type and the <code>valueWithTypeDto</code> complex type:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><xs:schema targetNamespace="http://isis.apache.org/schema/common" ... > |
| ... |
| <xs:complexType name="valueDto"> <i class="conum" data-value="1"></i><b>(1)</b> |
| <xs:choice minOccurs="0" maxOccurs="1"> |
| <xs:element name="string" type="xs:string"/> |
| <xs:element name="byte" type="xs:byte"/> |
| <xs:element name="short" type="xs:short"/> |
| ... |
| <xs:element name="timestamp" type="xs:dateTime"/> |
| <xs:element name="enum" type="enumDto"/> |
| <xs:element name="reference" type="oidDto"/> |
| <xs:element name="collection" type="collectionDto"/> |
| <xs:element name="blob" type="blobDto"/> |
| <xs:element name="clob" type="clobDto"/> |
| </xs:choice> |
| </xs:complexType> |
| |
| <xs:simpleType name="valueType"> <i class="conum" data-value="2"></i><b>(2)</b> |
| <xs:restriction base="xs:string"> |
| <xs:enumeration value="string"/> |
| <xs:enumeration value="byte"/> |
| <xs:enumeration value="short"/> |
| ... |
| <xs:enumeration value="enum"/> |
| <xs:enumeration value="reference"/> |
| <xs:enumeration value="collection"/> |
| <xs:enumeration value="blob"/> |
| <xs:enumeration value="clob"/> |
| <xs:enumeration value="void"/> <i class="conum" data-value="3"></i><b>(3)</b> |
| </xs:restriction> |
| </xs:simpleType> |
| |
| <xs:complexType name="valueWithTypeDto"> <i class="conum" data-value="4"></i><b>(4)</b> |
| <xs:complexContent> |
| <xs:extension base="valueDto"> |
| <xs:attribute name="type" use="required" type="valueType"/> |
| <xs:attribute name="null" use="optional" type="xs:boolean"/> |
| </xs:extension> |
| </xs:complexContent> |
| </xs:complexType> |
| ... |
| </xs:schema></code></pre> |
| </div> |
| </div> |
| <div class="colist arabic"> |
| <table> |
| <tr> |
| <td><i class="conum" data-value="1"></i><b>1</b></td> |
| <td>Intended to hold any valid value, eg of an argument to an action or a new value of a property.</td> |
| </tr> |
| <tr> |
| <td><i class="conum" data-value="2"></i><b>2</b></td> |
| <td>Enumerates the full set of types understood by the framework; note that these also include references to entities or view models, and to enums.</td> |
| </tr> |
| <tr> |
| <td><i class="conum" data-value="3"></i><b>3</b></td> |
| <td>Not valid to be used as the parameter type of an action; can be used as its return type.</td> |
| </tr> |
| <tr> |
| <td><i class="conum" data-value="4"></i><b>4</b></td> |
| <td>Inherits from <code>valueDto</code>, capturing both a value and its corresponding type. |
| Used for the return value of action invocations, and for the new value in property edits.</td> |
| </tr> |
| </table> |
| </div> |
| <div class="paragraph"> |
| <p>These type definitions are just building blocks. |
| The first, <code>valueDto</code> is The second, <code>valueType</code>, enumerates the different types of vales, eg of a formal parameter to an action.</p> |
| </div> |
| <div class="admonitionblock important"> |
| <table> |
| <tr> |
| <td class="icon"> |
| <i class="fa icon-important" title="Important"></i> |
| </td> |
| <td class="content"> |
| <div class="paragraph"> |
| <p>When used as a parameter, blob and clob arguments are <em>not</em> serialized. |
| Instead these are persisted only as references. |
| This is primarily to save storage space if the resultant XML is persisted as a memento (eg <code>CommandDto</code>).</p> |
| </div> |
| </td> |
| </tr> |
| </table> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="ancillary-types"><a class="anchor" href="#ancillary-types"></a>Ancillary types</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>The common schema also defines a number of ancillary types, used either by the common schema itself (see above) or by the <a href="cmd.html" class="page">"cmd"</a> and <a href="ixn.html" class="page">"ixn"</a> schemas.</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><xs:schema targetNamespace="http://isis.apache.org/schema/common" ... > |
| ... |
| <xs:complexType name="enumDto"> <i class="conum" data-value="1"></i><b>(1)</b> |
| <xs:sequence> |
| <xs:element name="enumType" type="xs:string"/> |
| <xs:element name="enumName" type="xs:string"/> |
| </xs:sequence> |
| </xs:complexType> |
| |
| <xs:complexType name="blobDto"> <i class="conum" data-value="2"></i><b>(2)</b> |
| <xs:sequence> |
| <xs:element name="name" type="xs:string"/> |
| <xs:element name="mimeType" type="xs:string"/> |
| <xs:element name="bytes" type="xs:hexBinary"/> |
| </xs:sequence> |
| <xs:attribute name="type" use="required" type="valueType"/> |
| <xs:attribute name="null" use="optional" type="xs:boolean"/> |
| </xs:complexType> |
| |
| <xs:complexType name="clobDto"> <i class="conum" data-value="3"></i><b>(3)</b> |
| <xs:sequence> |
| <xs:element name="name" type="xs:string"/> |
| <xs:element name="mimeType" type="xs:string"/> |
| <xs:element name="chars" type="xs:string"/> |
| </xs:sequence> |
| <xs:attribute name="type" use="required" type="valueType"/> |
| <xs:attribute name="null" use="optional" type="xs:boolean"/> |
| </xs:complexType> |
| |
| <xs:complexType name="periodDto"> <i class="conum" data-value="4"></i><b>(4)</b> |
| <xs:sequence> |
| <xs:element name="startedAt" type="xs:dateTime"/> |
| <xs:element name="completedAt" type="xs:dateTime" |
| minOccurs="0" maxOccurs="1"/> |
| </xs:sequence> |
| </xs:complexType> |
| |
| <xs:complexType name="differenceDto"> <i class="conum" data-value="5"></i><b>(5)</b> |
| <xs:sequence/> |
| <xs:attribute name="before" type="xs:int"/> |
| <xs:attribute name="after" type="xs:int"/> |
| </xs:complexType> |
| |
| <xs:simpleType name="interactionType"> <i class="conum" data-value="6"></i><b>(6)</b> |
| <xs:restriction base="xs:string"> |
| <xs:enumeration value="action_invocation" /> |
| <xs:enumeration value="property_edit" /> |
| </xs:restriction> |
| </xs:simpleType> |
| |
| <xs:complexType name="oidsDto"> <i class="conum" data-value="7"></i><b>(7)</b> |
| <xs:sequence> |
| <xs:element name="oid" type="oidDto" minOccurs="1" maxOccurs="unbounded"/> |
| </xs:sequence> |
| </xs:complexType> |
| |
| </xs:schema></code></pre> |
| </div> |
| </div> |
| <div class="colist arabic"> |
| <table> |
| <tr> |
| <td><i class="conum" data-value="1"></i><b>1</b></td> |
| <td>Models an instance member of an enum (eg <code>Color.RED</code>).</td> |
| </tr> |
| <tr> |
| <td><i class="conum" data-value="2"></i><b>2</b></td> |
| <td>Models a <code>Blob</code></td> |
| </tr> |
| <tr> |
| <td><i class="conum" data-value="3"></i><b>3</b></td> |
| <td>Models a <code>Clob</code></td> |
| </tr> |
| <tr> |
| <td><i class="conum" data-value="4"></i><b>4</b></td> |
| <td>Captures a period of time, eg for capturing metrics/timings.</td> |
| </tr> |
| <tr> |
| <td><i class="conum" data-value="5"></i><b>5</b></td> |
| <td>Captures a pair of numbers representing a difference. |
| Used for example to capture metrics (number objects modified before and after).</td> |
| </tr> |
| <tr> |
| <td><i class="conum" data-value="6"></i><b>6</b></td> |
| <td>Whether this command/interaction with a member is invoking an action, or editing a property. |
| Used by both the <a href="cmd.html" class="page">"cmd"</a> and <a href="ixn.html" class="page">"ixn"</a> schemas.</td> |
| </tr> |
| <tr> |
| <td><i class="conum" data-value="7"></i><b>7</b></td> |
| <td>Contains a list of OIDs, eg for use in "bulk" actions that apply to multiple targets.</td> |
| </tr> |
| </table> |
| </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~2021 The Apache Software Foundation, licensed under the Apache License, v2.0. |
| <br/> |
| Apache, the Apache feather logo, Apache Isis, and the Apache Isis project logo are all trademarks of The Apache Software Foundation. |
| </p> |
| </div> |
| <div class="revision"> |
| <p>Revision: 2.0.0-M5.20210523-1443</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="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script> |
| <script> |
| function focusSearchInput () { document.querySelector('#algolia-search-input').focus() } |
| var search = docsearch({ |
| appId: '5ISP5TFAEN', |
| apiKey: '0fc51c28b4ad46e7318e96d4e97fab7c', |
| indexName: 'isis-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> |
