You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2021/02/07 14:53:32 UTC
[isis] 08/12: ISIS-2526: refactoring is all
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch ISIS-2444
in repository https://gitbox.apache.org/repos/asf/isis.git
commit 3f0071ae106da96fb68c4f22a4e2e8ba0f4b4a7f
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Sat Feb 6 16:41:09 2021 +0000
ISIS-2526: refactoring is all
---
.../pages/index/applib/AbstractViewModel.adoc | 5 +-
.../generated/pages/index/applib/Identifier.adoc | 49 +-
.../pages/index/applib/IsisModuleApplib.adoc | 5 +-
.../index/applib/RecreatableDomainObject.adoc | 11 +-
.../generated/pages/index/applib/ViewModel.adoc | 11 +-
.../adapters/AbstractValueSemanticsProvider.adoc | 8 +-
.../index/applib/adapters/DefaultsProvider.adoc | 8 +-
.../index/applib/adapters/EncoderDecoder.adoc | 11 +-
.../index/applib/adapters/EncodingException.adoc | 9 +-
.../pages/index/applib/adapters/Parser.adoc | 27 +-
.../index/applib/adapters/ParsingException.adoc | 9 +-
.../applib/adapters/ValueSemanticsProvider.adoc | 14 +-
.../pages/index/applib/annotation/Action.adoc | 44 +-
.../index/applib/annotation/ActionLayout.adoc | 37 +-
.../index/applib/annotation/BookmarkPolicy.adoc | 17 +-
.../pages/index/applib/annotation/Bounding.adoc | 8 +-
.../pages/index/applib/annotation/Collection.adoc | 17 +-
.../index/applib/annotation/CollectionLayout.adoc | 29 +-
.../pages/index/applib/annotation/Defaulted.adoc | 11 +-
.../index/applib/annotation/DomainObject.adoc | 64 +-
.../applib/annotation/DomainObjectLayout.adoc | 41 +-
.../index/applib/annotation/DomainService.adoc | 11 +-
.../applib/annotation/DomainServiceLayout.adoc | 11 +-
.../pages/index/applib/annotation/Editing.adoc | 17 +-
.../index/applib/annotation/EntityChangeKind.adoc | 8 +-
.../index/applib/annotation/EqualByContent.adoc | 5 +-
.../pages/index/applib/annotation/Facets.adoc | 11 +-
.../pages/index/applib/annotation/HomePage.adoc | 5 +-
.../index/applib/annotation/InteractionScope.adoc | 5 +-
.../index/applib/annotation/LabelPosition.adoc | 15 +-
.../pages/index/applib/annotation/MemberOrder.adoc | 13 +-
.../pages/index/applib/annotation/MinLength.adoc | 6 +-
.../pages/index/applib/annotation/Module.adoc | 5 +-
.../pages/index/applib/annotation/Nature.adoc | 23 +-
.../index/applib/annotation/NatureOfService.adoc | 17 +-
.../pages/index/applib/annotation/Navigable.adoc | 9 +-
.../pages/index/applib/annotation/Optionality.adoc | 23 +-
.../index/applib/annotation/OrderPrecedence.adoc | 20 +-
.../pages/index/applib/annotation/Parameter.adoc | 32 +-
.../index/applib/annotation/ParameterLayout.adoc | 31 +-
.../index/applib/annotation/Programmatic.adoc | 5 +-
.../pages/index/applib/annotation/Projecting.adoc | 11 +-
.../pages/index/applib/annotation/PromptStyle.adoc | 32 +-
.../pages/index/applib/annotation/Property.adoc | 63 +-
.../index/applib/annotation/PropertyLayout.adoc | 43 +-
.../pages/index/applib/annotation/Publishing.adoc | 17 +-
.../pages/index/applib/annotation/Redirect.adoc | 16 +-
.../pages/index/applib/annotation/RenderDay.adoc | 12 +-
.../pages/index/applib/annotation/Repainting.adoc | 12 +-
.../pages/index/applib/annotation/RestrictTo.adoc | 8 +-
.../pages/index/applib/annotation/SemanticsOf.adoc | 39 +-
.../pages/index/applib/annotation/Snapshot.adoc | 14 +-
.../pages/index/applib/annotation/Title.adoc | 21 +-
.../pages/index/applib/annotation/Value.adoc | 11 +-
.../pages/index/applib/annotation/Where.adoc | 41 +-
.../client/RepresentationTypeSimplifiedV2.adoc | 33 +-
.../pages/index/applib/client/SuppressionType.adoc | 24 +-
.../pages/index/applib/clock/VirtualClock.adoc | 41 +-
.../index/applib/domain/DomainObjectList.adoc | 14 +-
.../pages/index/applib/events/EventObjectBase.adoc | 14 +-
.../applib/events/domain/AbstractDomainEvent.adoc | 51 +-
.../applib/events/domain/ActionDomainEvent.adoc | 24 +-
.../events/domain/CollectionDomainEvent.adoc | 15 +-
.../applib/events/domain/PropertyDomainEvent.adoc | 9 +-
.../events/lifecycle/AbstractLifecycleEvent.adoc | 7 +-
.../events/lifecycle/ObjectCreatedEvent.adoc | 7 +-
.../applib/events/lifecycle/ObjectLoadedEvent.adoc | 7 +-
.../events/lifecycle/ObjectPersistedEvent.adoc | 7 +-
.../events/lifecycle/ObjectPersistingEvent.adoc | 7 +-
.../events/lifecycle/ObjectRemovingEvent.adoc | 7 +-
.../events/lifecycle/ObjectUpdatedEvent.adoc | 7 +-
.../events/lifecycle/ObjectUpdatingEvent.adoc | 7 +-
.../index/applib/events/ui/AbstractUiEvent.adoc | 15 +-
.../index/applib/events/ui/CssClassUiEvent.adoc | 12 +-
.../pages/index/applib/events/ui/IconUiEvent.adoc | 15 +-
.../index/applib/events/ui/LayoutUiEvent.adoc | 12 +-
.../pages/index/applib/events/ui/TitleUiEvent.adoc | 15 +-
.../applib/exceptions/RecoverableException.adoc | 13 +-
.../applib/exceptions/TranslatableException.adoc | 15 +-
.../applib/exceptions/UnrecoverableException.adoc | 13 +-
.../unrecoverable/DomainModelException.adoc | 8 +-
.../unrecoverable/MetaModelException.adoc | 8 +-
.../unrecoverable/NoAuthenticatorException.adoc | 8 +-
.../unrecoverable/ObjectNotFoundException.adoc | 7 +-
.../unrecoverable/ObjectPersistenceException.adoc | 8 +-
.../unrecoverable/PersistFailedException.adoc | 8 +-
.../unrecoverable/ReflectiveActionException.adoc | 8 +-
.../unrecoverable/RepositoryException.adoc | 8 +-
.../unrecoverable/UnexpectedCallException.adoc | 6 +-
.../unrecoverable/UnknownTypeException.adoc | 7 +-
.../generated/pages/index/applib/graph/Edge.adoc | 7 +-
.../pages/index/applib/graph/SimpleEdge.adoc | 7 +-
.../generated/pages/index/applib/graph/Vertex.adoc | 10 +-
.../index/applib/graph/tree/LazyTreeNode.adoc | 13 +-
.../pages/index/applib/graph/tree/TreeAdapter.adoc | 14 +-
.../pages/index/applib/graph/tree/TreeNode.adoc | 37 +-
.../pages/index/applib/graph/tree/TreePath.adoc | 14 +-
.../pages/index/applib/graph/tree/TreeState.adoc | 7 +-
.../pages/index/applib/jaxb/DataTypeFactory.adoc | 6 +-
.../index/applib/jaxb/JavaSqlJaxbAdapters.adoc | 5 +-
.../JavaSqlXMLGregorianCalendarMarshalling.adoc | 8 +-
.../index/applib/jaxb/JavaTimeJaxbAdapters.adoc | 5 +-
.../JavaTimeXMLGregorianCalendarMarshalling.adoc | 17 +-
.../index/applib/jaxb/JavaUtilJaxbAdapters.adoc | 5 +-
.../index/applib/jaxb/JodaTimeJaxbAdapters.adoc | 5 +-
.../JodaTimeXMLGregorianCalendarMarshalling.adoc | 13 +-
.../applib/jaxb/PersistentEntitiesAdapter.adoc | 7 +-
.../index/applib/jaxb/PersistentEntityAdapter.adoc | 7 +-
.../index/applib/jaxb/PrimitiveJaxbAdapters.adoc | 5 +-
.../applib/layout/component/ActionLayoutData.adoc | 46 +-
.../layout/component/ActionLayoutDataOwner.adoc | 7 +-
.../layout/component/CollectionLayoutData.adoc | 46 +-
.../component/CollectionLayoutDataOwner.adoc | 6 +-
.../layout/component/CssClassFaPosition.adoc | 8 +-
.../layout/component/DomainObjectLayoutData.adoc | 34 +-
.../component/DomainObjectLayoutDataOwner.adoc | 7 +-
.../index/applib/layout/component/FieldSet.adoc | 36 +-
.../applib/layout/component/FieldSetOwner.adoc | 6 +-
.../applib/layout/component/HasBookmarking.adoc | 7 +-
.../index/applib/layout/component/HasCssClass.adoc | 7 +-
.../applib/layout/component/HasCssClassFa.adoc | 9 +-
.../applib/layout/component/HasDescribedAs.adoc | 7 +-
.../index/applib/layout/component/HasHidden.adoc | 7 +-
.../index/applib/layout/component/HasNamed.adoc | 9 +-
.../applib/layout/component/MemberRegion.adoc | 7 +-
.../applib/layout/component/MemberRegionOwner.adoc | 5 +-
.../pages/index/applib/layout/component/Owned.adoc | 6 +-
.../pages/index/applib/layout/component/Owner.adoc | 5 +-
.../layout/component/PropertyLayoutData.adoc | 48 +-
.../layout/component/ServiceActionLayoutData.adoc | 39 +-
.../component/ServiceActionLayoutDataOwner.adoc | 7 +-
.../pages/index/applib/layout/grid/Grid.adoc | 15 +-
.../index/applib/layout/grid/GridAbstract.adoc | 15 +-
.../applib/layout/grid/bootstrap3/BS3ClearFix.adoc | 5 +-
.../layout/grid/bootstrap3/BS3ClearFixHidden.adoc | 6 +-
.../layout/grid/bootstrap3/BS3ClearFixVisible.adoc | 8 +-
.../applib/layout/grid/bootstrap3/BS3Col.adoc | 41 +-
.../applib/layout/grid/bootstrap3/BS3Element.adoc | 9 +-
.../layout/grid/bootstrap3/BS3ElementAbstract.adoc | 9 +-
.../applib/layout/grid/bootstrap3/BS3Grid.adoc | 17 +-
.../applib/layout/grid/bootstrap3/BS3Row.adoc | 21 +-
.../layout/grid/bootstrap3/BS3RowContent.adoc | 14 +-
.../layout/grid/bootstrap3/BS3RowContentOwner.adoc | 5 +-
.../applib/layout/grid/bootstrap3/BS3RowOwner.adoc | 6 +-
.../applib/layout/grid/bootstrap3/BS3Tab.adoc | 15 +-
.../applib/layout/grid/bootstrap3/BS3TabGroup.adoc | 24 +-
.../layout/grid/bootstrap3/BS3TabGroupOwner.adoc | 6 +-
.../applib/layout/grid/bootstrap3/BS3TabOwner.adoc | 6 +-
.../applib/layout/grid/bootstrap3/HasCssId.adoc | 8 +-
.../index/applib/layout/grid/bootstrap3/Size.adoc | 10 +-
.../applib/layout/grid/bootstrap3/SizeSpan.adoc | 15 +-
.../applib/layout/grid/bootstrap3/WithinGrid.adoc | 6 +-
.../pages/index/applib/layout/links/Link.adoc | 12 +-
.../index/applib/layout/menubars/HasNamed.adoc | 6 +-
.../pages/index/applib/layout/menubars/Menu.adoc | 5 +-
.../index/applib/layout/menubars/MenuBar.adoc | 5 +-
.../index/applib/layout/menubars/MenuBars.adoc | 10 +-
.../applib/layout/menubars/MenuBarsAbstract.adoc | 8 +-
.../index/applib/layout/menubars/MenuSection.adoc | 6 +-
.../applib/layout/menubars/bootstrap3/BS3Menu.adoc | 16 +-
.../layout/menubars/bootstrap3/BS3MenuBar.adoc | 8 +-
.../layout/menubars/bootstrap3/BS3MenuBars.adoc | 18 +-
.../layout/menubars/bootstrap3/BS3MenuSection.adoc | 10 +-
.../pages/index/applib/mixins/MixinConstants.adoc | 8 +-
.../pages/index/applib/mixins/dto/Dto.adoc | 5 +-
.../index/applib/mixins/dto/Dto_downloadXml.adoc | 8 +-
.../index/applib/mixins/dto/Dto_downloadXsd.adoc | 10 +-
.../mixins/layout/Object_downloadLayoutXml.adoc | 9 +-
.../applib/mixins/layout/Object_openRestApi.adoc | 8 +-
.../mixins/layout/Object_rebuildMetamodel.adoc | 7 +-
.../metamodel/Object_downloadMetamodelXml.adoc | 10 +-
.../mixins/metamodel/Object_objectIdentifier.adoc | 6 +-
.../applib/mixins/metamodel/Object_objectType.adoc | 6 +-
.../index/applib/query/AllInstancesQuery.adoc | 5 +-
.../pages/index/applib/query/NamedQuery.adoc | 9 +-
.../generated/pages/index/applib/query/Query.adoc | 20 +-
.../pages/index/applib/query/QueryRange.adoc | 32 +-
.../index/applib/services/DomainChangeRecord.adoc | 32 +-
.../index/applib/services/MethodReferences.adoc | 5 +-
.../RepresentsInteractionMemberExecution.adoc | 6 +-
.../services/acceptheader/AcceptHeaderService.adoc | 20 +-
.../appfeat/ApplicationFeatureRepository.adoc | 12 +-
.../services/appfeat/ApplicationMemberType.adoc | 9 +-
.../index/applib/services/bookmark/Bookmark.adoc | 16 +-
.../applib/services/bookmark/BookmarkHolder.adoc | 6 +-
.../services/bookmark/BookmarkHolder_lookup.adoc | 6 +-
.../services/bookmark/BookmarkHolder_object.adoc | 6 +-
.../applib/services/bookmark/BookmarkService.adoc | 25 +-
.../services/bookmarkui/BookmarkUiService.adoc | 16 +-
.../index/applib/services/clock/ClockService.adoc | 7 +-
.../index/applib/services/command/Command.adoc | 20 +-
.../services/command/CommandExecutorService.adoc | 11 +-
.../services/command/CommandOutcomeHandler.adoc | 10 +-
.../applib/services/commanddto/HasCommandDto.adoc | 6 +-
.../conmap/ContentMappingServiceForCommandDto.adoc | 9 +-
.../ContentMappingServiceForCommandsDto.adoc | 10 +-
.../services/commanddto/conmap/UserDataKeys.adoc | 7 +-
.../commanddto/processor/CommandDtoProcessor.adoc | 10 +-
.../CommandDtoProcessorForActionAbstract.adoc | 5 +-
.../CommandDtoProcessorForPropertyAbstract.adoc | 5 +-
.../processor/spi/CommandDtoProcessorService.adoc | 12 +-
.../spi/CommandDtoProcessorServiceIdentity.adoc | 6 +-
.../services/confview/ConfigurationMenu.adoc | 7 +-
.../services/confview/ConfigurationProperty.adoc | 7 +-
.../confview/ConfigurationViewService.adoc | 8 +-
.../services/conmap/ContentMappingService.adoc | 8 +-
.../index/applib/services/email/EmailService.adoc | 10 +-
.../index/applib/services/error/ErrorDetails.adoc | 5 +-
.../services/error/ErrorReportingService.adoc | 6 +-
.../index/applib/services/error/SimpleTicket.adoc | 17 +-
.../pages/index/applib/services/error/Ticket.adoc | 20 +-
.../applib/services/eventbus/EventBusService.adoc | 6 +-
.../services/exceprecog/ExceptionRecognizer.adoc | 8 +-
.../exceprecog/ExceptionRecognizerAbstract.adoc | 10 +-
.../exceprecog/ExceptionRecognizerForType.adoc | 11 +-
.../exceprecog/ExceptionRecognizerService.adoc | 14 +-
.../applib/services/factory/FactoryService.adoc | 35 +-
.../applib/services/grid/GridLoaderService.adoc | 26 +-
.../index/applib/services/grid/GridService.adoc | 44 +-
.../applib/services/grid/GridSystemService.adoc | 16 +-
.../pages/index/applib/services/health/Health.adoc | 9 +-
.../applib/services/health/HealthCheckService.adoc | 6 +-
.../index/applib/services/hint/HintStore.adoc | 10 +-
.../services/homepage/HomePageResolverService.adoc | 6 +-
.../index/applib/services/i18n/LocaleProvider.adoc | 6 +-
.../applib/services/i18n/TranslatableString.adoc | 36 +-
.../applib/services/i18n/TranslationService.adoc | 14 +-
.../applib/services/i18n/TranslationsResolver.adoc | 6 +-
.../applib/services/iactn/ExecutionContext.adoc | 8 +-
.../index/applib/services/iactn/Interaction.adoc | 15 +-
.../applib/services/iactn/InteractionContext.adoc | 9 +-
.../applib/services/inject/ServiceInjector.adoc | 7 +-
.../index/applib/services/jaxb/JaxbService.adoc | 16 +-
.../applib/services/layout/LayoutService.adoc | 14 +-
.../applib/services/layout/LayoutServiceMenu.adoc | 12 +-
.../applib/services/linking/DeepLinkService.adoc | 8 +-
.../services/menu/MenuBarsLoaderService.adoc | 11 +-
.../applib/services/menu/MenuBarsService.adoc | 9 +-
.../applib/services/message/MessageService.adoc | 32 +-
.../index/applib/services/metamodel/BeanSort.adoc | 36 +-
.../applib/services/metamodel/DomainMember.adoc | 19 +-
.../applib/services/metamodel/DomainModel.adoc | 6 +-
.../services/metamodel/MetaModelService.adoc | 23 +-
.../services/metamodel/MetaModelServiceMenu.adoc | 17 +-
.../applib/services/metrics/MetricsService.adoc | 15 +-
.../services/publishing/log/CommandLogger.adoc | 7 +-
.../publishing/log/EntityChangesLogger.adoc | 7 +-
.../publishing/log/EntityPropertyChangeLogger.adoc | 7 +-
.../services/publishing/log/ExecutionLogger.adoc | 7 +-
.../services/publishing/spi/CommandSubscriber.adoc | 8 +-
.../services/publishing/spi/EntityChanges.adoc | 12 +-
.../publishing/spi/EntityChangesSubscriber.adoc | 8 +-
.../publishing/spi/EntityPropertyChange.adoc | 6 +-
.../spi/EntityPropertyChangeSubscriber.adoc | 8 +-
.../publishing/spi/ExecutionSubscriber.adoc | 8 +-
.../queryresultscache/QueryResultCacheControl.adoc | 6 +-
.../queryresultscache/QueryResultsCache.adoc | 15 +-
.../applib/services/registry/ServiceRegistry.adoc | 28 +-
.../applib/services/repository/EntityState.adoc | 13 +-
.../services/repository/RepositoryService.adoc | 73 +-
.../applib/services/routing/RoutingService.adoc | 7 +-
.../applib/services/scratchpad/Scratchpad.adoc | 11 +-
.../services/session/SessionLoggingService.adoc | 6 +-
.../session/SessionLoggingServiceLogging.adoc | 6 +-
.../index/applib/services/sudo/SudoService.adoc | 14 +-
.../applib/services/swagger/SwaggerService.adoc | 6 +-
.../TableColumnOrderForCollectionTypeAbstract.adoc | 7 +-
.../services/tablecol/TableColumnOrderService.adoc | 7 +-
.../index/applib/services/title/TitleService.adoc | 11 +-
.../services/urlencoding/UrlEncodingService.adoc | 9 +-
...rlEncodingServiceUsingBaseEncodingAbstract.adoc | 7 +-
.../index/applib/services/user/RoleMemento.adoc | 12 +-
.../index/applib/services/user/UserMemento.adoc | 33 +-
.../index/applib/services/user/UserService.adoc | 20 +-
.../services/userprof/UserProfileService.adoc | 8 +-
.../services/userreg/EmailNotificationService.adoc | 12 +-
.../index/applib/services/userreg/UserDetails.adoc | 5 +-
.../services/userreg/UserRegistrationService.adoc | 11 +-
.../userreg/events/EmailEventAbstract.adoc | 9 +-
.../userreg/events/EmailRegistrationEvent.adoc | 6 +-
.../userreg/events/PasswordResetEvent.adoc | 6 +-
.../applib/services/wrapper/DisabledException.adoc | 7 +-
.../applib/services/wrapper/HiddenException.adoc | 7 +-
.../applib/services/wrapper/InvalidException.adoc | 7 +-
.../applib/services/wrapper/WrapperFactory.adoc | 39 +-
.../applib/services/wrapper/WrappingObject.adoc | 14 +-
.../services/wrapper/control/AsyncControl.adoc | 12 +-
.../services/wrapper/control/ControlAbstract.adoc | 12 +-
.../services/wrapper/control/ExceptionHandler.adoc | 8 +-
.../wrapper/control/ExceptionHandlerAbstract.adoc | 6 +-
.../services/wrapper/control/ExecutionMode.adoc | 11 +-
.../services/wrapper/control/SyncControl.adoc | 11 +-
.../services/wrapper/events/AccessEvent.adoc | 6 +-
.../wrapper/events/ActionArgumentEvent.adoc | 12 +-
.../wrapper/events/ActionInvocationEvent.adoc | 11 +-
.../wrapper/events/ActionUsabilityEvent.adoc | 6 +-
.../wrapper/events/ActionVisibilityEvent.adoc | 6 +-
.../wrapper/events/CollectionAccessEvent.adoc | 6 +-
.../wrapper/events/CollectionAddToEvent.adoc | 9 +-
.../wrapper/events/CollectionMethodEvent.adoc | 21 +-
.../wrapper/events/CollectionRemoveFromEvent.adoc | 7 +-
.../wrapper/events/CollectionUsabilityEvent.adoc | 6 +-
.../services/wrapper/events/InteractionEvent.adoc | 45 +-
.../services/wrapper/events/ObjectTitleEvent.adoc | 7 +-
.../wrapper/events/ObjectValidityEvent.adoc | 7 +-
.../wrapper/events/ObjectVisibilityEvent.adoc | 6 +-
.../services/wrapper/events/ParseValueEvent.adoc | 10 +-
.../wrapper/events/PropertyAccessEvent.adoc | 7 +-
.../wrapper/events/PropertyModifyEvent.adoc | 9 +-
.../wrapper/events/PropertyUsabilityEvent.adoc | 6 +-
.../wrapper/events/PropertyVisibilityEvent.adoc | 6 +-
.../wrapper/events/ProposedHolderEvent.adoc | 7 +-
.../services/wrapper/events/UsabilityEvent.adoc | 6 +-
.../services/wrapper/events/ValidityEvent.adoc | 8 +-
.../services/wrapper/events/VisibilityEvent.adoc | 6 +-
.../wrapper/listeners/InteractionAdapter.adoc | 21 +-
.../wrapper/listeners/InteractionListener.adoc | 53 +-
.../index/applib/services/xactn/TransactionId.adoc | 6 +-
.../applib/services/xactn/TransactionService.adoc | 17 +-
.../applib/services/xactn/TransactionState.adoc | 34 +-
.../services/xactn/TransactionalProcessor.adoc | 23 +-
.../index/applib/services/xml/XmlService.adoc | 17 +-
.../services/xmlsnapshot/XmlSnapshotService.adoc | 14 +-
.../xmlsnapshot/XmlSnapshotService~Snapshot.adoc | 11 +-
.../XmlSnapshotService~Snapshot~Builder.adoc | 14 +-
.../snapshot/SnapshottableWithInclusions.adoc | 8 +-
.../index/applib/spec/AbstractSpecification.adoc | 8 +-
.../index/applib/spec/AbstractSpecification2.adoc | 9 +-
.../pages/index/applib/spec/Specification.adoc | 8 +-
.../pages/index/applib/spec/Specification2.adoc | 8 +-
.../pages/index/applib/spec/SpecificationAnd.adoc | 7 +-
.../pages/index/applib/spec/SpecificationNot.adoc | 7 +-
.../pages/index/applib/spec/SpecificationOr.adoc | 7 +-
.../pages/index/applib/types/DescriptionType.adoc | 5 +-
.../index/applib/types/MemberIdentifierType.adoc | 5 +-
.../pages/index/applib/types/TargetActionType.adoc | 5 +-
.../pages/index/applib/types/TargetClassType.adoc | 5 +-
.../generated/pages/index/applib/util/Enums.adoc | 11 +-
.../pages/index/applib/util/Equality.adoc | 8 +-
.../generated/pages/index/applib/util/Hashing.adoc | 8 +-
.../pages/index/applib/util/JaxbUtil.adoc | 10 +-
.../pages/index/applib/util/ObjectContracts.adoc | 14 +-
.../pages/index/applib/util/ReasonBuffer.adoc | 19 +-
.../pages/index/applib/util/ReasonBuffer2.adoc | 32 +-
.../generated/pages/index/applib/util/Reasons.adoc | 6 +-
.../pages/index/applib/util/TitleBuffer.adoc | 73 +-
.../index/applib/util/TitleBufferException.adoc | 10 +-
.../pages/index/applib/util/ToString.adoc | 11 +-
.../index/applib/util/schema/ChangesDtoUtils.adoc | 14 +-
.../index/applib/util/schema/CommandDtoUtils.adoc | 21 +-
.../index/applib/util/schema/CommonDtoUtils.adoc | 22 +-
.../applib/util/schema/InteractionDtoUtils.adoc | 36 +-
.../util/schema/MemberExecutionDtoUtils.adoc | 13 +-
.../generated/pages/index/applib/value/Blob.adoc | 23 +-
.../generated/pages/index/applib/value/Clob.adoc | 21 +-
.../pages/index/applib/value/HasHtml.adoc | 6 +-
.../index/applib/value/LocalResourcePath.adoc | 12 +-
.../generated/pages/index/applib/value/Markup.adoc | 16 +-
.../index/applib/value/NamedWithMimeType.adoc | 7 +-
.../pages/index/applib/value/Password.adoc | 8 +-
.../pages/index/commons/collections/Can.adoc | 121 +-
.../index/commons/collections/Cardinality.adoc | 17 +-
.../pages/index/commons/functional/Result.adoc | 29 +-
.../pages/index/commons/having/HasUniqueId.adoc | 8 +-
.../pages/index/commons/having/HasUpdatedAt.adoc | 6 +-
.../pages/index/commons/having/HasUpdatedBy.adoc | 6 +-
.../pages/index/commons/having/HasUsername.adoc | 8 +-
.../commons/resource/ResourceCoordinates.adoc | 7 +-
.../DataSourceIntrospectionService.adoc | 8 +-
...ceptionRecognizerForOtherDataAccessProblem.adoc | 6 +-
.../transaction/TransactionServiceSpring.adoc | 20 +-
.../runtimeservices/xml/XmlServiceDefault.adoc | 9 +-
.../changetracking/EntityChangeTrackerDefault.adoc | 21 +-
.../events/TransactionAfterCompletionEvent.adoc | 18 +-
.../commandlog/impl/CommandSubscriberForJdo.adoc | 7 +-
.../impl/IsisModuleExtCommandLogImpl.adoc | 9 +-
.../impl/mixins/HasUniqueId_command.adoc | 12 +-
.../mixins/HasUsername_recentCommandsByUser.adoc | 9 +-
.../commandlog/impl/ui/CommandServiceMenu.adoc | 16 +-
.../primary/IsisModuleExtCommandReplayPrimary.adoc | 5 +-
.../primary/config/PrimaryConfig.adoc | 8 +-
.../primary/mixins/Object_openOnSecondary.adoc | 10 +-
.../primary/restapi/CommandRetrievalService.adoc | 12 +-
.../primary/ui/CommandReplayOnPrimaryService.adoc | 29 +-
.../IsisModuleExtCommandReplaySecondary.adoc | 12 +-
.../commandreplay/secondary/SecondaryStatus.adoc | 11 +-
.../secondary/analyser/CommandReplayAnalyser.adoc | 8 +-
.../analyser/CommandReplayAnalyserException.adoc | 7 +-
.../analyser/CommandReplayAnalyserResult.adoc | 7 +-
.../analysis/CommandReplayAnalysisService.adoc | 9 +-
.../secondary/clock/TickingClockService.adoc | 14 +-
.../secondary/config/SecondaryConfig.adoc | 14 +-
.../executor/CommandExecutorServiceWithTime.adoc | 12 +-
.../secondary/fetch/CommandFetcher.adoc | 10 +-
.../secondary/job/ReplicateAndReplayJob.adoc | 8 +-
.../secondary/job/SecondaryStatusData.adoc | 9 +-
.../jobcallables/ReplicateAndRunCommands.adoc | 14 +-
.../secondary/mixins/CommandJdo_exclude.adoc | 10 +-
.../secondary/mixins/CommandJdo_replayQueue.adoc | 10 +-
.../secondary/mixins/Object_openOnPrimary.adoc | 10 +-
.../spi/ReplayCommandExecutionController.adoc | 8 +-
.../ui/CommandReplayOnSecondaryService.adoc | 9 +-
.../cors/impl/IsisModuleExtCorsImpl.adoc | 6 +-
.../fullcalendar/applib/CalendarEventable.adoc | 11 +-
.../fullcalendar/applib/Calendarable.adoc | 13 +-
.../applib/IsisModuleExtFullCalendarApplib.adoc | 5 +-
.../spi/CalendarableDereferencingService.adoc | 6 +-
.../fullcalendar/applib/value/CalendarEvent.adoc | 20 +-
.../ui/component/IsisModuleExtFullCalendarUi.adoc | 5 +-
.../hsqldbmgr/dom/IsisModuleExtHsqldbMgr.adoc | 5 +-
.../hsqldbmgr/dom/services/HsqlDbManagerMenu.adoc | 8 +-
.../applib/IsisModuleExtJaxRsClientApplib.adoc | 5 +-
.../jaxrsclient/applib/client/JaxRsClient.adoc | 7 +-
.../jaxrsclient/applib/client/JaxRsResponse.adoc | 7 +-
.../applib/IsisModuleIncModelApplib.adoc | 5 +-
.../modelannotation/applib/annotation/Model.adoc | 5 +-
.../metamodel/IsisModuleExtModelAnnotation.adoc | 5 +-
.../SupportingMethodValidatorRefinerFactory.adoc | 8 +-
.../services/IncubatorMetaModelPlugin.adoc | 6 +-
.../extensions/quartz/IsisModuleExtQuartzImpl.adoc | 5 +-
.../quartz/context/JobExecutionData.adoc | 11 +-
.../spring/AutowiringSpringBeanJobFactory.adoc | 6 +-
.../restclient/ActionParameterListBuilder.adoc | 14 +-
.../restclient/IsisModuleExtRestClient.adoc | 5 +-
.../extensions/restclient/ResponseDigest.adoc | 35 +-
.../index/extensions/restclient/RestfulClient.adoc | 16 +-
.../extensions/restclient/RestfulClientConfig.adoc | 5 +-
.../restclient/RestfulClientException.adoc | 9 +-
.../restclient/auth/BasicAuthFilter.adoc | 9 +-
.../restclient/log/ClientConversationFilter.adoc | 9 +-
.../restclient/log/ClientConversationLogger.adoc | 7 +-
.../secman/api/IsisModuleExtSecmanApi.adoc | 5 +-
.../extensions/secman/api/SecmanConfiguration.adoc | 19 +-
.../index/extensions/secman/api/SecurityRealm.adoc | 6 +-
.../secman/api/SecurityRealmCharacteristic.adoc | 6 +-
.../secman/api/SecurityRealmService.adoc | 6 +-
.../api/encryption/PasswordEncryptionService.adoc | 7 +-
.../encryption/PasswordEncryptionServiceNone.adoc | 7 +-
.../secman/api/events/UserCreatedEvent.adoc | 8 +-
.../api/permission/ApplicationPermission.adoc | 19 +-
.../api/permission/ApplicationPermissionMode.adoc | 14 +-
.../ApplicationPermissionRepository.adoc | 16 +-
.../api/permission/ApplicationPermissionRule.adoc | 12 +-
.../api/permission/ApplicationPermissionValue.adoc | 15 +-
.../permission/ApplicationPermissionValueSet.adoc | 11 +-
.../permission/PermissionsEvaluationService.adoc | 8 +-
.../PermissionsEvaluationServiceAbstract.adoc | 6 +-
...PermissionsEvaluationServiceAllowBeatsVeto.adoc | 5 +-
...PermissionsEvaluationServiceVetoBeatsAllow.adoc | 5 +-
.../secman/api/role/ApplicationRole.adoc | 15 +-
.../secman/api/role/ApplicationRoleRepository.adoc | 21 +-
.../secman/api/tenancy/ApplicationTenancy.adoc | 13 +-
.../api/tenancy/ApplicationTenancyEvaluator.adoc | 10 +-
.../api/tenancy/ApplicationTenancyRepository.adoc | 19 +-
.../extensions/secman/api/tenancy/HasAtPath.adoc | 10 +-
.../extensions/secman/api/user/AccountType.adoc | 10 +-
.../secman/api/user/ApplicationUser.adoc | 41 +-
.../secman/api/user/ApplicationUserRepository.adoc | 26 +-
.../secman/api/user/ApplicationUserStatus.adoc | 10 +-
.../IsisModuleExtSecmanEncryptionJbcrypt.adoc | 5 +-
.../PasswordEncryptionServiceUsingJBcrypt.adoc | 7 +-
.../jdo/IsisModuleExtSecmanPersistenceJdo.adoc | 5 +-
.../secman/jdo/seed/SeedSecurityModuleService.adoc | 7 +-
.../jdo/seed/SeedUsersAndRolesFixtureScript.adoc | 5 +-
.../secman/jdo/seed/scripts/GlobalTenancy.adoc | 7 +-
...xtFixturesFixtureResultsRoleAndPermissions.adoc | 7 +-
.../IsisExtSecmanAdminRoleAndPermissions.adoc | 6 +-
.../jdo/seed/scripts/IsisExtSecmanAdminUser.adoc | 6 +-
.../IsisExtSecmanFixtureRoleAndPermissions.adoc | 6 +-
...IsisExtSecmanRegularUserRoleAndPermissions.adoc | 6 +-
.../jpa/IsisModuleExtSecmanPersistenceJpa.adoc | 5 +-
.../secman/jpa/seed/SeedSecurityModuleService.adoc | 7 +-
.../jpa/seed/SeedUsersAndRolesFixtureScript.adoc | 5 +-
.../secman/jpa/seed/scripts/GlobalTenancy.adoc | 7 +-
...xtFixturesFixtureResultsRoleAndPermissions.adoc | 7 +-
.../IsisExtSecmanAdminRoleAndPermissions.adoc | 6 +-
.../jpa/seed/scripts/IsisExtSecmanAdminUser.adoc | 6 +-
.../IsisExtSecmanFixtureRoleAndPermissions.adoc | 6 +-
...IsisExtSecmanRegularUserRoleAndPermissions.adoc | 6 +-
...tyModuleAppUserRegistrationServiceAbstract.adoc | 9 +-
.../secman/model/IsisModuleExtSecmanModel.adoc | 5 +-
.../secman/model/app/user/MeService.adoc | 7 +-
.../shiro/IsisModuleExtSecmanRealmShiro.adoc | 5 +-
.../shiro/IsisModuleExtSecmanShiroRealm.adoc | 11 +-
.../services/SecurityRealmServiceUsingShiro.adoc | 6 +-
.../extensions/secman/shiro/util/ShiroUtils.adoc | 8 +-
.../realm/impl/IsisLdapContextFactory.adoc | 7 +-
.../shirorealmldap/realm/impl/IsisLdapRealm.adoc | 24 +-
.../impl/IsisModuleExtShiroRealmLdapImpl.adoc | 5 +-
.../ui/IsisModuleExtExcelDownloadUi.adoc | 5 +-
.../ui/components/CollectionContentsAsExcel.adoc | 7 +-
.../CollectionContentsAsExcelFactory.adoc | 10 +-
.../pdfjs/applib/annotations/PdfJsViewer.adoc | 8 +-
.../wicket/pdfjs/applib/config/PdfJsConfig.adoc | 19 +-
.../viewer/wicket/pdfjs/applib/config/Scale.adoc | 20 +-
.../pdfjs/applib/spi/PdfJsViewerAdvisor.adoc | 9 +-
.../wicket/pdfjs/ui/IsisModuleExtPdfjsUi.adoc | 5 +-
.../jdo/applib/IsisModulePersistenceJdoApplib.adoc | 5 +-
.../jdo/applib/integration/JdoSupportService.adoc | 33 +-
.../jdo/datanucleus/IsisModuleJdoDatanucleus.adoc | 22 +-
.../changetracking/JdoLifecycleListener.adoc | 23 +-
.../mixins/Persistable_datanucleusIdLong.adoc | 7 +-
.../mixins/Persistable_datanucleusVersionLong.adoc | 7 +-
.../Persistable_datanucleusVersionTimestamp.adoc | 7 +-
.../mixins/Persistable_downloadJdoMetadata.adoc | 8 +-
.../jdo/datanucleus/schema/JdoSchemaService.adoc | 32 -
.../applib/IsisBookmarkConverter.adoc | 7 +-
.../applib/IsisLocalResourcePathConverter.adoc | 7 +-
.../typeconverters/applib/IsisMarkupConverter.adoc | 7 +-
.../applib/IsisPasswordConverter.adoc | 7 +-
.../JavaAwtBufferedImageByteArrayConverter.adoc | 7 +-
.../schema/v2/IsisChangesDtoConverter.adoc | 7 +-
.../schema/v2/IsisCommandDtoConverter.adoc | 7 +-
.../schema/v2/IsisInteractionDtoConverter.adoc | 7 +-
.../schema/v2/IsisOidDtoConverter.adoc | 7 +-
.../time/IsoOffsetTimeConverter.adoc | 7 +-
.../time/IsoZonedDateTimeConverter.adoc | 7 +-
.../applib/ByteArrayBlobRdbmsMapping.adoc | 7 +-
.../valuetypes/applib/IsisBlobMapping.adoc | 12 +-
.../valuetypes/applib/IsisClobMapping.adoc | 12 +-
.../JpaEntityInjectionPointResolver.adoc | 5 +-
.../jpa/applib/services/JpaSupportService.adoc | 11 +-
.../jpa/eclipselink/IsisModuleJpaEclipselink.adoc | 7 +-
.../pages/index/schema/IsisModuleSchema.adoc | 5 +-
.../security/bypass/IsisModuleSecurityBypass.adoc | 5 +-
.../bypass/authentication/AuthenticatorBypass.adoc | 7 +-
.../bypass/authorization/AuthorizorBypass.adoc | 9 +-
.../keycloak/IsisModuleSecurityKeycloak.adoc | 5 +-
.../authentication/AuthenticatorKeycloak.adoc | 8 +-
.../keycloak/authorization/AuthorizorKeycloak.adoc | 9 +-
.../keycloak/webmodule/KeycloakFilter.adoc | 8 +-
.../keycloak/webmodule/WebModuleKeycloak.adoc | 7 +-
.../security/shiro/IsisModuleSecurityShiro.adoc | 5 +-
.../shiro/authentication/AuthenticatorShiro.adoc | 10 +-
.../shiro/authorization/AuthorizorShiro.adoc | 13 +-
.../shiro/authorization/IsisPermission.adoc | 13 +-
.../authorization/IsisPermissionResolver.adoc | 7 +-
.../security/shiro/webmodule/WebModuleShiro.adoc | 10 +-
.../index/subdomains/base/applib/Chained.adoc | 11 +-
.../pages/index/subdomains/base/applib/Dflt.adoc | 6 +-
.../applib/IsisModuleSubdomainsBaseApplib.adoc | 5 +-
.../index/subdomains/base/applib/PowerType.adoc | 6 +-
.../pages/index/subdomains/base/applib/Titled.adoc | 6 +-
.../index/subdomains/base/applib/TitledEnum.adoc | 5 +-
.../base/applib/services/BaseServicesModule.adoc | 5 +-
.../applib/services/calendar/CalendarService.adoc | 14 +-
.../base/applib/types/DescriptionType.adoc | 5 +-
.../subdomains/base/applib/types/FqcnType.adoc | 5 +-
.../subdomains/base/applib/types/MoneyType.adoc | 5 +-
.../subdomains/base/applib/types/NameType.adoc | 5 +-
.../subdomains/base/applib/types/NotesType.adoc | 5 +-
.../base/applib/types/ObjectIdentifierType.adoc | 5 +-
.../base/applib/types/PercentageType.adoc | 5 +-
.../base/applib/types/ProperNameType.adoc | 5 +-
.../base/applib/types/ReferenceType.adoc | 5 +-
.../subdomains/base/applib/types/TitleType.adoc | 5 +-
.../base/applib/types/UrlTemplateType.adoc | 5 +-
.../subdomains/base/applib/types/UserNameType.adoc | 5 +-
.../subdomains/base/applib/types/XxxType.adoc | 5 +-
.../subdomains/base/applib/utils/ClassUtils.adoc | 6 +-
.../base/applib/utils/JodaPeriodUtils.adoc | 8 +-
.../subdomains/base/applib/utils/MathUtils.adoc | 11 +-
.../subdomains/base/applib/utils/MessageUtils.adoc | 6 +-
.../subdomains/base/applib/utils/StringUtils.adoc | 10 +-
.../subdomains/base/applib/utils/TitleBuilder.adoc | 16 +-
.../base/applib/valuetypes/AbstractInterval.adoc | 36 +-
.../base/applib/valuetypes/LocalDateInterval.adoc | 21 +-
.../subdomains/base/applib/valuetypes/VT.adoc | 37 +-
.../base/applib/with/WithCodeComparable.adoc | 6 +-
.../base/applib/with/WithCodeGetter.adoc | 6 +-
.../base/applib/with/WithCodeUnique.adoc | 5 +-
.../applib/with/WithDescriptionComparable.adoc | 6 +-
.../base/applib/with/WithDescriptionGetter.adoc | 6 +-
.../base/applib/with/WithDescriptionUnique.adoc | 5 +-
.../subdomains/base/applib/with/WithInterval.adoc | 16 +-
.../base/applib/with/WithIntervalContiguous.adoc | 14 +-
.../base/applib/with/WithIntervalMutable.adoc | 9 +-
.../base/applib/with/WithNameComparable.adoc | 6 +-
.../base/applib/with/WithNameGetter.adoc | 6 +-
.../base/applib/with/WithNameUnique.adoc | 5 +-
.../base/applib/with/WithReferenceComparable.adoc | 6 +-
.../base/applib/with/WithReferenceGetter.adoc | 6 +-
.../base/applib/with/WithReferenceUnique.adoc | 5 +-
.../subdomains/base/applib/with/WithSequence.adoc | 7 +-
.../subdomains/base/applib/with/WithStartDate.adoc | 7 +-
.../base/applib/with/WithTitleComparable.adoc | 6 +-
.../base/applib/with/WithTitleGetter.adoc | 6 +-
.../base/applib/with/WithTitleUnique.adoc | 5 +-
.../applib/IsisModuleSubdomainsExcelApplib.adoc | 5 +-
.../excel/applib/dom/AggregationType.adoc | 7 +-
.../excel/applib/dom/ExcelMetaDataEnabled.adoc | 7 +-
.../subdomains/excel/applib/dom/ExcelService.adoc | 28 +-
.../subdomains/excel/applib/dom/HyperLink.adoc | 5 +-
.../subdomains/excel/applib/dom/PivotColumn.adoc | 6 +-
.../excel/applib/dom/PivotDecoration.adoc | 6 +-
.../subdomains/excel/applib/dom/PivotRow.adoc | 5 +-
.../subdomains/excel/applib/dom/PivotValue.adoc | 7 +-
.../subdomains/excel/applib/dom/RowHandler.adoc | 6 +-
.../excel/applib/dom/WorksheetContent.adoc | 8 +-
.../subdomains/excel/applib/dom/WorksheetSpec.adoc | 17 +-
.../excel/applib/dom/util/AnnotationList.adoc | 8 +-
.../excel/applib/dom/util/AnnotationTriplet.adoc | 9 +-
.../applib/dom/util/ExcelFileBlobConverter.adoc | 7 +-
.../excel/applib/dom/util/ExcelServiceImpl.adoc | 42 +-
.../subdomains/excel/applib/dom/util/Mode.adoc | 11 +-
.../excel/applib/dom/util/PivotUtils.adoc | 11 +-
.../excel/applib/dom/util/SheetPivoter.adoc | 13 +-
.../subdomains/excel/testing/ExcelFixture.adoc | 13 +-
.../subdomains/excel/testing/ExcelFixture2.adoc | 12 +-
.../excel/testing/ExcelFixtureRowHandler.adoc | 6 +-
.../excel/testing/ExcelFixtureWorkbookHandler.adoc | 6 +-
.../excel/testing/FixtureAwareRowHandler.adoc | 7 +-
.../testing/IsisModuleSubdomainsExcelTesting.adoc | 5 +-
.../applib/IsisModuleSubdomainsSpringApplib.adoc | 5 +-
.../spring/applib/service/BeanDescriptor.adoc | 7 +-
.../spring/applib/service/ContextBeans.adoc | 6 +-
.../spring/applib/service/SpringBeansService.adoc | 7 +-
.../IsisModuleSubdomainsXDocReportApplib.adoc | 5 +-
.../xdocreport/applib/service/OutputType.adoc | 7 +-
.../xdocreport/applib/service/XDocReportModel.adoc | 6 +-
.../applib/service/XDocReportService.adoc | 8 +-
.../applib/IsisModuleTestingFakeDataApplib.adoc | 5 +-
.../services/AbstractRandomValueGenerator.adoc | 7 +-
.../fakedata/applib/services/Addresses.adoc | 20 +-
.../fakedata/applib/services/BigDecimals.adoc | 8 +-
.../fakedata/applib/services/BigIntegers.adoc | 7 +-
.../testing/fakedata/applib/services/Books.adoc | 9 +-
.../testing/fakedata/applib/services/Booleans.adoc | 14 +-
.../testing/fakedata/applib/services/Bytes.adoc | 9 +-
.../testing/fakedata/applib/services/Chars.adoc | 10 +-
.../fakedata/applib/services/Collections.adoc | 39 +-
.../testing/fakedata/applib/services/Comms.adoc | 11 +-
.../fakedata/applib/services/CreditCards.adoc | 9 +-
.../testing/fakedata/applib/services/Doubles.adoc | 8 +-
.../testing/fakedata/applib/services/Enums.adoc | 7 +-
.../fakedata/applib/services/FakeDataService.adoc | 51 +-
.../testing/fakedata/applib/services/Floats.adoc | 7 +-
.../testing/fakedata/applib/services/Integers.adoc | 9 +-
.../fakedata/applib/services/IsisBlobs.adoc | 9 +-
.../fakedata/applib/services/IsisClobs.adoc | 9 +-
.../fakedata/applib/services/IsisPasswords.adoc | 7 +-
.../fakedata/applib/services/J8DateTimes.adoc | 10 +-
.../fakedata/applib/services/J8LocalDates.adoc | 10 +-
.../fakedata/applib/services/J8Periods.adoc | 12 +-
.../fakedata/applib/services/JavaSqlDates.adoc | 7 +-
.../applib/services/JavaSqlTimestamps.adoc | 7 +-
.../fakedata/applib/services/JavaUtilDates.adoc | 7 +-
.../fakedata/applib/services/JodaDateTimes.adoc | 10 +-
.../fakedata/applib/services/JodaLocalDates.adoc | 10 +-
.../fakedata/applib/services/JodaPeriods.adoc | 12 +-
.../testing/fakedata/applib/services/Longs.adoc | 7 +-
.../testing/fakedata/applib/services/Lorem.adoc | 14 +-
.../testing/fakedata/applib/services/Names.adoc | 12 +-
.../testing/fakedata/applib/services/Shorts.adoc | 9 +-
.../testing/fakedata/applib/services/Strings.adoc | 9 +-
.../testing/fakedata/applib/services/Urls.adoc | 7 +-
.../testing/fakedata/applib/services/Uuids.adoc | 7 +-
.../h2console/ui/IsisModuleTestingH2ConsoleUi.adoc | 5 +-
.../h2console/ui/services/H2ManagerMenu.adoc | 8 +-
.../h2console/ui/webmodule/WebModuleH2Console.adoc | 8 +-
.../applib/ExceptionRecognizerTranslate.adoc | 6 +-
.../applib/IsisIntegrationTestAbstract.adoc | 5 +-
.../applib/IsisInteractionHandler.adoc | 7 +-
.../integtestsupport/applib/ThrowableMatchers.adoc | 9 +-
.../applib/swagger/SwaggerExporter.adoc | 10 +-
.../applib/validate/DomainModelValidator.adoc | 19 +-
.../applib/IsisModuleTestingSpecSupportApplib.adoc | 5 +-
.../integration/ObjectFactoryForIntegration.adoc | 9 +-
.../index/testing/specsupport/applib/specs/V.adoc | 5 +-
.../IsisModuleTestingUnitTestSupportApplib.adoc | 5 +-
.../applib/bean/AbstractBeanPropertiesTest.adoc | 6 +-
.../bean/FixtureDatumFactoriesForAnyPojo.adoc | 7 +-
.../bean/FixtureDatumFactoriesForApplib.adoc | 7 +-
.../applib/bean/FixtureDatumFactoriesForJoda.adoc | 8 +-
.../applib/bean/FixtureDatumFactoriesForTime.adoc | 9 +-
.../unittestsupport/applib/bean/PojoTester.adoc | 12 +-
.../core/AbstractApplyToAllContractTest.adoc | 8 +-
...irectionalRelationshipContractTestAbstract.adoc | 6 +-
.../applib/core/bidir/Instantiator.adoc | 7 +-
.../applib/core/bidir/InstantiatorSimple.adoc | 8 +-
.../applib/core/bidir/Instantiators.adoc | 6 +-
.../ComparableContractTest_compareTo.adoc | 6 +-
.../core/comparable/ComparableContractTester.adoc | 12 +-
.../unittestsupport/applib/core/files/Files.adoc | 17 +-
.../applib/core/jaxb/JaxbMatchers.adoc | 8 +-
.../applib/core/jmocking/Imposterisers.adoc | 8 +-
.../core/jmocking/InjectIntoJMockAction.adoc | 10 +-
.../applib/core/jmocking/IsisActions.adoc | 9 +-
.../applib/core/jmocking/JMockActions.adoc | 7 +-
.../applib/core/jmocking/JUnitRuleMockery2.adoc | 27 +-
.../applib/core/jmocking/PostponedAction.adoc | 7 +-
.../core/soap/SoapEndpointPublishingRule.adoc | 16 +-
.../applib/core/soap/SoapEndpointSpec.adoc | 16 +-
.../sortedsets/SortedSetsContractTestAbstract.adoc | 5 +-
.../applib/core/streams/NullPrintStream.adoc | 12 +-
.../applib/core/utils/CollectUtils.adoc | 6 +-
.../applib/core/utils/IndentPrinter.adoc | 37 +-
.../applib/core/utils/ReflectUtils.adoc | 10 +-
.../applib/core/utils/StringUtils.adoc | 7 +-
.../core/value/ValueTypeContractTestAbstract.adoc | 11 +-
.../applib/dom/assertions/Asserting.adoc | 6 +-
.../applib/dom/matchers/IsisMatchers.adoc | 22 +-
.../dom/privatecons/PrivateConstructorTester.adoc | 7 +-
.../applib/dom/reflect/ReflectUtils.adoc | 7 +-
.../applib/dom/repo/FinderInteraction.adoc | 12 +-
.../applib/IsisModuleValAsciidocApplib.adoc | 5 +-
.../asciidoc/applib/jaxb/AsciiDocJaxbAdapter.adoc | 7 +-
.../valuetypes/asciidoc/applib/value/AsciiDoc.adoc | 15 +-
.../metamodel/IsisModuleValAsciidocMetaModel.adoc | 5 +-
.../IsisModuleValAsciidocPersistenceJdoDn5.adoc | 5 +-
.../jdo/dn5/converters/IsisAsciiDocConverter.adoc | 7 +-
.../ui/wkt/IsisModuleValAsciidocUiWkt.adoc | 5 +-
.../applib/IsisModuleValMarkdownApplib.adoc | 5 +-
.../markdown/applib/jaxb/MarkdownJaxbAdapter.adoc | 7 +-
.../markdown/applib/value/Converter.adoc | 8 +-
.../metamodel/IsisModuleValMarkdownMetaModel.adoc | 5 +-
.../IsisModuleValMarkdownPersistenceJdoDn5.adoc | 5 +-
.../jdo/dn5/converters/IsisMarkdownConverter.adoc | 7 +-
.../ui/wkt/IsisModuleValMarkdownUiWkt.adoc | 5 +-
.../sse/applib/IsisModuleValSseApplib.adoc | 5 +-
.../sse/applib/annotations/ServerSentEvents.adoc | 6 +-
.../sse/applib/annotations/SseSource.adoc | 8 +-
.../valuetypes/sse/applib/service/SseChannel.adoc | 11 +-
.../valuetypes/sse/applib/service/SseService.adoc | 7 +-
.../sse/ui/wkt/IsisModuleValSseUiWkt.adoc | 5 +-
.../sse/ui/wkt/services/SseServiceDefault.adoc | 7 +-
.../wkt/webmodule/WebModuleServerSentEvents.adoc | 7 +-
.../IsisModuleViewerRestfulObjectsApplib.adoc | 5 +-
.../restfulobjects/applib/JsonRepresentation.adoc | 212 +-
.../restfulobjects/applib/LinkRepresentation.adoc | 24 +-
.../index/viewer/restfulobjects/applib/Rel.adoc | 51 +-
.../restfulobjects/applib/RelDefinition.adoc | 16 +-
.../restfulobjects/applib/RepresentationType.adoc | 54 +-
.../restfulobjects/applib/RestfulHttpMethod.adoc | 9 +-
.../restfulobjects/applib/RestfulMediaType.adoc | 36 +-
.../restfulobjects/applib/RestfulRequest.adoc | 7 +-
.../restfulobjects/applib/RestfulResponse.adoc | 14 +-
.../applib/boot/BootstrapResource.adoc | 6 +-
.../AbstractObjectMemberRepresentation.adoc | 10 +-
.../domainobjects/ActionResultRepresentation.adoc | 8 +-
.../DomainObjectMemberRepresentation.adoc | 16 +-
.../domainobjects/DomainObjectRepresentation.adoc | 29 +-
.../applib/domainobjects/DomainObjectResource.adoc | 28 +-
.../applib/domainobjects/DomainRepresentation.adoc | 11 +-
.../domainobjects/DomainServiceResource.adoc | 23 +-
.../applib/domainobjects/ListRepresentation.adoc | 8 +-
.../domainobjects/ObjectActionRepresentation.adoc | 7 +-
.../ObjectCollectionRepresentation.adoc | 7 +-
.../ObjectPropertyRepresentation.adoc | 6 +-
.../domainobjects/ScalarValueRepresentation.adoc | 7 +-
.../AbstractTypeMemberRepresentation.adoc | 6 +-
.../ActionDescriptionRepresentation.adoc | 7 +-
.../ActionParameterDescriptionRepresentation.adoc | 6 +-
.../CollectionDescriptionRepresentation.adoc | 6 +-
.../domaintypes/DomainTypeRepresentation.adoc | 6 +-
.../applib/domaintypes/DomainTypeResource.adoc | 14 +-
.../PropertyDescriptionRepresentation.adoc | 6 +-
.../TypeActionResultRepresentation.adoc | 6 +-
.../applib/domaintypes/TypeListRepresentation.adoc | 6 +-
.../applib/dtos/ScalarValueDtoV2.adoc | 8 +-
.../applib/errors/ErrorRepresentation.adoc | 6 +-
.../applib/health/HealthRepresentation.adoc | 7 +-
.../applib/health/HealthResource.adoc | 9 +-
.../applib/homepage/HomePageRepresentation.adoc | 9 +-
.../applib/homepage/HomePageResource.adoc | 12 +-
.../applib/menubars/MenuBarsResource.adoc | 17 +-
.../applib/user/UserRepresentation.adoc | 11 +-
.../restfulobjects/applib/user/UserResource.adoc | 12 +-
.../restfulobjects/applib/util/JsonMapper.adoc | 14 +-
.../restfulobjects/applib/util/JsonNodeUtils.adoc | 10 +-
.../restfulobjects/applib/util/MediaTypes.adoc | 8 +-
.../viewer/restfulobjects/applib/util/Parser.adoc | 20 +-
.../restfulobjects/applib/util/PathNode.adoc | 15 +-
.../applib/util/UrlEncodingUtils.adoc | 12 +-
.../applib/version/VersionRepresentation.adoc | 8 +-
.../applib/version/VersionResource.adoc | 9 +-
...isModuleViewerRestfulObjectsJaxrsResteasy4.adoc | 5 +-
.../conneg/RestfulObjectsJaxbWriterForXml.adoc | 5 +-
.../webmodule/WebModuleJaxrsResteasy4.adoc | 8 +-
.../IsisModuleRestfulObjectsRendering.adoc | 5 +-
.../rendering/service/RepresentationService.adoc | 10 +-
.../RepresentationServiceContentNegotiator.adoc | 14 +-
.../acceptheader/AcceptHeaderServiceForRest.adoc | 6 +-
.../service/conneg/ContentNegotiationService.adoc | 10 +-
.../conneg/ContentNegotiationServiceAbstract.adoc | 10 +-
...entNegotiationServiceForRestfulObjectsV1_0.adoc | 20 +-
.../ContentNegotiationServiceOrgApacheIsisV1.adoc | 11 +-
.../ContentNegotiationServiceOrgApacheIsisV2.adoc | 27 +-
.../ContentNegotiationServiceXRoDomainType.adoc | 22 +-
.../service/swagger/SwaggerServiceMenu.adoc | 14 +-
.../IsisModuleViewerRestfulObjectsViewer.adoc | 5 +-
.../wicket/model/IsisModuleViewerWicketModel.adoc | 5 +-
.../viewer/wicket/ui/IsisModuleViewerWicketUi.adoc | 5 +-
.../viewer/IsisModuleViewerWicketViewer.adoc | 5 +-
.../modules/generated/pages/system-overview.adoc | 7890 +++++++++-----------
api/adoc/userguide/modules/ROOT/pages/about.adoc | 2 +-
.../btb/pages/programming-model/finetuning.adoc | 6 +-
.../fun/pages/concepts-patterns/core-values.adoc | 2 +-
.../fun/pages/concepts-patterns/metamodel.adoc | 2 +-
.../modules/fun/pages/object-members.adoc | 6 +-
.../modules/fun/pages/object-members/actions.adoc | 4 +-
.../fun/pages/object-members/collections.adoc | 4 +-
api/adoc/userguide/modules/fun/pages/overview.adoc | 2 +-
.../modules/fun/pages/overview/business-rules.adoc | 8 +-
.../modules/fun/pages/overview/modules.adoc | 2 +-
.../modules/fun/pages/overview/object-members.adoc | 14 +-
api/adoc/userguide/modules/fun/pages/ui.adoc | 2 +-
.../modules/fun/pages/ui/action-icons-and-css.adoc | 6 +-
.../fun/pages/ui/names-and-descriptions.adoc | 2 +-
.../modules/fun/pages/ui/object-layout.adoc | 16 +-
.../fun/pages/ui/object-titles-and-icons.adoc | 4 +-
.../modules/fun/pages/view-models/UNUSED-dto.adoc | 2 +-
.../userguide/modules/fun/partials/module-nav.adoc | 2 +-
.../MemberOrder/sequence.adoc | 2 +-
.../ParameterLayout/describedAs.adoc | 2 +-
.../main/adoc/modules/applib-ant/pages/Action.adoc | 3 +-
.../modules/applib-ant/pages/ActionLayout.adoc | 3 +-
.../adoc/modules/applib-ant/pages/Collection.adoc | 3 +-
.../modules/applib-ant/pages/CollectionLayout.adoc | 4 +-
.../main/adoc/modules/applib-ant/pages/Column.adoc | 2 +-
.../main/adoc/modules/applib-ant/pages/Digits.adoc | 2 +-
.../modules/applib-ant/pages/Discriminator.adoc | 2 +-
.../modules/applib-ant/pages/DomainObject.adoc | 5 +-
.../applib-ant/pages/DomainObjectLayout.adoc | 3 +-
.../modules/applib-ant/pages/DomainService.adoc | 2 +-
.../applib-ant/pages/DomainServiceLayout.adoc | 3 +-
.../main/adoc/modules/applib-ant/pages/Facets.adoc | 3 +-
.../adoc/modules/applib-ant/pages/HomePage.adoc | 3 +-
.../modules/applib-ant/pages/InteractionScope.adoc | 3 +-
.../adoc/modules/applib-ant/pages/MemberOrder.adoc | 7 +-
.../adoc/modules/applib-ant/pages/MinLength.adoc | 3 +-
.../modules/applib-ant/pages/NotPersistent.adoc | 2 +-
.../adoc/modules/applib-ant/pages/Nullable.adoc | 2 +-
.../adoc/modules/applib-ant/pages/Parameter.adoc | 3 +-
.../modules/applib-ant/pages/ParameterLayout.adoc | 3 +-
.../adoc/modules/applib-ant/pages/Pattern.adoc | 2 +-
.../applib-ant/pages/PersistenceCapable.adoc | 2 +-
.../adoc/modules/applib-ant/pages/PrimaryKey.adoc | 2 +-
.../modules/applib-ant/pages/Programmatic.adoc | 3 +-
.../adoc/modules/applib-ant/pages/Property.adoc | 3 +-
.../modules/applib-ant/pages/PropertyLayout.adoc | 3 +-
.../main/adoc/modules/applib-ant/pages/Title.adoc | 3 +-
.../applib-ant/pages/XmlJavaTypeAdapter.adoc | 2 +-
.../adoc/modules/applib-ant/pages/about/main.adoc | 4 +-
.../adoc/modules/applib-ant/pages/about/other.adoc | 2 +-
.../applib-classes/pages/layout/object-layout.adoc | 4 +-
.../roles-mixins-contributees/mixins/Dto.adoc | 2 +-
.../pages/utility/ObjectContracts.adoc | 2 +-
.../modules/applib-methods/pages/prefixes.adoc | 2 +-
.../pages/reserved/deprecated/disable.adoc | 4 +-
.../pages/reserved/deprecated/hide.adoc | 6 +-
.../applib-svc/pages/AcceptHeaderService.adoc | 35 +-
.../hooks/introductory_notes.adoc | 20 +-
.../pages/AcceptHeaderService/hooks/see_also.adoc | 4 +
.../pages/ApplicationFeatureRepository.adoc | 16 +-
.../hooks/introductory_notes.adoc | 3 +
.../hooks/see_also.adoc | 21 +-
.../hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 5 +
.../modules/applib-svc/pages/BookmarkService.adoc | 43 +-
.../BookmarkService/hooks/introductory_notes.adoc | 8 +
.../pages/BookmarkService/hooks/see_also.adoc | 11 +-
.../pages/BookmarkService/hooks/usage_notes.adoc | 25 +-
.../pages/BookmarkService/implementation.adoc | 7 +
.../applib-svc/pages/BookmarkUiService.adoc | 8 +-
.../hooks/introductory_notes.adoc | 3 +
.../pages/BookmarkUiService/hooks/see_also.adoc | 4 +
.../pages/BookmarkUiService/hooks/usage_notes.adoc | 4 +
.../pages/BookmarkUiService/implementation.adoc | 5 +
.../modules/applib-svc/pages/ClockService.adoc | 25 +-
.../ClockService/hooks/introductory_notes.adoc | 11 -
.../pages/ClockService/hooks/usage_notes.adoc | 17 +
.../pages/ClockService/implementation.adoc | 6 +
.../pages/CommandDtoProcessorService.adoc | 22 +-
.../CommandDtoProcessorService/hooks/see_also.adoc | 5 +
.../hooks/usage_notes.adoc | 16 +-
.../implementation.adoc | 0
.../applib-svc/pages/CommandExecutorService.adoc | 3 +-
.../hooks/introductory_notes.adoc | 3 +
.../CommandExecutorService/hooks/see_also.adoc | 4 +
.../implementation.adoc | 0
.../applib-svc/pages/CommandSubscriber.adoc | 3 +-
.../hooks/introductory_notes.adoc | 3 +
.../pages/CommandSubscriber/hooks/see_also.adoc | 4 +
.../pages/CommandSubscriber/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../applib-svc/pages/ConfigurationMenu.adoc | 3 +-
.../hooks/introductory_notes.adoc | 3 +
.../pages/ConfigurationMenu/hooks/see_also.adoc | 4 +
.../pages/ConfigurationMenu/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../applib-svc/pages/ConfigurationViewService.adoc | 3 +-
.../hooks/introductory_notes.adoc | 3 +
.../ConfigurationViewService/hooks/see_also.adoc | 4 +
.../hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../applib-svc/pages/ContentMappingService.adoc | 3 +-
.../hooks/introductory_notes.adoc | 3 +
.../ContentMappingService/hooks/see_also.adoc | 4 +
.../ContentMappingService/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../modules/applib-svc/pages/DeepLinkService.adoc | 3 +-
.../DeepLinkService/hooks/introductory_notes.adoc | 3 +
.../pages/DeepLinkService/hooks/see_also.adoc | 4 +
.../pages/DeepLinkService/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../applib-svc/pages/EmailNotificationService.adoc | 3 +-
.../hooks/introductory_notes.adoc | 3 +
.../EmailNotificationService/hooks/see_also.adoc | 4 +
.../hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../modules/applib-svc/pages/EmailService.adoc | 3 +-
.../EmailService/hooks/introductory_notes.adoc | 3 +
.../pages/EmailService/hooks/see_also.adoc | 4 +
.../pages/EmailService/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../applib-svc/pages/ErrorReportingService.adoc | 3 +-
.../hooks/introductory_notes.adoc | 3 +
.../ErrorReportingService/hooks/see_also.adoc | 4 +
.../ErrorReportingService/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../modules/applib-svc/pages/EventBusService.adoc | 7 +-
.../EventBusService/hooks/introductory_notes.adoc | 3 +
.../pages/EventBusService/hooks/see_also.adoc | 4 +
.../pages/EventBusService/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../applib-svc/pages/ExceptionRecognizer.adoc | 3 +-
.../hooks/introductory_notes.adoc | 3 +
.../pages/ExceptionRecognizer/hooks/see_also.adoc | 4 +
.../ExceptionRecognizer/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../pages/ExceptionRecognizerService.adoc | 3 +-
.../hooks/introductory_notes.adoc | 3 +
.../ExceptionRecognizerService/hooks/see_also.adoc | 4 +
.../hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../applib-svc/pages/ExecutionSubscriber.adoc | 3 +-
.../hooks/introductory_notes.adoc | 3 +
.../pages/ExecutionSubscriber/hooks/see_also.adoc | 4 +
.../ExecutionSubscriber/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../modules/applib-svc/pages/FactoryService.adoc | 3 +-
.../FactoryService/hooks/introductory_notes.adoc | 3 +
.../pages/FactoryService/hooks/see_also.adoc | 4 +
.../pages/FactoryService/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../applib-svc/pages/GridLoaderService.adoc | 3 +-
.../hooks/introductory_notes.adoc | 3 +
.../pages/GridLoaderService/hooks/see_also.adoc | 4 +
.../pages/GridLoaderService/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../adoc/modules/applib-svc/pages/GridService.adoc | 9 +-
.../GridService/hooks/introductory_notes.adoc | 3 +
.../pages/GridService/hooks/see_also.adoc | 4 +
.../pages/GridService/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../applib-svc/pages/GridSystemService.adoc | 11 +-
.../hooks/introductory_notes.adoc | 3 +
.../pages/GridSystemService/hooks/see_also.adoc | 4 +
.../pages/GridSystemService/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../applib-svc/pages/HealthCheckService.adoc | 3 +-
.../hooks/introductory_notes.adoc | 3 +
.../pages/HealthCheckService/hooks/see_also.adoc | 4 +
.../HealthCheckService/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../adoc/modules/applib-svc/pages/HintStore.adoc | 3 +-
.../pages/HintStore/hooks/introductory_notes.adoc | 3 +
.../applib-svc/pages/HintStore/hooks/see_also.adoc | 4 +
.../pages/HintStore/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../applib-svc/pages/HomePageResolverService.adoc | 3 +-
.../hooks/introductory_notes.adoc | 3 +
.../HomePageResolverService/hooks/see_also.adoc | 4 +
.../HomePageResolverService/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../applib-svc/pages/InteractionContext.adoc | 3 +-
.../hooks/introductory_notes.adoc | 3 +
.../pages/InteractionContext/hooks/see_also.adoc | 4 +
.../InteractionContext/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../adoc/modules/applib-svc/pages/JaxbService.adoc | 3 +-
.../JaxbService/hooks/introductory_notes.adoc | 3 +
.../pages/JaxbService/hooks/see_also.adoc | 4 +
.../pages/JaxbService/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../modules/applib-svc/pages/LayoutService.adoc | 7 +-
.../LayoutService/hooks/introductory_notes.adoc | 3 +
.../pages/LayoutService/hooks/see_also.adoc | 4 +
.../pages/LayoutService/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../applib-svc/pages/LayoutServiceMenu.adoc | 3 +-
.../hooks/introductory_notes.adoc | 3 +
.../pages/LayoutServiceMenu/hooks/see_also.adoc | 4 +
.../pages/LayoutServiceMenu/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../modules/applib-svc/pages/LocaleProvider.adoc | 4 +-
.../LocaleProvider/hooks/introductory_notes.adoc | 3 +
.../pages/LocaleProvider/hooks/see_also.adoc | 4 +
.../pages/LocaleProvider/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../applib-svc/pages/MenuBarsLoaderService.adoc | 3 +-
.../hooks/introductory_notes.adoc | 3 +
.../MenuBarsLoaderService/hooks/see_also.adoc | 4 +
.../MenuBarsLoaderService/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../modules/applib-svc/pages/MenuBarsService.adoc | 3 +-
.../MenuBarsService/hooks/introductory_notes.adoc | 3 +
.../pages/MenuBarsService/hooks/see_also.adoc | 4 +
.../pages/MenuBarsService/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../modules/applib-svc/pages/MessageService.adoc | 4 +-
.../MessageService/hooks/introductory_notes.adoc | 3 +
.../pages/MessageService/hooks/see_also.adoc | 4 +
.../pages/MessageService/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../modules/applib-svc/pages/MetaModelService.adoc | 5 +-
.../MetaModelService/hooks/introductory_notes.adoc | 3 +
.../pages/MetaModelService/hooks/see_also.adoc | 4 +
.../pages/MetaModelService/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../applib-svc/pages/MetaModelServiceMenu.adoc | 3 +-
.../hooks/introductory_notes.adoc | 3 +
.../pages/MetaModelServiceMenu/hooks/see_also.adoc | 4 +
.../MetaModelServiceMenu/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../modules/applib-svc/pages/MetricsService.adoc | 4 +-
.../MetricsService/hooks/introductory_notes.adoc | 3 +
.../pages/MetricsService/hooks/see_also.adoc | 4 +
.../pages/MetricsService/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../applib-svc/pages/QueryResultsCache.adoc | 1 +
.../hooks/introductory_notes.adoc | 3 +
.../pages/QueryResultsCache/hooks/see_also.adoc | 4 +
.../pages/QueryResultsCache/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../applib-svc/pages/QueryResultsCacheControl.adoc | 3 +-
.../hooks/introductory_notes.adoc | 3 +
.../QueryResultsCacheControl/hooks/see_also.adoc | 4 +
.../hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../applib-svc/pages/RepositoryService.adoc | 1 +
.../hooks/introductory_notes.adoc | 3 +
.../pages/RepositoryService/hooks/see_also.adoc | 4 +
.../pages/RepositoryService/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../modules/applib-svc/pages/RoutingService.adoc | 1 +
.../RoutingService/hooks/introductory_notes.adoc | 3 +
.../pages/RoutingService/hooks/see_also.adoc | 4 +
.../pages/RoutingService/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../adoc/modules/applib-svc/pages/Scratchpad.adoc | 1 +
.../pages/Scratchpad/hooks/introductory_notes.adoc | 3 +
.../pages/Scratchpad/hooks/see_also.adoc | 4 +
.../pages/Scratchpad/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../modules/applib-svc/pages/ServiceInjector.adoc | 3 +-
.../ServiceInjector/hooks/introductory_notes.adoc | 3 +
.../pages/ServiceInjector/hooks/see_also.adoc | 4 +
.../pages/ServiceInjector/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../modules/applib-svc/pages/ServiceRegistry.adoc | 3 +-
.../ServiceRegistry/hooks/introductory_notes.adoc | 3 +
.../pages/ServiceRegistry/hooks/see_also.adoc | 4 +
.../pages/ServiceRegistry/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../applib-svc/pages/SessionLoggingService.adoc | 3 +-
.../hooks/introductory_notes.adoc | 3 +
.../SessionLoggingService/hooks/see_also.adoc | 4 +
.../SessionLoggingService/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../adoc/modules/applib-svc/pages/SudoService.adoc | 3 +-
.../SudoService/hooks/introductory_notes.adoc | 3 +
.../pages/SudoService/hooks/see_also.adoc | 4 +
.../pages/SudoService/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../modules/applib-svc/pages/SwaggerService.adoc | 11 +-
.../SwaggerService/hooks/introductory_notes.adoc | 3 +
.../pages/SwaggerService/hooks/see_also.adoc | 4 +
.../pages/SwaggerService/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../applib-svc/pages/TableColumnOrderService.adoc | 3 +-
.../hooks/introductory_notes.adoc | 3 +
.../TableColumnOrderService/hooks/see_also.adoc | 4 +
.../TableColumnOrderService/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../modules/applib-svc/pages/TitleService.adoc | 3 +-
.../TitleService/hooks/introductory_notes.adoc | 3 +
.../pages/TitleService/hooks/see_also.adoc | 4 +
.../pages/TitleService/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../applib-svc/pages/TransactionService.adoc | 3 +-
.../hooks/introductory_notes.adoc | 3 +
.../pages/TransactionService/hooks/see_also.adoc | 4 +
.../TransactionService/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../applib-svc/pages/TranslationService.adoc | 3 +-
.../hooks/introductory_notes.adoc | 3 +
.../pages/TranslationService/hooks/see_also.adoc | 4 +
.../TranslationService/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../applib-svc/pages/TranslationsResolver.adoc | 3 +-
.../hooks/introductory_notes.adoc | 3 +
.../pages/TranslationsResolver/hooks/see_also.adoc | 4 +
.../TranslationsResolver/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../applib-svc/pages/UrlEncodingService.adoc | 3 +-
.../hooks/introductory_notes.adoc | 3 +
.../pages/UrlEncodingService/hooks/see_also.adoc | 4 +
.../UrlEncodingService/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../applib-svc/pages/UserProfileService.adoc | 3 +-
.../hooks/introductory_notes.adoc | 3 +
.../pages/UserProfileService/hooks/see_also.adoc | 4 +
.../UserProfileService/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../applib-svc/pages/UserRegistrationService.adoc | 3 +-
.../hooks/introductory_notes.adoc | 3 +
.../UserRegistrationService/hooks/see_also.adoc | 4 +
.../UserRegistrationService/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../adoc/modules/applib-svc/pages/UserService.adoc | 3 +-
.../UserService/hooks/introductory_notes.adoc | 3 +
.../pages/UserService/hooks/see_also.adoc | 4 +
.../pages/UserService/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../modules/applib-svc/pages/WrapperFactory.adoc | 3 +-
.../WrapperFactory/hooks/introductory_notes.adoc | 3 +
.../pages/WrapperFactory/hooks/see_also.adoc | 4 +
.../pages/WrapperFactory/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../adoc/modules/applib-svc/pages/XmlService.adoc | 3 +-
.../pages/XmlService/hooks/introductory_notes.adoc | 3 +
.../pages/XmlService/hooks/see_also.adoc | 4 +
.../pages/XmlService/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../applib-svc/pages/XmlSnapshotService.adoc | 3 +-
.../hooks/introductory_notes.adoc | 3 +
.../pages/XmlSnapshotService/hooks/see_also.adoc | 4 +
.../XmlSnapshotService/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../pages/about/hooks/introductory_notes.adoc | 3 +
.../applib-svc/pages/about/hooks/see_also.adoc | 4 +
.../applib-svc/pages/about/hooks/usage_notes.adoc | 4 +
.../implementation.adoc | 0
.../modules/applib-svc/partials/_metadata-api.adoc | 2 +-
.../services/acceptheader/AcceptHeaderService.java | 9 +
.../appfeat/ApplicationFeatureRepository.java | 7 +-
.../applib/services/bookmark/BookmarkService.java | 5 +-
.../processor/spi/CommandDtoProcessorService.java | 13 +-
.../src/main/adoc/modules/schema/pages/mml.adoc | 4 +-
isis-tooling.yml | 138 +-
.../org/apache/isis/tooling/cli/CliConfig.java | 1 +
.../isis/tooling/cli/projdoc/ProjectDocModel.java | 11 +-
.../isis/tooling/cli/projdoc/ProjectDocWriter.java | 3 +-
.../apache/isis/tooling/j2adoc/J2AdocContext.java | 55 +-
.../org/apache/isis/tooling/j2adoc/J2AdocUnit.java | 60 +-
.../tooling/j2adoc/convert/J2AdocConverter.java | 16 +-
.../j2adoc/convert/J2AdocConverterAbstract.java | 185 +
.../j2adoc/convert/J2AdocConverterDefault.java | 229 +-
.../j2adoc/format/UnitFormatterAbstract.java | 128 +-
.../j2adoc/format/UnitFormatterCompact.java | 9 +-
.../UnitFormatterWithSourceAndFootNotes.java | 100 +-
.../isis/tooling/j2adoc/test/J2AdocTest.java | 51 +-
.../isis/tooling/javamodel/ast/Javadocs.java | 21 +-
1165 files changed, 8407 insertions(+), 11414 deletions(-)
diff --git a/antora/components/system/modules/generated/pages/index/applib/AbstractViewModel.adoc b/antora/components/system/modules/generated/pages/index/applib/AbstractViewModel.adoc
index 7c6675c..f5db6ef 100644
--- a/antora/components/system/modules/generated/pages/index/applib/AbstractViewModel.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/AbstractViewModel.adoc
@@ -1,11 +1,12 @@
-= AbstractViewModel : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Convenience super class for view models that wish to interact with the container.
Subclassing is NOT mandatory; the methods in this superclass can be pushed down into domain objects and another superclass used if required.
-.Java Sources
+== API
+
+.AbstractViewModel.java
[source,java]
----
class AbstractViewModel {
diff --git a/antora/components/system/modules/generated/pages/index/applib/Identifier.adoc b/antora/components/system/modules/generated/pages/index/applib/Identifier.adoc
index 010914d..bca9905 100644
--- a/antora/components/system/modules/generated/pages/index/applib/Identifier.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/Identifier.adoc
@@ -1,86 +1,49 @@
-= Identifier : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.Identifier.java
[source,java]
----
class Identifier {
-
public static final Depth CLASS;
-
public static final Depth CLASS_MEMBERNAME;
-
public static final Depth CLASS_MEMBERNAME_PARAMETERS;
-
public static final Depth MEMBERNAME_ONLY;
-
public static final Depth PARAMETERS_ONLY;
-
Identifier classIdentifier(final Class<?> cls)
-
Identifier classIdentifier(final String className)
-
Identifier propertyOrCollectionIdentifier(final Class<?> declaringClass, final String propertyOrCollectionName)
-
Identifier propertyOrCollectionIdentifier(final String declaringClassName, final String propertyOrCollectionName)
-
Identifier actionIdentifier(final Class<?> declaringClass, final String actionName, final Class<?>... parameterClasses)
-
Identifier actionIdentifier(final String declaringClassName, final String actionName, final Class<?>... parameterClasses)
-
Identifier actionIdentifier(final String declaringClassName, final String actionName, final List<String> parameterClassNames)
-
String getClassName()
-
String getClassNaturalName()
-
String getMemberName()
-
String getMemberNaturalName()
-
List<String> getMemberParameterNames()
-
List<String> getMemberParameterNaturalNames()
-
Type getType()
-
- boolean isPropertyOrCollection() // <.>
-
+ boolean isPropertyOrCollection() // <.>
String toIdentityString(final Depth depth)
-
String toClassIdentityString()
-
StringBuilder toClassIdentityString(final StringBuilder buf)
-
String toNameIdentityString()
-
StringBuilder toNameIdentityString(final StringBuilder buf)
-
String toClassAndNameIdentityString()
-
StringBuilder toClassAndNameIdentityString(final StringBuilder buf)
-
String toParmsIdentityString()
-
StringBuilder toParmsIdentityString(final StringBuilder buf)
-
String toNameParmsIdentityString()
-
StringBuilder toNameParmsIdentityString(final StringBuilder buf)
-
String toFullIdentityString()
-
int compareTo(final Identifier o2)
-
- boolean equals(final Object obj) // <.>
-
+ boolean equals(final Object obj) // <.>
boolean equals(final Identifier other)
-
int hashCode()
-
String toString()
-
- Identifier fromIdentityString(final String asString) // <.>
+ Identifier fromIdentityString(final String asString) // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/IsisModuleApplib.adoc b/antora/components/system/modules/generated/pages/index/applib/IsisModuleApplib.adoc
index 2b5fef2..7065167 100644
--- a/antora/components/system/modules/generated/pages/index/applib/IsisModuleApplib.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/IsisModuleApplib.adoc
@@ -1,7 +1,8 @@
-= IsisModuleApplib : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.IsisModuleApplib.java
[source,java]
----
class IsisModuleApplib {
diff --git a/antora/components/system/modules/generated/pages/index/applib/RecreatableDomainObject.adoc b/antora/components/system/modules/generated/pages/index/applib/RecreatableDomainObject.adoc
index 8709d95..71fcb8c 100644
--- a/antora/components/system/modules/generated/pages/index/applib/RecreatableDomainObject.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/RecreatableDomainObject.adoc
@@ -1,18 +1,17 @@
-= RecreatableDomainObject : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Indicates that the domain object can be recreated from a string.
Objects that are view models (logically belonging to the UI/application layer) should instead implement xref:system:generated:index/applib/ViewModel.adoc[ViewModel] .
-.Java Sources
+== API
+
+.RecreatableDomainObject.java
[source,java]
----
interface RecreatableDomainObject {
-
- String __isis_memento() // <.>
-
- void __isis_recreate(String memento) // <.>
+ String __isis_memento() // <.>
+ void __isis_recreate(String memento) // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/ViewModel.adoc b/antora/components/system/modules/generated/pages/index/applib/ViewModel.adoc
index b58c457..53f5654 100644
--- a/antora/components/system/modules/generated/pages/index/applib/ViewModel.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/ViewModel.adoc
@@ -1,18 +1,17 @@
-= ViewModel : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Indicates that an object belongs to the UI/application layer, and is intended to be used as a view model.
Objects that are part of the domain object layer should instead implement xref:system:generated:index/applib/RecreatableDomainObject.adoc[RecreatableDomainObject] .
-.Java Sources
+== API
+
+.ViewModel.java
[source,java]
----
interface ViewModel {
-
- String viewModelMemento() // <.>
-
- void viewModelInit(String memento) // <.>
+ String viewModelMemento() // <.>
+ void viewModelInit(String memento) // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/adapters/AbstractValueSemanticsProvider.adoc b/antora/components/system/modules/generated/pages/index/applib/adapters/AbstractValueSemanticsProvider.adoc
index dc0e166..e37e335 100644
--- a/antora/components/system/modules/generated/pages/index/applib/adapters/AbstractValueSemanticsProvider.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/adapters/AbstractValueSemanticsProvider.adoc
@@ -1,15 +1,13 @@
-= AbstractValueSemanticsProvider : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.AbstractValueSemanticsProvider.java
[source,java]
----
class AbstractValueSemanticsProvider {
-
EncoderDecoder<T> getEncoderDecoder()
-
Parser<T> getParser()
-
DefaultsProvider<T> getDefaultsProvider()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/adapters/DefaultsProvider.adoc b/antora/components/system/modules/generated/pages/index/applib/adapters/DefaultsProvider.adoc
index cc3b988..c5b41d6 100644
--- a/antora/components/system/modules/generated/pages/index/applib/adapters/DefaultsProvider.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/adapters/DefaultsProvider.adoc
@@ -1,4 +1,3 @@
-= DefaultsProvider : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Provides a mechanism for providing a default value for an object.
@@ -9,12 +8,13 @@ This interface is used in two complementary ways:
Whatever the class that implements this interface, it must also expose either a `public` no-arg constructor, or (for implementations that also are `Facet` s) a `public` constructor that accepts a single `FacetHolder` . This constructor allows the framework to instantiate the object reflectively.
-.Java Sources
+== API
+
+.DefaultsProvider.java
[source,java]
----
interface DefaultsProvider {
-
- T getDefaultValue() // <.>
+ T getDefaultValue() // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/adapters/EncoderDecoder.adoc b/antora/components/system/modules/generated/pages/index/applib/adapters/EncoderDecoder.adoc
index f90d73d..eff229d 100644
--- a/antora/components/system/modules/generated/pages/index/applib/adapters/EncoderDecoder.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/adapters/EncoderDecoder.adoc
@@ -1,4 +1,3 @@
-= EncoderDecoder : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Provides a mechanism for encoding/decoding objects.
@@ -9,14 +8,14 @@ This interface is used in two complementary ways:
Whatever the class that implements this interface, it must also expose either a `public` no-arg constructor, or (for implementations that also are `Facet` s) a `public` constructor that accepts a single `FacetHolder` . This constructor allows the framework to instantiate the object reflectively.
-.Java Sources
+== API
+
+.EncoderDecoder.java
[source,java]
----
interface EncoderDecoder {
-
- String toEncodedString(T toEncode) // <.>
-
- T fromEncodedString(String encodedString) // <.>
+ String toEncodedString(T toEncode) // <.>
+ T fromEncodedString(String encodedString) // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/adapters/EncodingException.adoc b/antora/components/system/modules/generated/pages/index/applib/adapters/EncodingException.adoc
index b709885..764c7f4 100644
--- a/antora/components/system/modules/generated/pages/index/applib/adapters/EncodingException.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/adapters/EncodingException.adoc
@@ -1,19 +1,16 @@
-= EncodingException : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Indicates that encoding or decoding has failed.
-.Java Sources
+== API
+
+.EncodingException.java
[source,java]
----
class EncodingException {
-
EncodingException()
-
EncodingException(final String msg)
-
EncodingException(final String msg, final Throwable cause)
-
EncodingException(final Throwable cause)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/adapters/Parser.adoc b/antora/components/system/modules/generated/pages/index/applib/adapters/Parser.adoc
index 7c24f0d..792427d 100644
--- a/antora/components/system/modules/generated/pages/index/applib/adapters/Parser.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/adapters/Parser.adoc
@@ -1,4 +1,3 @@
-= Parser : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Provides a mechanism for parsing and rendering string representations of objects.
@@ -19,22 +18,18 @@ This interface is used in two complementary ways:
Whatever the class that implements this interface, it must also expose either a `public` no-arg constructor, or (for implementations that also are `Facet` s) a `public` constructor that accepts a single `FacetHolder` . This constructor allows the framework to instantiate the object reflectively.
-.Java Sources
+== API
+
+.Parser.java
[source,java]
----
interface Parser {
-
- T parseTextEntry(Object contextPojo, String entry) // <.>
-
- int typicalLength() // <.>
-
- String displayTitleOf(T object) // <.>
-
- String displayTitleOf(T object, String usingMask) // <.>
-
- String parseableTitleOf(T existing) // <.>
-
- int maxLength() // <.>
+ T parseTextEntry(Object contextPojo, String entry) // <.>
+ int typicalLength() // <.>
+ String displayTitleOf(T object) // <.>
+ String displayTitleOf(T object, String usingMask) // <.>
+ String parseableTitleOf(T existing) // <.>
+ int maxLength() // <.>
}
----
@@ -63,9 +58,9 @@ The title of the object using a mask.
<.> `[teal]#*parseableTitleOf*#(T existing)` : `String`
+
--
-A title for the object that is valid but which may be easier to edit than the title provided by aTitleFacet.
+A title for the object that is valid but which may be easier to edit than the title provided by a `TitleFacet.
-The idea here is that the viewer can display a parseable title for an existing object when, for example, the user initially clicks in the field. So, a date might be rendered via aTitleFacetas `May 2, 2007` , but its editable form might be `20070502` .
+The idea here is that the viewer can display a parseable title for an existing object when, for example, the user initially clicks in the field. So, a date might be rendered via a `TitleFacetas `May 2, 2007` , but its editable form might be `20070502` .
--
<.> `[teal]#*maxLength*#()` : `int`
+
diff --git a/antora/components/system/modules/generated/pages/index/applib/adapters/ParsingException.adoc b/antora/components/system/modules/generated/pages/index/applib/adapters/ParsingException.adoc
index 45588a4..7d25f5a 100644
--- a/antora/components/system/modules/generated/pages/index/applib/adapters/ParsingException.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/adapters/ParsingException.adoc
@@ -1,19 +1,16 @@
-= ParsingException : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Indicates that parsing has failed, ie the entry is illegal (rather than invalid).
-.Java Sources
+== API
+
+.ParsingException.java
[source,java]
----
class ParsingException {
-
ParsingException()
-
ParsingException(final String msg)
-
ParsingException(final String msg, final Throwable cause)
-
ParsingException(final Throwable cause)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/adapters/ValueSemanticsProvider.adoc b/antora/components/system/modules/generated/pages/index/applib/adapters/ValueSemanticsProvider.adoc
index 04af079..6ed1b8a 100644
--- a/antora/components/system/modules/generated/pages/index/applib/adapters/ValueSemanticsProvider.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/adapters/ValueSemanticsProvider.adoc
@@ -1,4 +1,3 @@
-= ValueSemanticsProvider : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Provides a mechanism for providing a set of value semantics.
@@ -7,16 +6,15 @@ This interface is used by xref:system:generated:index/applib/annotation/Value.ad
Whatever the class that implements this interface, it must also expose either a `public` no-arg constructor, or (for implementations that also are `Facet` s) a `public` constructor that accepts a `FacetHolder` , and `IsisConfiguration` and a `ValueSemanticsProviderContext` . This constructor is then used by the framework to instantiate the object reflectively.
-.Java Sources
+== API
+
+.ValueSemanticsProvider.java
[source,java]
----
interface ValueSemanticsProvider {
-
- Parser<T> getParser() // <.>
-
- EncoderDecoder<T> getEncoderDecoder() // <.>
-
- DefaultsProvider<T> getDefaultsProvider() // <.>
+ Parser<T> getParser() // <.>
+ EncoderDecoder<T> getEncoderDecoder() // <.>
+ DefaultsProvider<T> getDefaultsProvider() // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/Action.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/Action.adoc
index 7cce51f..adae62d 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/Action.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/Action.adoc
@@ -1,34 +1,24 @@
-= Action : _annotation_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-Domain semantics for domain object collection.
+Groups together all domain-specific metadata for an invokable action on a domain object or domain service.
-.Java Sources
+== API
+
+.Action.java
[source,java]
----
@interface Action {
-
- String associateWith() default ""; // <.>
-
- String associateWithSequence() default "1"; // <.>
-
- Class<? extends CommandDtoProcessor> commandDtoProcessor() default CommandDtoProcessor.class; // <.>
-
- Publishing commandPublishing() default Publishing.NOT_SPECIFIED; // <.>
-
- Class<? extends ActionDomainEvent<?>> domainEvent() default ActionDomainEvent.Default.class; // <.>
-
- Publishing executionPublishing() default Publishing.NOT_SPECIFIED; // <.>
-
- Where hidden() default Where.NOT_SPECIFIED; // <.>
-
- RestrictTo restrictTo() default RestrictTo.NOT_SPECIFIED; // <.>
-
- SemanticsOf semantics() default SemanticsOf.NOT_SPECIFIED; // <.>
-
- Class<?> typeOf() default Object.class; // <.>
-
- String fileAccept() default ""; // <.>
+ String associateWith() default ""; // <.>
+ String associateWithSequence() default "1"; // <.>
+ Class<? extends CommandDtoProcessor> commandDtoProcessor() default CommandDtoProcessor.class; // <.>
+ Publishing commandPublishing() default Publishing.NOT_SPECIFIED; // <.>
+ Class<? extends ActionDomainEvent<?>> domainEvent() default ActionDomainEvent.Default.class; // <.>
+ Publishing executionPublishing() default Publishing.NOT_SPECIFIED; // <.>
+ Where hidden() default Where.NOT_SPECIFIED; // <.>
+ RestrictTo restrictTo() default RestrictTo.NOT_SPECIFIED; // <.>
+ SemanticsOf semantics() default SemanticsOf.NOT_SPECIFIED; // <.>
+ Class<?> typeOf() default Object.class; // <.>
+ String fileAccept() default ""; // <.>
}
----
@@ -39,7 +29,7 @@ Associates this action with a property or collection, specifying its id.
This is an alternative to using _MemberOrder#name()_ . To specify the order (equivalent to _MemberOrder#sequence()_ }), use _#associateWithSequence()_ .
-For example@Action(associateWith="items", associateWithSequence="2.1")
+For example `@Action(associateWith="items", associateWithSequence="2.1")
If an action is associated with a collection, then any matching parameters will have their choices automatically inferred from the collection (if not otherwise specified) and any collection parameter defaults can be specified using checkboxes (in the Wicket UI, at least).
--
@@ -50,7 +40,7 @@ Specifies the sequence/order in the UI for an action that's been associated with
This is an alternative to using _MemberOrder#sequence()_ , but is ignored if _Action#associateWith()_ isn't also specified.
-For example@Action(associateWith="items", associateWithSequence="2.1")
+For example `@Action(associateWith="items", associateWithSequence="2.1")
--
<.> `[teal]#*_commandDtoProcessor_*#` : `Class<? extends CommandDtoProcessor>`
+
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/ActionLayout.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/ActionLayout.adoc
index b92755d..2442d86 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/ActionLayout.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/ActionLayout.adoc
@@ -1,32 +1,23 @@
-= ActionLayout : _annotation_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Layout hints for actions.
-.Java Sources
+== API
+
+.ActionLayout.java
[source,java]
----
@interface ActionLayout {
-
- BookmarkPolicy bookmarking() default BookmarkPolicy.NOT_SPECIFIED; // <.>
-
- String cssClass() default ""; // <.>
-
- String cssClassFa() default ""; // <.>
-
- CssClassFaPosition cssClassFaPosition() default CssClassFaPosition.LEFT; // <.>
-
- String describedAs() default ""; // <.>
-
- Where hidden() default Where.NOT_SPECIFIED; // <.>
-
- String named() default ""; // <.>
-
- Position position() default Position.NOT_SPECIFIED; // <.>
-
- PromptStyle promptStyle() default PromptStyle.AS_CONFIGURED; // <.>
-
- Redirect redirectPolicy() default Redirect.AS_CONFIGURED; // <.>
+ BookmarkPolicy bookmarking() default BookmarkPolicy.NOT_SPECIFIED; // <.>
+ String cssClass() default ""; // <.>
+ String cssClassFa() default ""; // <.>
+ CssClassFaPosition cssClassFaPosition() default CssClassFaPosition.LEFT; // <.>
+ String describedAs() default ""; // <.>
+ Where hidden() default Where.NOT_SPECIFIED; // <.>
+ String named() default ""; // <.>
+ Position position() default Position.NOT_SPECIFIED; // <.>
+ PromptStyle promptStyle() default PromptStyle.AS_CONFIGURED; // <.>
+ Redirect redirectPolicy() default Redirect.AS_CONFIGURED; // <.>
}
----
@@ -42,7 +33,7 @@ For bookmarkable actions, either _org.apache.isis.applib.annotation.BookmarkPoli
--
Indicates the css class that an action should have.
-For the Wicket viewer, this can be a bootstrap class such asbtn-info.
+For the Wicket viewer, this can be a bootstrap class such as `btn-info.
--
<.> `[teal]#*_cssClassFa_*#` : `String`
+
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/BookmarkPolicy.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/BookmarkPolicy.adoc
index a76fae4..9f9db31 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/BookmarkPolicy.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/BookmarkPolicy.adoc
@@ -1,18 +1,15 @@
-= BookmarkPolicy : _enum_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.BookmarkPolicy.java
[source,java]
----
enum BookmarkPolicy {
-
- AS_ROOT // <.>
-
- AS_CHILD // <.>
-
- NEVER // <.>
-
- NOT_SPECIFIED // <.>
+ AS_ROOT // <.>
+ AS_CHILD // <.>
+ NEVER // <.>
+ NOT_SPECIFIED // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/Bounding.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/Bounding.adoc
index c646d9f..fbbeea9 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/Bounding.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/Bounding.adoc
@@ -1,17 +1,15 @@
-= Bounding : _enum_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Whether the set of instances of a domain object is bounded or not.
-.Java Sources
+== API
+
+.Bounding.java
[source,java]
----
enum Bounding {
-
BOUNDED
-
UNBOUNDED
-
NOT_SPECIFIED
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/Collection.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/Collection.adoc
index 61b2041..a06be86 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/Collection.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/Collection.adoc
@@ -1,20 +1,17 @@
-= Collection : _annotation_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Domain semantics for domain object collection.
-.Java Sources
+== API
+
+.Collection.java
[source,java]
----
@interface Collection {
-
- Class<? extends CollectionDomainEvent<?, ?>> domainEvent() default CollectionDomainEvent.Default.class; // <.>
-
- Editing editing() default Editing.NOT_SPECIFIED; // <.>
-
- Where hidden() default Where.NOT_SPECIFIED; // <.>
-
- Class<?> typeOf() default Object.class; // <.>
+ Class<? extends CollectionDomainEvent<?, ?>> domainEvent() default CollectionDomainEvent.Default.class; // <.>
+ Editing editing() default Editing.NOT_SPECIFIED; // <.>
+ Where hidden() default Where.NOT_SPECIFIED; // <.>
+ Class<?> typeOf() default Object.class; // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/CollectionLayout.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/CollectionLayout.adoc
index 1d4f098..9368b53 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/CollectionLayout.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/CollectionLayout.adoc
@@ -1,29 +1,22 @@
-= CollectionLayout : _annotation_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Layout hints for collections.
-.Java Sources
+== API
+
+.CollectionLayout.java
[source,java]
----
@interface CollectionLayout {
-
- String cssClass() default ""; // <.>
-
- String defaultView() default ""; // <.>
-
- String describedAs() default ""; // <.>
-
- Where hidden() default Where.NOT_SPECIFIED; // <.>
-
- String named() default ""; // <.>
-
- boolean namedEscaped() default true; // <.>
-
- int paged() default -1; // <.>
-
+ String cssClass() default ""; // <.>
+ String defaultView() default ""; // <.>
+ String describedAs() default ""; // <.>
+ Where hidden() default Where.NOT_SPECIFIED; // <.>
+ String named() default ""; // <.>
+ boolean namedEscaped() default true; // <.>
+ int paged() default -1; // <.>
@SuppressWarnings("rawtypes")
-Class sortedBy() default Comparator.class; // <.>
+Class sortedBy() default Comparator.class; // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/Defaulted.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/Defaulted.adoc
index 0905995..76e2772 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/Defaulted.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/Defaulted.adoc
@@ -1,18 +1,17 @@
-= Defaulted : _annotation_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Indicates that the class should have a default, by providing a link to a xref:system:generated:index/applib/adapters/DefaultsProvider.adoc[DefaultsProvider] , or some externally-configured mechanism.
This possibly seems a little tortuous. The more obvious means to provide a default would seem to be a simple `@DefaultsTo(new SomeObject())` . However, Java only allows primitives, strings and class literals to be used in annotations. We therefore need delegate to an external implementation. (This more complex design is also more flexible of course; the implementation of xref:system:generated:index/applib/adapters/DefaultsProvider.adoc[DefaultsProvider] could adjust the default it provid [...]
-.Java Sources
+== API
+
+.Defaulted.java
[source,java]
----
@interface Defaulted {
-
- String defaultsProviderName() default ""; // <.>
-
- Class<?> defaultsProviderClass() default Defaulted.class; // <.>
+ String defaultsProviderName() default ""; // <.>
+ Class<?> defaultsProviderClass() default Defaulted.class; // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/DomainObject.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/DomainObject.adoc
index a61f01b..7e77608 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/DomainObject.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/DomainObject.adoc
@@ -1,57 +1,39 @@
-= DomainObject : _annotation_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Domain semantics for domain objects (entities and view models; for services see xref:system:generated:index/applib/annotation/DomainService.adoc[DomainService] ).
-.Java Sources
+== API
+
+.DomainObject.java
[source,java]
----
@interface DomainObject {
-
- Class<?> autoCompleteRepository() default Object.class; // <.>
-
- String autoCompleteAction() default "autoComplete"; // <.>
-
- Bounding bounding() default Bounding.NOT_SPECIFIED; // <.>
-
- Editing editing() default Editing.NOT_SPECIFIED; // <.>
-
- String editingDisabledReason() default "Disabled"; // <.>
-
- Publishing entityChangePublishing() default Publishing.NOT_SPECIFIED; // <.>
-
- String mixinMethod() default "$$"; // <.>
-
- Nature nature() default Nature.NOT_SPECIFIED; // <.>
-
- String objectType() default ""; // <.>
-
- Class<? extends ObjectCreatedEvent<?>> createdLifecycleEvent() default ObjectCreatedEvent.Default.class; // <.>
-
- Class<? extends ObjectPersistingEvent<?>> persistingLifecycleEvent() default ObjectPersistingEvent.Default.class; // <.>
-
- Class<? extends ObjectPersistedEvent<?>> persistedLifecycleEvent() default ObjectPersistedEvent.Default.class; // <.>
-
- Class<? extends ObjectLoadedEvent<?>> loadedLifecycleEvent() default ObjectLoadedEvent.Default.class; // <.>
-
- Class<? extends ObjectUpdatingEvent<?>> updatingLifecycleEvent() default ObjectUpdatingEvent.Default.class; // <.>
-
- Class<? extends ObjectUpdatedEvent<?>> updatedLifecycleEvent() default ObjectUpdatedEvent.Default.class; // <.>
-
- Class<? extends ObjectRemovingEvent<?>> removingLifecycleEvent() default ObjectRemovingEvent.Default.class; // <.>
-
- Class<? extends ActionDomainEvent<?>> actionDomainEvent() default ActionDomainEvent.Default.class; // <.>
-
- Class<? extends PropertyDomainEvent<?, ?>> propertyDomainEvent() default PropertyDomainEvent.Default.class; // <.>
-
- Class<? extends CollectionDomainEvent<?, ?>> collectionDomainEvent() default CollectionDomainEvent.Default.class; // <.>
+ Class<?> autoCompleteRepository() default Object.class; // <.>
+ String autoCompleteAction() default "autoComplete"; // <.>
+ Bounding bounding() default Bounding.NOT_SPECIFIED; // <.>
+ Editing editing() default Editing.NOT_SPECIFIED; // <.>
+ String editingDisabledReason() default "Disabled"; // <.>
+ Publishing entityChangePublishing() default Publishing.NOT_SPECIFIED; // <.>
+ String mixinMethod() default "$$"; // <.>
+ Nature nature() default Nature.NOT_SPECIFIED; // <.>
+ String objectType() default ""; // <.>
+ Class<? extends ObjectCreatedEvent<?>> createdLifecycleEvent() default ObjectCreatedEvent.Default.class; // <.>
+ Class<? extends ObjectPersistingEvent<?>> persistingLifecycleEvent() default ObjectPersistingEvent.Default.class; // <.>
+ Class<? extends ObjectPersistedEvent<?>> persistedLifecycleEvent() default ObjectPersistedEvent.Default.class; // <.>
+ Class<? extends ObjectLoadedEvent<?>> loadedLifecycleEvent() default ObjectLoadedEvent.Default.class; // <.>
+ Class<? extends ObjectUpdatingEvent<?>> updatingLifecycleEvent() default ObjectUpdatingEvent.Default.class; // <.>
+ Class<? extends ObjectUpdatedEvent<?>> updatedLifecycleEvent() default ObjectUpdatedEvent.Default.class; // <.>
+ Class<? extends ObjectRemovingEvent<?>> removingLifecycleEvent() default ObjectRemovingEvent.Default.class; // <.>
+ Class<? extends ActionDomainEvent<?>> actionDomainEvent() default ActionDomainEvent.Default.class; // <.>
+ Class<? extends PropertyDomainEvent<?, ?>> propertyDomainEvent() default PropertyDomainEvent.Default.class; // <.>
+ Class<? extends CollectionDomainEvent<?, ?>> collectionDomainEvent() default CollectionDomainEvent.Default.class; // <.>
}
----
<.> `[teal]#*_autoCompleteRepository_*#` : `Class<?>`
+
--
-The class of the domain service that provides anautoComplete(String)method.
+The class of the domain service that provides an `autoComplete(String)method.
It is sufficient to specify an interface rather than a concrete type.
--
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/DomainObjectLayout.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/DomainObjectLayout.adoc
index 886b7b1..14a48ba 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/DomainObjectLayout.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/DomainObjectLayout.adoc
@@ -1,36 +1,25 @@
-= DomainObjectLayout : _annotation_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Layout hints for domain objects.
-.Java Sources
+== API
+
+.DomainObjectLayout.java
[source,java]
----
@interface DomainObjectLayout {
-
- BookmarkPolicy bookmarking() default BookmarkPolicy.NOT_SPECIFIED; // <.>
-
- String cssClass() default ""; // <.>
-
- String cssClassFa() default ""; // <.>
-
- CssClassFaPosition cssClassFaPosition() default CssClassFaPosition.LEFT; // <.>
-
- String describedAs() default ""; // <.>
-
- String named() default ""; // <.>
-
- int paged() default -1; // <.>
-
- String plural() default ""; // <.>
-
- Class<? extends CssClassUiEvent<?>> cssClassUiEvent() default CssClassUiEvent.Default.class; // <.>
-
- Class<? extends IconUiEvent<?>> iconUiEvent() default IconUiEvent.Default.class; // <.>
-
- Class<? extends LayoutUiEvent<?>> layoutUiEvent() default LayoutUiEvent.Default.class; // <.>
-
- Class<? extends TitleUiEvent<?>> titleUiEvent() default TitleUiEvent.Default.class; // <.>
+ BookmarkPolicy bookmarking() default BookmarkPolicy.NOT_SPECIFIED; // <.>
+ String cssClass() default ""; // <.>
+ String cssClassFa() default ""; // <.>
+ CssClassFaPosition cssClassFaPosition() default CssClassFaPosition.LEFT; // <.>
+ String describedAs() default ""; // <.>
+ String named() default ""; // <.>
+ int paged() default -1; // <.>
+ String plural() default ""; // <.>
+ Class<? extends CssClassUiEvent<?>> cssClassUiEvent() default CssClassUiEvent.Default.class; // <.>
+ Class<? extends IconUiEvent<?>> iconUiEvent() default IconUiEvent.Default.class; // <.>
+ Class<? extends LayoutUiEvent<?>> layoutUiEvent() default LayoutUiEvent.Default.class; // <.>
+ Class<? extends TitleUiEvent<?>> titleUiEvent() default TitleUiEvent.Default.class; // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/DomainService.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/DomainService.adoc
index 2c37316..c80061f 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/DomainService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/DomainService.adoc
@@ -1,18 +1,17 @@
-= DomainService : _annotation_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Indicates that the class should be automatically recognized as a domain service.
Also indicates whether the domain service acts as a repository for an entity, and menu ordering UI hints.
-.Java Sources
+== API
+
+.DomainService.java
[source,java]
----
@interface DomainService {
-
- NatureOfService nature() default NatureOfService.VIEW; // <.>
-
- String objectType() default ""; // <.>
+ NatureOfService nature() default NatureOfService.VIEW; // <.>
+ String objectType() default ""; // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/DomainServiceLayout.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/DomainServiceLayout.adoc
index d0ffa00..5f6996b 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/DomainServiceLayout.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/DomainServiceLayout.adoc
@@ -1,18 +1,17 @@
-= DomainServiceLayout : _annotation_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Layout hints for domain services.
Also indicates the name, and menu ordering UI hints.
-.Java Sources
+== API
+
+.DomainServiceLayout.java
[source,java]
----
@interface DomainServiceLayout {
-
- MenuBar menuBar() default MenuBar.NOT_SPECIFIED; // <.>
-
- String named() default ""; // <.>
+ MenuBar menuBar() default MenuBar.NOT_SPECIFIED; // <.>
+ String named() default ""; // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/Editing.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/Editing.adoc
index e2c65a4..edfa001 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/Editing.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/Editing.adoc
@@ -1,20 +1,17 @@
-= Editing : _enum_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
The available policies for editing properties and collections.
-.Java Sources
+== API
+
+.Editing.java
[source,java]
----
enum Editing {
-
- AS_CONFIGURED // <.>
-
- ENABLED // <.>
-
- DISABLED // <.>
-
- NOT_SPECIFIED // <.>
+ AS_CONFIGURED // <.>
+ ENABLED // <.>
+ DISABLED // <.>
+ NOT_SPECIFIED // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/EntityChangeKind.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/EntityChangeKind.adoc
index 8545945..14b0394 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/EntityChangeKind.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/EntityChangeKind.adoc
@@ -1,15 +1,13 @@
-= EntityChangeKind : _enum_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.EntityChangeKind.java
[source,java]
----
enum EntityChangeKind {
-
CREATE
-
UPDATE
-
DELETE
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/EqualByContent.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/EqualByContent.adoc
index f4eda37..abe4448 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/EqualByContent.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/EqualByContent.adoc
@@ -1,4 +1,3 @@
-= EqualByContent : _annotation_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Indicates that the class follows the equal-by-content contract, usually associated with xref:system:generated:index/applib/annotation/Value.adoc[Value] types.
@@ -9,7 +8,9 @@ Note also that the Java Language Specification requires that two objects that ar
By default any xref:system:generated:index/applib/annotation/Value.adoc[Value] types are assumed to follow the equal-by-content rule, though this can be overridden if required. Value types are usually also immutable (though there are some classic exceptions to this, such as _Date_ ).
-.Java Sources
+== API
+
+.EqualByContent.java
[source,java]
----
@interface EqualByContent {
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/Facets.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/Facets.adoc
index 86165a5..9f1019e 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/Facets.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/Facets.adoc
@@ -1,18 +1,17 @@
-= Facets : _annotation_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Indicates that the class has additional facets, and specifies the how to obtain the `FacetFactory` to manufacture them.
At least one named factory (as per _#facetFactoryNames()_ ) or one class factory (as per _#facetFactoryClasses()_ ) should be specified.
-.Java Sources
+== API
+
+.Facets.java
[source,java]
----
@interface Facets {
-
- String[] facetFactoryNames() default {}; // <.>
-
- Class<?>[] facetFactoryClasses() default {}; // <.>
+ String[] facetFactoryNames() default {}; // <.>
+ Class<?>[] facetFactoryClasses() default {}; // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/HomePage.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/HomePage.adoc
index 82cd532..d20aba6 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/HomePage.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/HomePage.adoc
@@ -1,11 +1,12 @@
-= HomePage : _annotation_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Annotated on a view model to indicate that it should be used as the home page.
The view model is instantiated through a no-arg constructor, so must in effect be stateless. Typically it will use injected repositories in order to display a dashboard, and offer actions to traverse or operate on the rendered state.
-.Java Sources
+== API
+
+.HomePage.java
[source,java]
----
@interface HomePage {
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/InteractionScope.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/InteractionScope.adoc
index 6470a24..5732f70 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/InteractionScope.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/InteractionScope.adoc
@@ -1,4 +1,3 @@
-= InteractionScope : _annotation_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
_@InteractionScope_ is a specialization of _Scope @Scope_ for a component whose lifecycle is bound to the current top-level Interaction.
@@ -7,7 +6,9 @@ Specifically, _@InteractionScope_ is a *composed annotation* that acts as a shor
_@InteractionScope_ may be used as a meta-annotation to create custom composed annotations.
-.Java Sources
+== API
+
+.InteractionScope.java
[source,java]
----
@interface InteractionScope {
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/LabelPosition.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/LabelPosition.adoc
index 564859e..17c23ad 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/LabelPosition.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/LabelPosition.adoc
@@ -1,24 +1,19 @@
-= LabelPosition : _enum_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
The positioning of a label for a property or action parameter.
-.Java Sources
+== API
+
+.LabelPosition.java
[source,java]
----
enum LabelPosition {
-
DEFAULT
-
LEFT
-
- RIGHT // <.>
-
+ RIGHT // <.>
TOP
-
NONE
-
- NOT_SPECIFIED // <.>
+ NOT_SPECIFIED // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/MemberOrder.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/MemberOrder.adoc
index e37122a..fc09a0c 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/MemberOrder.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/MemberOrder.adoc
@@ -1,18 +1,17 @@
-= MemberOrder : _annotation_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Indicates the position a method should be placed in.
-An alternative is to use theXxx.layout.xmlfile, whereXxxis the domain object name.
+An alternative is to use the `Xxx.layout.xmlfile, where `Xxxis the domain object name.
-.Java Sources
+== API
+
+.MemberOrder.java
[source,java]
----
@interface MemberOrder {
-
- String name() default ""; // <.>
-
- String sequence(); // <.>
+ String name() default ""; // <.>
+ String sequence(); // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/MinLength.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/MinLength.adoc
index 844cb01..3bde09a 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/MinLength.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/MinLength.adoc
@@ -1,13 +1,13 @@
-= MinLength : _annotation_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Specify the minimum number of characters for an autocomplete search argument.
-.Java Sources
+== API
+
+.MinLength.java
[source,java]
----
@interface MinLength {
-
int value();
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/Module.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/Module.adoc
index e8a6312..4c11595 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/Module.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/Module.adoc
@@ -1,4 +1,3 @@
-= Module : _annotation_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Intended to be annotated on the root marker class of a (Maven) module which contains a single coherent set of functionality, possibly including domain services.
@@ -7,7 +6,9 @@ A xref:system:generated:index/applib/annotation/Module.adoc[Module] (because it'
Also, a xref:system:generated:index/applib/annotation/Module.adoc[Module] also declares the Spring _ComponentScan @ComponentScan_ (with no parameters), which means that any domain services in the same package or subpackages are automatically found and registered.
-.Java Sources
+== API
+
+.Module.java
[source,java]
----
@interface Module {
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/Nature.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/Nature.adoc
index dc7e7c5..be9aae1 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/Nature.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/Nature.adoc
@@ -1,23 +1,18 @@
-= Nature : _enum_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
The different sorts of domain objects recognized by Isis.
-.Java Sources
+== API
+
+.Nature.java
[source,java]
----
enum Nature {
-
- NOT_SPECIFIED // <.>
-
- ENTITY // <.>
-
- VIEW_MODEL // <.>
-
- MIXIN // <.>
-
- BEAN // <.>
-
+ NOT_SPECIFIED // <.>
+ ENTITY // <.>
+ VIEW_MODEL // <.>
+ MIXIN // <.>
+ BEAN // <.>
boolean isEntity()
}
----
@@ -43,7 +38,7 @@ An object that is conceptually part of the application layer, and which surfaces
The identity of a view model is determined solely by the state of object's properties. Using this nature should be considered exactly equivalent to annotating with xref:system:generated:index/applib/ViewModel.adoc[ViewModel] .
-Note that collections are ignored; if their state is required to fully identify the view model, define the view model using the JAXB _XmlRootElement_ annotation instead (where the object's state is serialized to an arbitrarily deep graph of data, with references to persistent entities transparently resolved to<oid-dto>elements).
+Note that collections are ignored; if their state is required to fully identify the view model, define the view model using the JAXB _XmlRootElement_ annotation instead (where the object's state is serialized to an arbitrarily deep graph of data, with references to persistent entities transparently resolved to `<oid-dto>elements).
--
<.> `[teal]#*_MIXIN_*#`
+
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/NatureOfService.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/NatureOfService.adoc
index 1ddb5ee..328708b 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/NatureOfService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/NatureOfService.adoc
@@ -1,20 +1,17 @@
-= NatureOfService : _enum_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
The different sorts of domain services recognized by Isis, as specified in _DomainService#nature()_
-.Java Sources
+== API
+
+.NatureOfService.java
[source,java]
----
enum NatureOfService {
-
- VIEW // <.>
-
- REST // <.>
-
- boolean isView() // <.>
-
- boolean isRestOnly() // <.>
+ VIEW // <.>
+ REST // <.>
+ boolean isView() // <.>
+ boolean isRestOnly() // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/Navigable.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/Navigable.adoc
index ba7b64c..9834ce1 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/Navigable.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/Navigable.adoc
@@ -1,19 +1,16 @@
-= Navigable : _enum_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Tells the framework which method or field to use in order to construct a navigable chain of parent domain object instances. The Navigable.PARENT 'flag' can only be used once per class declaration.
-.Java Sources
+== API
+
+.Navigable.java
[source,java]
----
enum Navigable {
-
NOT_SPECIFIED
-
IGNORE
-
PARENT
-
boolean isParent()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/Optionality.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/Optionality.adoc
index c3ce534..4b719cf 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/Optionality.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/Optionality.adoc
@@ -1,20 +1,17 @@
-= Optionality : _enum_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Whether the property or parameter is optional or is required (aka mandatory).
-.Java Sources
+== API
+
+.Optionality.java
[source,java]
----
enum Optionality {
-
- DEFAULT // <.>
-
- OPTIONAL // <.>
-
- MANDATORY // <.>
-
- NOT_SPECIFIED // <.>
+ DEFAULT // <.>
+ OPTIONAL // <.>
+ MANDATORY // <.>
+ NOT_SPECIFIED // <.>
}
----
@@ -23,7 +20,7 @@ enum Optionality {
--
Default, usually meaning mandatory for properties and always meaning mandatory for parameters.
-For properties, will be false unless JDOjavax.jdo.annotations.Columnhas also specified withjavax.jdo.annotations.Column#allowsNull()set totrue.
+For properties, will be false unless JDO `javax.jdo.annotations.Columnhas also specified with `javax.jdo.annotations.Column#allowsNull()set to `true.
--
<.> `[teal]#*_OPTIONAL_*#`
+
@@ -33,9 +30,9 @@ Indicates that the property or parameter is not required.
<.> `[teal]#*_MANDATORY_*#`
+
--
-Indicates that the property is required (even if the JDOjavax.jdo.annotations.Columnannotation says otherwise).
+Indicates that the property is required (even if the JDO `javax.jdo.annotations.Columnannotation says otherwise).
-When using the JDO/DataNucleus objectstore, it is sometimes necessary to annotate a property as optional (usingjavax.jdo.annotations.Column#allowsNull()set totrue), even if the property is logically mandatory. For example, this can occur when the property is in a subtype class that has been "rolled up" to the superclass table usingjavax.jdo.annotations.Inheritance> with thejavax.jdo.annotations.InheritanceStrategy#SUPERCLASS_TABLEsuperclass strategy.
+When using the JDO/DataNucleus objectstore, it is sometimes necessary to annotate a property as optional (using `javax.jdo.annotations.Column#allowsNull()set to `true), even if the property is logically mandatory. For example, this can occur when the property is in a subtype class that has been "rolled up" to the superclass table using `javax.jdo.annotations.Inheritance> with the `javax.jdo.annotations.InheritanceStrategy#SUPERCLASS_TABLEsuperclass strategy.
This annotation, therefore, is intended to override any objectstore-specific annotation, so that Isis can apply the constraint even though the objectstore is unable to do so.
--
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/OrderPrecedence.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/OrderPrecedence.adoc
index 01333e9..1d8b69f 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/OrderPrecedence.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/OrderPrecedence.adoc
@@ -1,20 +1,16 @@
-= OrderPrecedence : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.OrderPrecedence.java
[source,java]
----
class OrderPrecedence {
-
- public static final int FIRST; // <.>
-
- public static final int EARLY; // <.>
-
- public static final int MIDPOINT; // <.>
-
- public static final int LATE; // <.>
-
- public static final int LAST; // <.>
+ public static final int FIRST; // <.>
+ public static final int EARLY; // <.>
+ public static final int MIDPOINT; // <.>
+ public static final int LATE; // <.>
+ public static final int LAST; // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/Parameter.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/Parameter.adoc
index 7e422aa..3ac236a 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/Parameter.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/Parameter.adoc
@@ -1,26 +1,20 @@
-= Parameter : _annotation_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-Domain semantics for domain object collection.
+Collects together all domain semantics of an action parameter within a single annotation.
-.Java Sources
+== API
+
+.Parameter.java
[source,java]
----
@interface Parameter {
-
- String fileAccept() default ""; // <.>
-
- int maxLength() default -1; // <.>
-
- Class<? extends Specification>[] mustSatisfy() default {}; // <.>
-
- Optionality optionality() default Optionality.NOT_SPECIFIED; // <.>
-
- String regexPattern() default ""; // <.>
-
- int regexPatternFlags() default 0; // <.>
-
- String regexPatternReplacement() default "Doesn't match pattern"; // <.>
+ String fileAccept() default ""; // <.>
+ int maxLength() default -1; // <.>
+ Class<? extends Specification>[] mustSatisfy() default {}; // <.>
+ Optionality optionality() default Optionality.NOT_SPECIFIED; // <.>
+ String regexPattern() default ""; // <.>
+ int regexPatternFlags() default 0; // <.>
+ String regexPatternReplacement() default "Doesn't match pattern"; // <.>
}
----
@@ -36,7 +30,7 @@ The value should be of the form "file_extension|audio/*|video/*|image/*|media_ty
--
The maximum entry length of a field.
-The default value (-1) indicates that no maxLength has been specified.
+The default value ( `-1) indicates that no maxLength has been specified.
--
<.> `[teal]#*_mustSatisfy_*#` : `Class<? extends Specification>[]`
+
@@ -62,7 +56,7 @@ Regular expression pattern that a value should conform to, and can be formatted
--
Pattern flags, as per _java.util.regex.Pattern#compile(String, int)_ .
-The default value,0, means that no flags have been specified.
+The default value, `0, means that no flags have been specified.
--
<.> `[teal]#*_regexPatternReplacement_*#` : `String`
+
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/ParameterLayout.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/ParameterLayout.adoc
index 00c62b6..42d1b3b 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/ParameterLayout.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/ParameterLayout.adoc
@@ -1,28 +1,21 @@
-= ParameterLayout : _annotation_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-Layout hints for action parameters.
+Collects together all layout hints for action parameters in a single annotation.
-.Java Sources
+== API
+
+.ParameterLayout.java
[source,java]
----
@interface ParameterLayout {
-
- String cssClass() default ""; // <.>
-
- String describedAs() default ""; // <.>
-
- LabelPosition labelPosition() default LabelPosition.NOT_SPECIFIED; // <.>
-
- String named() default ""; // <.>
-
- boolean namedEscaped() default true; // <.>
-
- int multiLine() default -1; // <.>
-
- RenderDay renderDay() default RenderDay.NOT_SPECIFIED; // <.>
-
- int typicalLength() default -1; // <.>
+ String cssClass() default ""; // <.>
+ String describedAs() default ""; // <.>
+ LabelPosition labelPosition() default LabelPosition.NOT_SPECIFIED; // <.>
+ String named() default ""; // <.>
+ boolean namedEscaped() default true; // <.>
+ int multiLine() default -1; // <.>
+ RenderDay renderDay() default RenderDay.NOT_SPECIFIED; // <.>
+ int typicalLength() default -1; // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/Programmatic.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/Programmatic.adoc
index c89271b..a78b6a7 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/Programmatic.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/Programmatic.adoc
@@ -1,4 +1,3 @@
-= Programmatic : _annotation_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Indicates that an property, collection or action is to be called programmatically and should be ignored from the metamodel.
@@ -7,7 +6,9 @@ For example, it may be a helper method that needs to be `public` but that doesn'
It can also be added to a type, meaning that the type is ignored from the metamodel. This is intended as a "get out of jail" for any classes from unit tests, say, that end up on the classpath of integration tests but should otherwise be ignored.
-.Java Sources
+== API
+
+.Programmatic.java
[source,java]
----
@interface Programmatic {
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/Projecting.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/Projecting.adoc
index 45b98b4..3de210a 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/Projecting.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/Projecting.adoc
@@ -1,14 +1,13 @@
-= Projecting : _enum_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.Projecting.java
[source,java]
----
enum Projecting {
-
- PROJECTED // <.>
-
- NOT_SPECIFIED // <.>
+ PROJECTED // <.>
+ NOT_SPECIFIED // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/PromptStyle.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/PromptStyle.adoc
index 9e7e4e8..f1efe98 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/PromptStyle.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/PromptStyle.adoc
@@ -1,33 +1,23 @@
-= PromptStyle : _enum_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
How prompting for new values of a property/arguments for an action should be performed
-.Java Sources
+== API
+
+.PromptStyle.java
[source,java]
----
enum PromptStyle {
-
- AS_CONFIGURED // <.>
-
- DIALOG // <.>
-
- DIALOG_SIDEBAR // <.>
-
- DIALOG_MODAL // <.>
-
- INLINE // <.>
-
- INLINE_AS_IF_EDIT // <.>
-
- NOT_SPECIFIED // <.>
-
+ AS_CONFIGURED // <.>
+ DIALOG // <.>
+ DIALOG_SIDEBAR // <.>
+ DIALOG_MODAL // <.>
+ INLINE // <.>
+ INLINE_AS_IF_EDIT // <.>
+ NOT_SPECIFIED // <.>
boolean isDialog()
-
boolean isInline()
-
boolean isInlineAsIfEdit()
-
boolean isInlineOrInlineAsIfEdit()
}
----
@@ -44,7 +34,7 @@ If no style is configured, then _#INLINE_ is assumed.
--
Use a dialog for the prompt.
-This will be either modal dialog (same as if _#DIALOG_MODAL_ was selected) or sidebar (same as if _#DIALOG_SIDEBAR_ was selected) depending on the value of theisis.viweer.wicket.dialogModeconfiguration property.
+This will be either modal dialog (same as if _#DIALOG_MODAL_ was selected) or sidebar (same as if _#DIALOG_SIDEBAR_ was selected) depending on the value of the `isis.viweer.wicket.dialogModeconfiguration property.
--
<.> `[teal]#*_DIALOG_SIDEBAR_*#`
+
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/Property.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/Property.adoc
index 3655b48..02e3d6a 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/Property.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/Property.adoc
@@ -1,44 +1,29 @@
-= Property : _annotation_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-Domain semantics for domain object property.
+Collects together all the domain semantics for the property of a domain object.
-.Java Sources
+== API
+
+.Property.java
[source,java]
----
@interface Property {
-
- Class<? extends CommandDtoProcessor> commandDtoProcessor() default CommandDtoProcessor.class; // <.>
-
- Publishing commandPublishing() default Publishing.NOT_SPECIFIED; // <.>
-
- Class<? extends PropertyDomainEvent<?, ?>> domainEvent() default PropertyDomainEvent.Default.class; // <.>
-
- Editing editing() default Editing.NOT_SPECIFIED; // <.>
-
- String editingDisabledReason() default ""; // <.>
-
- Publishing executionPublishing() default Publishing.NOT_SPECIFIED; // <.>
-
- String fileAccept() default ""; // <.>
-
- Where hidden() default Where.NOT_SPECIFIED; // <.>
-
- int maxLength() default -1; // <.>
-
- Snapshot snapshot() default Snapshot.NOT_SPECIFIED; // <.>
-
- Class<? extends Specification>[] mustSatisfy() default {}; // <.>
-
- Optionality optionality() default Optionality.NOT_SPECIFIED; // <.>
-
- Projecting projecting() default Projecting.NOT_SPECIFIED; // <.>
-
- String regexPattern() default ""; // <.>
-
- int regexPatternFlags() default 0; // <.>
-
- String regexPatternReplacement() default "Doesn't match pattern"; // <.>
+ Class<? extends CommandDtoProcessor> commandDtoProcessor() default CommandDtoProcessor.class; // <.>
+ Publishing commandPublishing() default Publishing.NOT_SPECIFIED; // <.>
+ Class<? extends PropertyDomainEvent<?, ?>> domainEvent() default PropertyDomainEvent.Default.class; // <.>
+ Editing editing() default Editing.NOT_SPECIFIED; // <.>
+ String editingDisabledReason() default ""; // <.>
+ Publishing executionPublishing() default Publishing.NOT_SPECIFIED; // <.>
+ String fileAccept() default ""; // <.>
+ Where hidden() default Where.NOT_SPECIFIED; // <.>
+ int maxLength() default -1; // <.>
+ Snapshot snapshot() default Snapshot.NOT_SPECIFIED; // <.>
+ Class<? extends Specification>[] mustSatisfy() default {}; // <.>
+ Optionality optionality() default Optionality.NOT_SPECIFIED; // <.>
+ Projecting projecting() default Projecting.NOT_SPECIFIED; // <.>
+ String regexPattern() default ""; // <.>
+ int regexPatternFlags() default 0; // <.>
+ String regexPatternReplacement() default "Doesn't match pattern"; // <.>
}
----
@@ -105,14 +90,14 @@ Indicates where the property is not visible to the user.
--
The maximum entry length of a field.
-The default value (-1) indicates that no maxLength has been specified.
+The default value ( `-1) indicates that no maxLength has been specified.
--
<.> `[teal]#*_snapshot_*#` : `xref:system:generated:index/applib/annotation/Snapshot.adoc[Snapshot]`
+
--
Indicates whether the property should be included or excluded from mementos.
-To ensure that the property is actually not persisted in the objectstore, also annotate with the JDO annotationjavax.jdo.annotations.NotPersistent
+To ensure that the property is actually not persisted in the objectstore, also annotate with the JDO annotation `javax.jdo.annotations.NotPersistent
--
<.> `[teal]#*_mustSatisfy_*#` : `Class<? extends Specification>[]`
+
@@ -126,7 +111,7 @@ If more than one is provided, then all must be satisfied (in effect "AND"ed toge
--
Whether this property is optional or is mandatory (ie required).
-For properties the default value, _org.apache.isis.applib.annotation.Optionality#DEFAULT_ , usually means that the property is required unless it has been overridden byjavax.jdo.annotations.Columnwith itsjavax.jdo.annotations.Column#allowsNull()attribute set to true.
+For properties the default value, _org.apache.isis.applib.annotation.Optionality#DEFAULT_ , usually means that the property is required unless it has been overridden by `javax.jdo.annotations.Columnwith its `javax.jdo.annotations.Column#allowsNull()attribute set to true.
--
<.> `[teal]#*_projecting_*#` : `xref:system:generated:index/applib/annotation/Projecting.adoc[Projecting]`
+
@@ -147,7 +132,7 @@ Regular expression pattern that a value should conform to, and can be formatted
--
Pattern flags, as per _java.util.regex.Pattern#compile(String, int)_ .
-The default value,0, means that no flags have been specified.
+The default value, `0, means that no flags have been specified.
--
<.> `[teal]#*_regexPatternReplacement_*#` : `String`
+
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/PropertyLayout.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/PropertyLayout.adoc
index efca208..149053d 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/PropertyLayout.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/PropertyLayout.adoc
@@ -1,36 +1,25 @@
-= PropertyLayout : _annotation_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-Layout hints for properties.
+Collects together all layout hints for a property of a domain object.
-.Java Sources
+== API
+
+.PropertyLayout.java
[source,java]
----
@interface PropertyLayout {
-
- String cssClass() default ""; // <.>
-
- String describedAs() default ""; // <.>
-
- Where hidden() default Where.NOT_SPECIFIED; // <.>
-
- LabelPosition labelPosition() default LabelPosition.NOT_SPECIFIED; // <.>
-
- int multiLine() default -1; // <.>
-
- String named() default ""; // <.>
-
- boolean namedEscaped() default true; // <.>
-
- Navigable navigable() default Navigable.NOT_SPECIFIED; // <.>
-
- PromptStyle promptStyle() default PromptStyle.NOT_SPECIFIED; // <.>
-
- RenderDay renderDay() default RenderDay.NOT_SPECIFIED; // <.>
-
- Repainting repainting() default Repainting.NOT_SPECIFIED; // <.>
-
- int typicalLength() default -1; // <.>
+ String cssClass() default ""; // <.>
+ String describedAs() default ""; // <.>
+ Where hidden() default Where.NOT_SPECIFIED; // <.>
+ LabelPosition labelPosition() default LabelPosition.NOT_SPECIFIED; // <.>
+ int multiLine() default -1; // <.>
+ String named() default ""; // <.>
+ boolean namedEscaped() default true; // <.>
+ Navigable navigable() default Navigable.NOT_SPECIFIED; // <.>
+ PromptStyle promptStyle() default PromptStyle.NOT_SPECIFIED; // <.>
+ RenderDay renderDay() default RenderDay.NOT_SPECIFIED; // <.>
+ Repainting repainting() default Repainting.NOT_SPECIFIED; // <.>
+ int typicalLength() default -1; // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/Publishing.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/Publishing.adoc
index 2e55cba..2c52069 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/Publishing.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/Publishing.adoc
@@ -1,4 +1,3 @@
-= Publishing : _enum_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
The available policies as to whether data should be published to corresponding subscribers. The framework supports several kinds of data that are available for publishing:
@@ -16,18 +15,16 @@ The available policies as to whether data should be published to corresponding s
** * * *
-.Java Sources
+== API
+
+.Publishing.java
[source,java]
----
enum Publishing {
-
- AS_CONFIGURED // <.>
-
- ENABLED // <.>
-
- DISABLED // <.>
-
- NOT_SPECIFIED // <.>
+ AS_CONFIGURED // <.>
+ ENABLED // <.>
+ DISABLED // <.>
+ NOT_SPECIFIED // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/Redirect.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/Redirect.adoc
index e2d3ca0..22ddeaa 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/Redirect.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/Redirect.adoc
@@ -1,25 +1,23 @@
-= Redirect : _enum_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
The available policies for rendering the next page if the result is the same as the target (in other words, an action that returns "this").
-.Java Sources
+== API
+
+.Redirect.java
[source,java]
----
enum Redirect {
-
- AS_CONFIGURED // <.>
-
- EVEN_IF_SAME // <.>
-
- ONLY_IF_DIFFERS // <.>
+ AS_CONFIGURED // <.>
+ EVEN_IF_SAME // <.>
+ ONLY_IF_DIFFERS // <.>
}
----
<.> `[teal]#*_AS_CONFIGURED_*#`
+
--
-As defined by configuration propertyisis.viewer.wicket.redirectEvenIfSameObject
+As defined by configuration property `isis.viewer.wicket.redirectEvenIfSameObject
--
<.> `[teal]#*_EVEN_IF_SAME_*#`
+
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/RenderDay.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/RenderDay.adoc
index 8dcc301..f9867d4 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/RenderDay.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/RenderDay.adoc
@@ -1,18 +1,16 @@
-= RenderDay : _enum_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
How to render days.
-.Java Sources
+== API
+
+.RenderDay.java
[source,java]
----
enum RenderDay {
-
AS_DAY
-
- AS_DAY_BEFORE // <.>
-
- NOT_SPECIFIED // <.>
+ AS_DAY_BEFORE // <.>
+ NOT_SPECIFIED // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/Repainting.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/Repainting.adoc
index ebc6515..fbc6b5b 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/Repainting.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/Repainting.adoc
@@ -1,18 +1,16 @@
-= Repainting : _enum_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Whether a component is unchanging and so does not require repainting.
-.Java Sources
+== API
+
+.Repainting.java
[source,java]
----
enum Repainting {
-
REPAINT
-
- NO_REPAINT // <.>
-
- NOT_SPECIFIED // <.>
+ NO_REPAINT // <.>
+ NOT_SPECIFIED // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/RestrictTo.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/RestrictTo.adoc
index 092478b..4a30f8e 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/RestrictTo.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/RestrictTo.adoc
@@ -1,17 +1,15 @@
-= RestrictTo : _enum_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Whether an action is restricted to development mode, or available in all.
-.Java Sources
+== API
+
+.RestrictTo.java
[source,java]
----
enum RestrictTo {
-
PROTOTYPING
-
NO_RESTRICTIONS
-
NOT_SPECIFIED
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/SemanticsOf.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/SemanticsOf.adoc
index 99a9a20..b963acd 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/SemanticsOf.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/SemanticsOf.adoc
@@ -1,37 +1,24 @@
-= SemanticsOf : _enum_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.SemanticsOf.java
[source,java]
----
enum SemanticsOf {
-
- SAFE_AND_REQUEST_CACHEABLE // <.>
-
- SAFE // <.>
-
- IDEMPOTENT // <.>
-
- NON_IDEMPOTENT // <.>
-
- IDEMPOTENT_ARE_YOU_SURE // <.>
-
- NON_IDEMPOTENT_ARE_YOU_SURE // <.>
-
- NOT_SPECIFIED // <.>
-
+ SAFE_AND_REQUEST_CACHEABLE // <.>
+ SAFE // <.>
+ IDEMPOTENT // <.>
+ NON_IDEMPOTENT // <.>
+ IDEMPOTENT_ARE_YOU_SURE // <.>
+ NON_IDEMPOTENT_ARE_YOU_SURE // <.>
+ NOT_SPECIFIED // <.>
String getFriendlyName()
-
String getCamelCaseName()
-
- boolean isIdempotentInNature() // <.>
-
- boolean isSafeInNature() // <.>
-
- boolean isSafe() // <.>
-
+ boolean isIdempotentInNature() // <.>
+ boolean isSafeInNature() // <.>
+ boolean isSafe() // <.>
boolean isSafeAndRequestCacheable()
-
boolean isAreYouSure()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/Snapshot.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/Snapshot.adoc
index a76291e..4b6410b 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/Snapshot.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/Snapshot.adoc
@@ -1,18 +1,16 @@
-= Snapshot : _enum_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Whether the property is included if the domain object graph is serialized into a snapshot.
-.Java Sources
+== API
+
+.Snapshot.java
[source,java]
----
enum Snapshot {
-
- INCLUDED // <.>
-
- EXCLUDED // <.>
-
- NOT_SPECIFIED // <.>
+ INCLUDED // <.>
+ EXCLUDED // <.>
+ NOT_SPECIFIED // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/Title.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/Title.adoc
index 64b286a..f476117 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/Title.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/Title.adoc
@@ -1,20 +1,19 @@
-= Title : _annotation_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-A title annotation used to annotate methods used to construct the title of a domain object instance. It is used as a marker.
+Used to indicate which property or properties make up the object title.
-.Java Sources
+If more than one property is used, the order can be specified (using the same Dewey-decimal notation as used by `@MemberOrder`) and the string to use between the components can also be specified.
+
+== API
+
+.Title.java
[source,java]
----
@interface Title {
-
- String sequence() default "1.0"; // <.>
-
- String prepend() default " "; // <.>
-
- String append() default ""; // <.>
-
- int abbreviatedTo() default Integer.MAX_VALUE; // <.>
+ String sequence() default "1.0"; // <.>
+ String prepend() default " "; // <.>
+ String append() default ""; // <.>
+ int abbreviatedTo() default Integer.MAX_VALUE; // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/Value.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/Value.adoc
index dd4f605..8422b55 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/Value.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/Value.adoc
@@ -1,4 +1,3 @@
-= Value : _annotation_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Indicates that the class has value semantics.
@@ -14,14 +13,14 @@ By "value semantics" all we actually mean that the class is aggregated (or embed
Note also that though a value is conceptually not shared, if it is also immutable then it is in fact safe to share objects (as in the flyweight pattern). In addition, the xref:system:generated:index/applib/annotation/EqualByContent.adoc[EqualByContent] semantic means that we needn't care whether value types are being shared or not.
--
-.Java Sources
+== API
+
+.Value.java
[source,java]
----
@interface Value {
-
- String semanticsProviderName() default ""; // <.>
-
- Class<?> semanticsProviderClass() default Value.class; // <.>
+ String semanticsProviderName() default ""; // <.>
+ Class<?> semanticsProviderClass() default Value.class; // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/annotation/Where.adoc b/antora/components/system/modules/generated/pages/index/applib/annotation/Where.adoc
index bd33de7..c5e7ce7 100644
--- a/antora/components/system/modules/generated/pages/index/applib/annotation/Where.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/annotation/Where.adoc
@@ -1,4 +1,3 @@
-= Where : _enum_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Represents the location in the user interface where a class member is to be rendered.
@@ -7,38 +6,26 @@ Used to control visibility (eg using the _Property#hidden()_ annotation) and ena
The application programmer may use any of the values of this enum. Some represent concrete locations (eg _#OBJECT_FORMS_ , _#PARENTED_TABLES_ ), whereas some represent a combination of locations (eg _#ALL_TABLES_ , _#ANYWHERE_ ).
-.Java Sources
+== API
+
+.Where.java
[source,java]
----
enum Where {
-
- EVERYWHERE // <.>
-
- ANYWHERE // <.>
-
- OBJECT_FORMS // <.>
-
- REFERENCES_PARENT // <.>
-
- PARENTED_TABLES // <.>
-
- STANDALONE_TABLES // <.>
-
- ALL_TABLES // <.>
-
- ALL_EXCEPT_STANDALONE_TABLES // <.>
-
- NOWHERE // <.>
-
- NOT_SPECIFIED // <.>
-
+ EVERYWHERE // <.>
+ ANYWHERE // <.>
+ OBJECT_FORMS // <.>
+ REFERENCES_PARENT // <.>
+ PARENTED_TABLES // <.>
+ STANDALONE_TABLES // <.>
+ ALL_TABLES // <.>
+ ALL_EXCEPT_STANDALONE_TABLES // <.>
+ NOWHERE // <.>
+ NOT_SPECIFIED // <.>
String getFriendlyName()
-
boolean inParentedTable()
-
boolean inStandaloneTable()
-
- boolean includes(Where context) // <.>
+ boolean includes(Where context) // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/client/RepresentationTypeSimplifiedV2.adoc b/antora/components/system/modules/generated/pages/index/applib/client/RepresentationTypeSimplifiedV2.adoc
index dc19908..bfc2aa4 100644
--- a/antora/components/system/modules/generated/pages/index/applib/client/RepresentationTypeSimplifiedV2.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/client/RepresentationTypeSimplifiedV2.adoc
@@ -1,42 +1,27 @@
-= RepresentationTypeSimplifiedV2 : _enum_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.RepresentationTypeSimplifiedV2.java
[source,java]
----
enum RepresentationTypeSimplifiedV2 {
-
- OBJECT // <.>
-
- OBJECT_COLLECTION // <.>
-
- LIST // <.>
-
- VALUE // <.>
-
- VALUES // <.>
-
- VOID // <.>
-
+ OBJECT // <.>
+ OBJECT_COLLECTION // <.>
+ LIST // <.>
+ VALUE // <.>
+ VALUES // <.>
+ VOID // <.>
@Getter
final String typeLiteral;
-
boolean isObject()
-
boolean isObjectCollection()
-
boolean isList()
-
boolean isValue()
-
boolean isValues()
-
boolean isVoid()
-
String getContentTypeHeaderValue(final String profileName)
-
Optional<RepresentationTypeSimplifiedV2> parse(final String typeLiteral)
-
Optional<RepresentationTypeSimplifiedV2> parseContentTypeHeaderString(final String contentTypeHeaderString)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/client/SuppressionType.adoc b/antora/components/system/modules/generated/pages/index/applib/client/SuppressionType.adoc
index b850ce9..f888629 100644
--- a/antora/components/system/modules/generated/pages/index/applib/client/SuppressionType.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/client/SuppressionType.adoc
@@ -1,23 +1,17 @@
-= SuppressionType : _enum_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.SuppressionType.java
[source,java]
----
enum SuppressionType {
-
- RO // <.>
-
- HREF // <.>
-
- ID // <.>
-
- DOMAIN_TYPE // <.>
-
- TITLE // <.>
-
- ALL // <.>
-
+ RO // <.>
+ HREF // <.>
+ ID // <.>
+ DOMAIN_TYPE // <.>
+ TITLE // <.>
+ ALL // <.>
EnumSet<SuppressionType> setOf(SuppressionType... types)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/clock/VirtualClock.adoc b/antora/components/system/modules/generated/pages/index/applib/clock/VirtualClock.adoc
index da6c289..152ae2e 100644
--- a/antora/components/system/modules/generated/pages/index/applib/clock/VirtualClock.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/clock/VirtualClock.adoc
@@ -1,40 +1,27 @@
-= VirtualClock : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Works in connection with _org.apache.isis.core.interaction.session.InteractionFactory_ , such that it allows an xref:system:generated:index/applib/services/iactn/Interaction.adoc[Interaction] to run with its own simulated (or actual) time.
-.Java Sources
+== API
+
+.VirtualClock.java
[source,java]
----
interface VirtualClock {
-
- Instant now() // <.>
-
- VirtualClock system() // <.>
-
- VirtualClock nowAt(Instant virtualNow) // <.>
-
- VirtualClock frozenAt(Instant frozenAt) // <.>
-
- VirtualClock frozenTestClock() // <.>
-
- long getEpochMillis() // <.>
-
- LocalDate localDate(final ZoneId zoneId) // <.>
-
- LocalDateTime localDateTime(final ZoneId zoneId) // <.>
-
- OffsetDateTime offsetDateTime(final ZoneId zoneId) // <.>
-
+ Instant now() // <.>
+ VirtualClock system() // <.>
+ VirtualClock nowAt(Instant virtualNow) // <.>
+ VirtualClock frozenAt(Instant frozenAt) // <.>
+ VirtualClock frozenTestClock() // <.>
+ long getEpochMillis() // <.>
+ LocalDate localDate(final ZoneId zoneId) // <.>
+ LocalDateTime localDateTime(final ZoneId zoneId) // <.>
+ OffsetDateTime offsetDateTime(final ZoneId zoneId) // <.>
java.util.Date javaUtilDate()
-
java.sql.Timestamp javaSqlTimestamp()
-
XMLGregorianCalendar xmlGregorianCalendar()
-
- org.joda.time.DateTime asJodaDateTime(final ZoneId zoneId) // <.>
-
- org.joda.time.LocalDate asJodaLocalDate(final ZoneId zoneId) // <.>
+ org.joda.time.DateTime asJodaDateTime(final ZoneId zoneId) // <.>
+ org.joda.time.LocalDate asJodaLocalDate(final ZoneId zoneId) // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/domain/DomainObjectList.adoc b/antora/components/system/modules/generated/pages/index/applib/domain/DomainObjectList.adoc
index 7d8acc2..5718f81 100644
--- a/antora/components/system/modules/generated/pages/index/applib/domain/DomainObjectList.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/domain/DomainObjectList.adoc
@@ -1,4 +1,3 @@
-= DomainObjectList : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
The initial idea of xref:system:generated:index/applib/domain/DomainObjectList.adoc[DomainObjectList] was to simplify restful clients.
@@ -9,27 +8,20 @@ Instead, if the RO client invokes the action but uses the _Accept Header_ to req
Thus, the RO client then only ever needs to know how to render an object, in all cases.
-.Java Sources
+== API
+
+.DomainObjectList.java
[source,java]
----
class DomainObjectList {
-
DomainObjectList()
-
DomainObjectList(final String title, final String elementObjectType, final String actionOwningType, final String actionId, final String actionArguments)
-
String title()
-
String getElementObjectType()
-
String getActionOwningType()
-
String getActionId()
-
String getActionArguments()
-
List<Object> getObjects()
-
void setObjects(final List<Object> objects)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/events/EventObjectBase.adoc b/antora/components/system/modules/generated/pages/index/applib/events/EventObjectBase.adoc
index efbcc22..5212499 100644
--- a/antora/components/system/modules/generated/pages/index/applib/events/EventObjectBase.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/events/EventObjectBase.adoc
@@ -1,16 +1,14 @@
-= EventObjectBase : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.EventObjectBase.java
[source,java]
----
class EventObjectBase {
-
- T getSource() // <.>
-
- void initSource(T source) // <.>
-
- String toString() // <.>
+ T getSource() // <.>
+ void initSource(T source) // <.>
+ String toString() // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/events/domain/AbstractDomainEvent.adoc b/antora/components/system/modules/generated/pages/index/applib/events/domain/AbstractDomainEvent.adoc
index 4d8f4e1..7dce78f 100644
--- a/antora/components/system/modules/generated/pages/index/applib/events/domain/AbstractDomainEvent.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/events/domain/AbstractDomainEvent.adoc
@@ -1,45 +1,28 @@
-= AbstractDomainEvent : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.AbstractDomainEvent.java
[source,java]
----
class AbstractDomainEvent {
-
- AbstractDomainEvent() // <.>
-
+ AbstractDomainEvent() // <.>
AbstractDomainEvent(final S source, final Identifier identifier)
-
- void setMixedIn(final Object mixedIn) // <.>
-
- Object getSubject() // <.>
-
- void setEventPhase(Phase phase) // <.>
-
- void setIdentifier(final Identifier identifier) // <.>
-
- void hide() // <.>
-
+ void setMixedIn(final Object mixedIn) // <.>
+ Object getSubject() // <.>
+ void setEventPhase(Phase phase) // <.>
+ void setIdentifier(final Identifier identifier) // <.>
+ void hide() // <.>
boolean isDisabled()
-
- void disable(final String reason) // <.>
-
- void disable(final TranslatableString reason) // <.>
-
+ void disable(final String reason) // <.>
+ void disable(final TranslatableString reason) // <.>
boolean isInvalid()
-
- void invalidate(final String reason) // <.>
-
- void invalidate(final TranslatableString reason) // <.>
-
- void veto(final String reason, final Object... args) // <.>
-
- void veto(final TranslatableString translatableReason) // <.>
-
- Object get(Object key) // <.>
-
- void put(Object key, Object value) // <.>
-
+ void invalidate(final String reason) // <.>
+ void invalidate(final TranslatableString reason) // <.>
+ void veto(final String reason, final Object... args) // <.>
+ void veto(final TranslatableString translatableReason) // <.>
+ Object get(Object key) // <.>
+ void put(Object key, Object value) // <.>
String toString()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/events/domain/ActionDomainEvent.adoc b/antora/components/system/modules/generated/pages/index/applib/events/domain/ActionDomainEvent.adoc
index 92b46ef..82930d1 100644
--- a/antora/components/system/modules/generated/pages/index/applib/events/domain/ActionDomainEvent.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/events/domain/ActionDomainEvent.adoc
@@ -1,23 +1,17 @@
-= ActionDomainEvent : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.ActionDomainEvent.java
[source,java]
----
class ActionDomainEvent {
-
- ActionDomainEvent() // <.>
-
- void setReturnValue(final Object returnValue) // <.>
-
- void setSemantics(SemanticsOf semantics) // <.>
-
- void setParameterNames(final List<String> parameterNames) // <.>
-
- void setParameterTypes(final List<Class<?>> parameterTypes) // <.>
-
- void setMixedIn(final Object mixedIn) // <.>
-
+ ActionDomainEvent() // <.>
+ void setReturnValue(final Object returnValue) // <.>
+ void setSemantics(SemanticsOf semantics) // <.>
+ void setParameterNames(final List<String> parameterNames) // <.>
+ void setParameterTypes(final List<Class<?>> parameterTypes) // <.>
+ void setMixedIn(final Object mixedIn) // <.>
String toString()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/events/domain/CollectionDomainEvent.adoc b/antora/components/system/modules/generated/pages/index/applib/events/domain/CollectionDomainEvent.adoc
index 3a7d99c..34d0304 100644
--- a/antora/components/system/modules/generated/pages/index/applib/events/domain/CollectionDomainEvent.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/events/domain/CollectionDomainEvent.adoc
@@ -1,17 +1,14 @@
-= CollectionDomainEvent : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.CollectionDomainEvent.java
[source,java]
----
class CollectionDomainEvent {
-
- CollectionDomainEvent() // <.>
-
- void setValue(T value) // <.>
-
- void setOf(Of of) // <.>
-
+ CollectionDomainEvent() // <.>
+ void setValue(T value) // <.>
+ void setOf(Of of) // <.>
String toString()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/events/domain/PropertyDomainEvent.adoc b/antora/components/system/modules/generated/pages/index/applib/events/domain/PropertyDomainEvent.adoc
index 2ff1a1b..0794970 100644
--- a/antora/components/system/modules/generated/pages/index/applib/events/domain/PropertyDomainEvent.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/events/domain/PropertyDomainEvent.adoc
@@ -1,13 +1,12 @@
-= PropertyDomainEvent : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.PropertyDomainEvent.java
[source,java]
----
class PropertyDomainEvent {
-
- PropertyDomainEvent() // <.>
-
+ PropertyDomainEvent() // <.>
String toString()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/events/lifecycle/AbstractLifecycleEvent.adoc b/antora/components/system/modules/generated/pages/index/applib/events/lifecycle/AbstractLifecycleEvent.adoc
index ff1f13e..0ef9614 100644
--- a/antora/components/system/modules/generated/pages/index/applib/events/lifecycle/AbstractLifecycleEvent.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/events/lifecycle/AbstractLifecycleEvent.adoc
@@ -1,13 +1,12 @@
-= AbstractLifecycleEvent : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.AbstractLifecycleEvent.java
[source,java]
----
class AbstractLifecycleEvent {
-
AbstractLifecycleEvent()
-
AbstractLifecycleEvent(S source)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/events/lifecycle/ObjectCreatedEvent.adoc b/antora/components/system/modules/generated/pages/index/applib/events/lifecycle/ObjectCreatedEvent.adoc
index f4ef758..43ada75 100644
--- a/antora/components/system/modules/generated/pages/index/applib/events/lifecycle/ObjectCreatedEvent.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/events/lifecycle/ObjectCreatedEvent.adoc
@@ -1,13 +1,12 @@
-= ObjectCreatedEvent : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.ObjectCreatedEvent.java
[source,java]
----
class ObjectCreatedEvent {
-
ObjectCreatedEvent()
-
ObjectCreatedEvent(final S source)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/events/lifecycle/ObjectLoadedEvent.adoc b/antora/components/system/modules/generated/pages/index/applib/events/lifecycle/ObjectLoadedEvent.adoc
index 6728365..a61f65b 100644
--- a/antora/components/system/modules/generated/pages/index/applib/events/lifecycle/ObjectLoadedEvent.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/events/lifecycle/ObjectLoadedEvent.adoc
@@ -1,13 +1,12 @@
-= ObjectLoadedEvent : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.ObjectLoadedEvent.java
[source,java]
----
class ObjectLoadedEvent {
-
ObjectLoadedEvent()
-
ObjectLoadedEvent(final S source)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/events/lifecycle/ObjectPersistedEvent.adoc b/antora/components/system/modules/generated/pages/index/applib/events/lifecycle/ObjectPersistedEvent.adoc
index 020e2ee..6e9eafa 100644
--- a/antora/components/system/modules/generated/pages/index/applib/events/lifecycle/ObjectPersistedEvent.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/events/lifecycle/ObjectPersistedEvent.adoc
@@ -1,13 +1,12 @@
-= ObjectPersistedEvent : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.ObjectPersistedEvent.java
[source,java]
----
class ObjectPersistedEvent {
-
ObjectPersistedEvent()
-
ObjectPersistedEvent(final S source)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/events/lifecycle/ObjectPersistingEvent.adoc b/antora/components/system/modules/generated/pages/index/applib/events/lifecycle/ObjectPersistingEvent.adoc
index c3875c6..939ac43 100644
--- a/antora/components/system/modules/generated/pages/index/applib/events/lifecycle/ObjectPersistingEvent.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/events/lifecycle/ObjectPersistingEvent.adoc
@@ -1,13 +1,12 @@
-= ObjectPersistingEvent : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.ObjectPersistingEvent.java
[source,java]
----
class ObjectPersistingEvent {
-
ObjectPersistingEvent()
-
ObjectPersistingEvent(final S source)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/events/lifecycle/ObjectRemovingEvent.adoc b/antora/components/system/modules/generated/pages/index/applib/events/lifecycle/ObjectRemovingEvent.adoc
index 5505aea..6906722 100644
--- a/antora/components/system/modules/generated/pages/index/applib/events/lifecycle/ObjectRemovingEvent.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/events/lifecycle/ObjectRemovingEvent.adoc
@@ -1,13 +1,12 @@
-= ObjectRemovingEvent : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.ObjectRemovingEvent.java
[source,java]
----
class ObjectRemovingEvent {
-
ObjectRemovingEvent()
-
ObjectRemovingEvent(final S source)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/events/lifecycle/ObjectUpdatedEvent.adoc b/antora/components/system/modules/generated/pages/index/applib/events/lifecycle/ObjectUpdatedEvent.adoc
index 06567b2..cb65f26 100644
--- a/antora/components/system/modules/generated/pages/index/applib/events/lifecycle/ObjectUpdatedEvent.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/events/lifecycle/ObjectUpdatedEvent.adoc
@@ -1,13 +1,12 @@
-= ObjectUpdatedEvent : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.ObjectUpdatedEvent.java
[source,java]
----
class ObjectUpdatedEvent {
-
ObjectUpdatedEvent()
-
ObjectUpdatedEvent(final S source)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/events/lifecycle/ObjectUpdatingEvent.adoc b/antora/components/system/modules/generated/pages/index/applib/events/lifecycle/ObjectUpdatingEvent.adoc
index d9dd0db..44ea69e 100644
--- a/antora/components/system/modules/generated/pages/index/applib/events/lifecycle/ObjectUpdatingEvent.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/events/lifecycle/ObjectUpdatingEvent.adoc
@@ -1,13 +1,12 @@
-= ObjectUpdatingEvent : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.ObjectUpdatingEvent.java
[source,java]
----
class ObjectUpdatingEvent {
-
ObjectUpdatingEvent()
-
ObjectUpdatingEvent(final S source)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/events/ui/AbstractUiEvent.adoc b/antora/components/system/modules/generated/pages/index/applib/events/ui/AbstractUiEvent.adoc
index 4973f89..e76cb69 100644
--- a/antora/components/system/modules/generated/pages/index/applib/events/ui/AbstractUiEvent.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/events/ui/AbstractUiEvent.adoc
@@ -1,18 +1,15 @@
-= AbstractUiEvent : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.AbstractUiEvent.java
[source,java]
----
class AbstractUiEvent {
-
- AbstractUiEvent() // <.>
-
+ AbstractUiEvent() // <.>
AbstractUiEvent(final S source)
-
- Object get(Object key) // <.>
-
- void put(Object key, Object value) // <.>
+ Object get(Object key) // <.>
+ void put(Object key, Object value) // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/events/ui/CssClassUiEvent.adoc b/antora/components/system/modules/generated/pages/index/applib/events/ui/CssClassUiEvent.adoc
index f7c1084..1c6a5ea 100644
--- a/antora/components/system/modules/generated/pages/index/applib/events/ui/CssClassUiEvent.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/events/ui/CssClassUiEvent.adoc
@@ -1,18 +1,16 @@
-= CssClassUiEvent : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Emitted for subscribers to obtain a cssClass hint (equivalent to the `cssClass()` supporting method or the _DomainObjectLayout#cssClass()_ attribute).
-.Java Sources
+== API
+
+.CssClassUiEvent.java
[source,java]
----
class CssClassUiEvent {
-
- CssClassUiEvent() // <.>
-
+ CssClassUiEvent() // <.>
CssClassUiEvent(final S source)
-
- void setCssClass(final String cssClass) // <.>
+ void setCssClass(final String cssClass) // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/events/ui/IconUiEvent.adoc b/antora/components/system/modules/generated/pages/index/applib/events/ui/IconUiEvent.adoc
index a5e7d2c..99b0f8e 100644
--- a/antora/components/system/modules/generated/pages/index/applib/events/ui/IconUiEvent.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/events/ui/IconUiEvent.adoc
@@ -1,20 +1,17 @@
-= IconUiEvent : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Emitted for subscribers to obtain a cssClass hint (equivalent to the `iconName()` supporting method).
-.Java Sources
+== API
+
+.IconUiEvent.java
[source,java]
----
class IconUiEvent {
-
- IconUiEvent() // <.>
-
+ IconUiEvent() // <.>
IconUiEvent(final S source)
-
- String getIconName() // <.>
-
- void setIconName(final String iconName) // <.>
+ String getIconName() // <.>
+ void setIconName(final String iconName) // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/events/ui/LayoutUiEvent.adoc b/antora/components/system/modules/generated/pages/index/applib/events/ui/LayoutUiEvent.adoc
index d4736cc..200f3d2 100644
--- a/antora/components/system/modules/generated/pages/index/applib/events/ui/LayoutUiEvent.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/events/ui/LayoutUiEvent.adoc
@@ -1,18 +1,16 @@
-= LayoutUiEvent : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Emitted for subscribers to obtain a layout hint (equivalent to the `layout()` supporting method).
-.Java Sources
+== API
+
+.LayoutUiEvent.java
[source,java]
----
class LayoutUiEvent {
-
- LayoutUiEvent() // <.>
-
+ LayoutUiEvent() // <.>
LayoutUiEvent(final S source)
-
- void setLayout(final String layout) // <.>
+ void setLayout(final String layout) // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/events/ui/TitleUiEvent.adoc b/antora/components/system/modules/generated/pages/index/applib/events/ui/TitleUiEvent.adoc
index d01c31e..52e9670 100644
--- a/antora/components/system/modules/generated/pages/index/applib/events/ui/TitleUiEvent.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/events/ui/TitleUiEvent.adoc
@@ -1,20 +1,17 @@
-= TitleUiEvent : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Emitted for subscribers to obtain a cssClass hint (equivalent to the `title()` supporting method).
-.Java Sources
+== API
+
+.TitleUiEvent.java
[source,java]
----
class TitleUiEvent {
-
- TitleUiEvent() // <.>
-
+ TitleUiEvent() // <.>
TitleUiEvent(final S source)
-
- void setTitle(final String title) // <.>
-
- void setTranslatableTitle(final TranslatableString translatableTitle) // <.>
+ void setTitle(final String title) // <.>
+ void setTranslatableTitle(final TranslatableString translatableTitle) // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/exceptions/RecoverableException.adoc b/antora/components/system/modules/generated/pages/index/applib/exceptions/RecoverableException.adoc
index fd4714a..501e255 100644
--- a/antora/components/system/modules/generated/pages/index/applib/exceptions/RecoverableException.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/exceptions/RecoverableException.adoc
@@ -1,4 +1,3 @@
-= RecoverableException : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Indicates that an exceptional condition/problem has occurred within the application's domain logic.
@@ -9,25 +8,19 @@ This exception should only be thrown for "recoverable" exceptions, that is, thos
The framework attempts to apply some heuristics; if the underlying Isis transaction has been aborted (for example as the result of a problem persisting some data) but then the application attempts to throw this exception, the exception will be promoted to a fatal exception.
-.Java Sources
+== API
+
+.RecoverableException.java
[source,java]
----
class RecoverableException {
-
RecoverableException(final String msg)
-
RecoverableException(final TranslatableString translatableMessage, final Class<?> translationContextClass, final String translationContextMethod)
-
RecoverableException(final Throwable cause)
-
RecoverableException(final String msg, final Throwable cause)
-
RecoverableException(final TranslatableString translatableMessage, final Class<?> translationContextClass, final String translationContextMethod, final Throwable cause)
-
String getMessage()
-
TranslatableString getTranslatableMessage()
-
String getTranslationContext()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/exceptions/TranslatableException.adoc b/antora/components/system/modules/generated/pages/index/applib/exceptions/TranslatableException.adoc
index 616a0e4..289f83a 100644
--- a/antora/components/system/modules/generated/pages/index/applib/exceptions/TranslatableException.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/exceptions/TranslatableException.adoc
@@ -1,18 +1,17 @@
-= TranslatableException : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Exceptions that provide translations should implement this interface.
-The _org.apache.isis.applib.services.exceprecog.ExceptionRecognizer_ will automatically detect and use the translation. In addition, the integration testing support provides a rule (ExceptionRecognizerTranslations) that will exercise any thrown exceptions, ensuring tha the message is captured in thetranslations.pofile so that it can be translated.
+The _org.apache.isis.applib.services.exceprecog.ExceptionRecognizer_ will automatically detect and use the translation. In addition, the integration testing support provides a rule ( `ExceptionRecognizerTranslations) that will exercise any thrown exceptions, ensuring tha the message is captured in the `translations.pofile so that it can be translated.
-.Java Sources
+== API
+
+.TranslatableException.java
[source,java]
----
interface TranslatableException {
-
- TranslatableString getTranslatableMessage() // <.>
-
- String getTranslationContext() // <.>
+ TranslatableString getTranslatableMessage() // <.>
+ String getTranslationContext() // <.>
}
----
@@ -21,7 +20,7 @@ interface TranslatableException {
--
In the spirit of _Exception#getLocalizedMessage()_ , but using xref:system:generated:index/applib/services/i18n/TranslatableString.adoc[TranslatableString] instead.
-If returnsnull, then _Exception#getMessage()_ will be used as a fallback. This design allows the Isis-provided xref:system:generated:index/applib/exceptions/RecoverableException.adoc[RecoverableException] and xref:system:generated:index/applib/exceptions/UnrecoverableException.adoc[UnrecoverableException] to provide constructors that accept a xref:system:generated:index/applib/services/i18n/TranslatableString.adoc[TranslatableString] , but can be left as null for any existing code.
+If returns `null, then _Exception#getMessage()_ will be used as a fallback. This design allows the Isis-provided xref:system:generated:index/applib/exceptions/RecoverableException.adoc[RecoverableException] and xref:system:generated:index/applib/exceptions/UnrecoverableException.adoc[UnrecoverableException] to provide constructors that accept a xref:system:generated:index/applib/services/i18n/TranslatableString.adoc[TranslatableString] , but can be left as null for any existing code.
--
<.> `[teal]#*getTranslationContext*#()` : `String`
+
diff --git a/antora/components/system/modules/generated/pages/index/applib/exceptions/UnrecoverableException.adoc b/antora/components/system/modules/generated/pages/index/applib/exceptions/UnrecoverableException.adoc
index d427f2f..508a0b7 100644
--- a/antora/components/system/modules/generated/pages/index/applib/exceptions/UnrecoverableException.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/exceptions/UnrecoverableException.adoc
@@ -1,29 +1,22 @@
-= UnrecoverableException : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Indicates that an unexpected, non-recoverable (fatal) exception has occurred within the application logic.
Throwing this exception will (dependent on the viewer) result in some sort of an error page being displayed to the user.
-.Java Sources
+== API
+
+.UnrecoverableException.java
[source,java]
----
class UnrecoverableException {
-
UnrecoverableException(final String msg)
-
UnrecoverableException(final TranslatableString translatableMessage, final Class<?> translationContextClass, final String translationContextMethod)
-
UnrecoverableException(final Throwable cause)
-
UnrecoverableException(final String msg, final Throwable cause)
-
UnrecoverableException(final TranslatableString translatableMessage, final Class<?> translationContextClass, final String translationContextMethod, final Throwable cause)
-
String getMessage()
-
TranslatableString getTranslatableMessage()
-
String getTranslationContext()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/DomainModelException.adoc b/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/DomainModelException.adoc
index 96e065b..d1c84ab 100644
--- a/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/DomainModelException.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/DomainModelException.adoc
@@ -1,17 +1,15 @@
-= DomainModelException : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Thrown when a problem is found with the domain model, and Isis cannot proceed.
-.Java Sources
+== API
+
+.DomainModelException.java
[source,java]
----
class DomainModelException {
-
DomainModelException(final String message)
-
DomainModelException(final Throwable cause)
-
DomainModelException(final String message, final Throwable cause)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/MetaModelException.adoc b/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/MetaModelException.adoc
index ed63d06..8a5c99f 100644
--- a/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/MetaModelException.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/MetaModelException.adoc
@@ -1,15 +1,13 @@
-= MetaModelException : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.MetaModelException.java
[source,java]
----
class MetaModelException {
-
MetaModelException(final String message)
-
MetaModelException(final Throwable cause)
-
MetaModelException(final String message, final Throwable cause)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/NoAuthenticatorException.adoc b/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/NoAuthenticatorException.adoc
index d9df14e..1ce5a3f 100644
--- a/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/NoAuthenticatorException.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/NoAuthenticatorException.adoc
@@ -1,17 +1,15 @@
-= NoAuthenticatorException : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Indicates that there is no Authenticator available to authenticate a user based on this request.
-.Java Sources
+== API
+
+.NoAuthenticatorException.java
[source,java]
----
class NoAuthenticatorException {
-
NoAuthenticatorException(final String msg)
-
NoAuthenticatorException(final String msg, final Throwable cause)
-
NoAuthenticatorException(final Throwable cause)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/ObjectNotFoundException.adoc b/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/ObjectNotFoundException.adoc
index 2370806..dccfc74 100644
--- a/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/ObjectNotFoundException.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/ObjectNotFoundException.adoc
@@ -1,15 +1,14 @@
-= ObjectNotFoundException : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Indicates that the persistence context was unable to get an instantiate for the specified object identifier.
-.Java Sources
+== API
+
+.ObjectNotFoundException.java
[source,java]
----
class ObjectNotFoundException {
-
ObjectNotFoundException(final String oid)
-
ObjectNotFoundException(final String oid, final Throwable cause)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/ObjectPersistenceException.adoc b/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/ObjectPersistenceException.adoc
index a1440ad..42f8655 100644
--- a/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/ObjectPersistenceException.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/ObjectPersistenceException.adoc
@@ -1,15 +1,13 @@
-= ObjectPersistenceException : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.ObjectPersistenceException.java
[source,java]
----
class ObjectPersistenceException {
-
ObjectPersistenceException(final String message)
-
ObjectPersistenceException(final String message, final Throwable cause)
-
ObjectPersistenceException(final Throwable cause)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/PersistFailedException.adoc b/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/PersistFailedException.adoc
index 72684d1..8695e9f 100644
--- a/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/PersistFailedException.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/PersistFailedException.adoc
@@ -1,19 +1,17 @@
-= PersistFailedException : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Indicates that the persistence of an object failed.
This exception is intended to represent an unexpected and non-recoverable condition (eg a unique/primary key/ foreign key constaint has been violated), and so is a subclass of xref:system:generated:index/applib/exceptions/UnrecoverableException.adoc[UnrecoverableException] . Throwing this exception will therefore result in (some sort of) error page being displayed to the user.
-.Java Sources
+== API
+
+.PersistFailedException.java
[source,java]
----
class PersistFailedException {
-
PersistFailedException(final String msg)
-
PersistFailedException(final Throwable cause)
-
PersistFailedException(final String msg, final Throwable cause)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/ReflectiveActionException.adoc b/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/ReflectiveActionException.adoc
index ff7f3b4..89956fa 100644
--- a/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/ReflectiveActionException.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/ReflectiveActionException.adoc
@@ -1,15 +1,13 @@
-= ReflectiveActionException : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.ReflectiveActionException.java
[source,java]
----
class ReflectiveActionException {
-
ReflectiveActionException(final String msg)
-
ReflectiveActionException(final Throwable cause)
-
ReflectiveActionException(final String msg, final Throwable cause)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/RepositoryException.adoc b/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/RepositoryException.adoc
index c7d396d..c4d213f 100644
--- a/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/RepositoryException.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/RepositoryException.adoc
@@ -1,19 +1,17 @@
-= RepositoryException : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Indicates that a repository method has failed.
This exception is intended to represent an unexpected and non-recoverable condition (eg a syntax error in some JDOQL query syntax or similar), and so is a subclass of xref:system:generated:index/applib/exceptions/UnrecoverableException.adoc[UnrecoverableException] . Throwing this exception will therefore result in (some sort of) error page being displayed to the user.
-.Java Sources
+== API
+
+.RepositoryException.java
[source,java]
----
class RepositoryException {
-
RepositoryException(final String msg)
-
RepositoryException(final Throwable cause)
-
RepositoryException(final String msg, final Throwable cause)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/UnexpectedCallException.adoc b/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/UnexpectedCallException.adoc
index 710b0b1..a0a3865 100644
--- a/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/UnexpectedCallException.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/UnexpectedCallException.adoc
@@ -1,13 +1,13 @@
-= UnexpectedCallException : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Indicates that a call was made to a method (normally an overridden one) that was not expected, and hence not coded for.
-.Java Sources
+== API
+
+.UnexpectedCallException.java
[source,java]
----
class UnexpectedCallException {
-
UnexpectedCallException()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/UnknownTypeException.adoc b/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/UnknownTypeException.adoc
index 4d74df1..13b4e84 100644
--- a/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/UnknownTypeException.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/exceptions/unrecoverable/UnknownTypeException.adoc
@@ -1,13 +1,12 @@
-= UnknownTypeException : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.UnknownTypeException.java
[source,java]
----
class UnknownTypeException {
-
UnknownTypeException(final String message)
-
UnknownTypeException(final Object object)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/graph/Edge.adoc b/antora/components/system/modules/generated/pages/index/applib/graph/Edge.adoc
index d24be2c..99d5dd7 100644
--- a/antora/components/system/modules/generated/pages/index/applib/graph/Edge.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/graph/Edge.adoc
@@ -1,15 +1,14 @@
-= Edge : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Fundamental building block for graph structures.
-.Java Sources
+== API
+
+.Edge.java
[source,java]
----
interface Edge {
-
Vertex<T> getFrom()
-
Vertex<T> getTo()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/graph/SimpleEdge.adoc b/antora/components/system/modules/generated/pages/index/applib/graph/SimpleEdge.adoc
index 62edb76..cda939b 100644
--- a/antora/components/system/modules/generated/pages/index/applib/graph/SimpleEdge.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/graph/SimpleEdge.adoc
@@ -1,15 +1,14 @@
-= SimpleEdge : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Fundamental building block for graph structures.
-.Java Sources
+== API
+
+.SimpleEdge.java
[source,java]
----
class SimpleEdge {
-
Vertex<T> from;
-
Vertex<T> to;
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/graph/Vertex.adoc b/antora/components/system/modules/generated/pages/index/applib/graph/Vertex.adoc
index 07ef4f3..86700f2 100644
--- a/antora/components/system/modules/generated/pages/index/applib/graph/Vertex.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/graph/Vertex.adoc
@@ -1,21 +1,17 @@
-= Vertex : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Fundamental building block for graph structures.
-.Java Sources
+== API
+
+.Vertex.java
[source,java]
----
interface Vertex {
-
T getValue()
-
int getIncomingCount()
-
int getOutgoingCount()
-
Stream<Edge<T>> streamIncoming()
-
Stream<Edge<T>> streamOutgoing()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/graph/tree/LazyTreeNode.adoc b/antora/components/system/modules/generated/pages/index/applib/graph/tree/LazyTreeNode.adoc
index d88f4ac..568fb3c 100644
--- a/antora/components/system/modules/generated/pages/index/applib/graph/tree/LazyTreeNode.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/graph/tree/LazyTreeNode.adoc
@@ -1,25 +1,18 @@
-= LazyTreeNode : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.LazyTreeNode.java
[source,java]
----
class LazyTreeNode {
-
TreeNode<T> of(T value, Class<? extends TreeAdapter<T>> treeAdapterClass, TreeState sharedState)
-
T getValue()
-
TreeNode<T> getParentIfAny()
-
int getChildCount()
-
Stream<TreeNode<T>> streamChildren()
-
Class<? extends TreeAdapter<T>> getTreeAdapterClass()
-
TreePath getPositionAsPath()
-
TreeState getTreeState()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/graph/tree/TreeAdapter.adoc b/antora/components/system/modules/generated/pages/index/applib/graph/tree/TreeAdapter.adoc
index 151c40f..a896081 100644
--- a/antora/components/system/modules/generated/pages/index/applib/graph/tree/TreeAdapter.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/graph/tree/TreeAdapter.adoc
@@ -1,18 +1,16 @@
-= TreeAdapter : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Provides the parent/child relationship information between pojos to derive a tree-structure.
-.Java Sources
+== API
+
+.TreeAdapter.java
[source,java]
----
interface TreeAdapter {
-
- Optional<T> parentOf(T value) // <.>
-
- int childCountOf(T value) // <.>
-
- Stream<T> childrenOf(T value) // <.>
+ Optional<T> parentOf(T value) // <.>
+ int childCountOf(T value) // <.>
+ Stream<T> childrenOf(T value) // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/graph/tree/TreeNode.adoc b/antora/components/system/modules/generated/pages/index/applib/graph/tree/TreeNode.adoc
index d2bddc7..2d89470 100644
--- a/antora/components/system/modules/generated/pages/index/applib/graph/tree/TreeNode.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/graph/tree/TreeNode.adoc
@@ -1,56 +1,35 @@
-= TreeNode : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Fundamental building block of Tree structures.
-.Java Sources
+== API
+
+.TreeNode.java
[source,java]
----
interface TreeNode {
-
int getIncomingCount()
-
int getOutgoingCount()
-
Stream<Edge<T>> streamIncoming()
-
Stream<Edge<T>> streamOutgoing()
-
TreeNode<T> getParentIfAny()
-
int getChildCount()
-
Stream<TreeNode<T>> streamChildren()
-
boolean isRoot()
-
boolean isLeaf()
-
TreePath getPositionAsPath()
-
- TreeState getTreeState() // <.>
-
+ TreeState getTreeState() // <.>
boolean isExpanded(TreePath treePath)
-
- void expand(TreePath... treePaths) // <.>
-
- void collapse(TreePath... treePaths) // <.>
-
- TreeNode<T> lazy(T node, Class<? extends TreeAdapter<T>> treeAdapterClass) // <.>
-
+ void expand(TreePath... treePaths) // <.>
+ void collapse(TreePath... treePaths) // <.>
+ TreeNode<T> lazy(T node, Class<? extends TreeAdapter<T>> treeAdapterClass) // <.>
Iterator<TreeNode<T>> iteratorHierarchyUp()
-
Stream<TreeNode<T>> streamHierarchyUp()
-
Iterator<TreeNode<T>> iteratorDepthFirst()
-
Iterator<TreeNode<T>> iteratorBreadthFirst()
-
Stream<TreeNode<T>> streamDepthFirst()
-
Stream<TreeNode<T>> streamBreadthFirst()
-
- Class<? extends TreeAdapter<T>> getTreeAdapterClass() // <.>
+ Class<? extends TreeAdapter<T>> getTreeAdapterClass() // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/graph/tree/TreePath.adoc b/antora/components/system/modules/generated/pages/index/applib/graph/tree/TreePath.adoc
index bcc3163..515a13d 100644
--- a/antora/components/system/modules/generated/pages/index/applib/graph/tree/TreePath.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/graph/tree/TreePath.adoc
@@ -1,4 +1,3 @@
-= TreePath : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Provides an unambiguous way to address nodes by position within a tree-structure. Examples:
@@ -7,19 +6,16 @@ Provides an unambiguous way to address nodes by position within a tree-structure
* /0/1 ... the second child of root
* /0/0/0 ... the first child of first child of root
-.Java Sources
+== API
+
+.TreePath.java
[source,java]
----
interface TreePath {
-
- TreePath append(int indexWithinSiblings) // <.>
-
- TreePath getParentIfAny() // <.>
-
+ TreePath append(int indexWithinSiblings) // <.>
+ TreePath getParentIfAny() // <.>
boolean isRoot()
-
TreePath of(final int... canonicalPath)
-
TreePath root()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/graph/tree/TreeState.adoc b/antora/components/system/modules/generated/pages/index/applib/graph/tree/TreeState.adoc
index c341859..f07c278 100644
--- a/antora/components/system/modules/generated/pages/index/applib/graph/tree/TreeState.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/graph/tree/TreeState.adoc
@@ -1,13 +1,12 @@
-= TreeState : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.TreeState.java
[source,java]
----
interface TreeState {
-
TreeState rootCollapsed()
-
Set<TreePath> getExpandedNodePaths()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/jaxb/DataTypeFactory.adoc b/antora/components/system/modules/generated/pages/index/applib/jaxb/DataTypeFactory.adoc
index 397b841..dd623ba 100644
--- a/antora/components/system/modules/generated/pages/index/applib/jaxb/DataTypeFactory.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/jaxb/DataTypeFactory.adoc
@@ -1,11 +1,11 @@
-= DataTypeFactory : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.DataTypeFactory.java
[source,java]
----
class DataTypeFactory {
-
XMLGregorianCalendar withTypeFactoryDo(Function<DatatypeFactory, XMLGregorianCalendar> factory)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/jaxb/JavaSqlJaxbAdapters.adoc b/antora/components/system/modules/generated/pages/index/applib/jaxb/JavaSqlJaxbAdapters.adoc
index 2462526..f95321e 100644
--- a/antora/components/system/modules/generated/pages/index/applib/jaxb/JavaSqlJaxbAdapters.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/jaxb/JavaSqlJaxbAdapters.adoc
@@ -1,4 +1,3 @@
-= JavaSqlJaxbAdapters : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Provides JAXB XmlAdapters for java sql temporal types.
@@ -11,7 +10,9 @@ Example:
@Getter @Setter private java.sql.Date date;
----
-.Java Sources
+== API
+
+.JavaSqlJaxbAdapters.java
[source,java]
----
class JavaSqlJaxbAdapters {
diff --git a/antora/components/system/modules/generated/pages/index/applib/jaxb/JavaSqlXMLGregorianCalendarMarshalling.adoc b/antora/components/system/modules/generated/pages/index/applib/jaxb/JavaSqlXMLGregorianCalendarMarshalling.adoc
index d72a8d4..29dc7f1 100644
--- a/antora/components/system/modules/generated/pages/index/applib/jaxb/JavaSqlXMLGregorianCalendarMarshalling.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/jaxb/JavaSqlXMLGregorianCalendarMarshalling.adoc
@@ -1,15 +1,13 @@
-= JavaSqlXMLGregorianCalendarMarshalling : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.JavaSqlXMLGregorianCalendarMarshalling.java
[source,java]
----
class JavaSqlXMLGregorianCalendarMarshalling {
-
static DatatypeFactory datatypeFactory;
-
Timestamp toTimestamp(final XMLGregorianCalendar calendar)
-
XMLGregorianCalendar toXMLGregorianCalendar(final Timestamp timestamp)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/jaxb/JavaTimeJaxbAdapters.adoc b/antora/components/system/modules/generated/pages/index/applib/jaxb/JavaTimeJaxbAdapters.adoc
index d8bc925..b22cba7 100644
--- a/antora/components/system/modules/generated/pages/index/applib/jaxb/JavaTimeJaxbAdapters.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/jaxb/JavaTimeJaxbAdapters.adoc
@@ -1,4 +1,3 @@
-= JavaTimeJaxbAdapters : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Provides JAXB XmlAdapters for Java time temporal types.
@@ -11,7 +10,9 @@ Example:
@Getter @Setter private java.time.LocalDate localDate;
----
-.Java Sources
+== API
+
+.JavaTimeJaxbAdapters.java
[source,java]
----
class JavaTimeJaxbAdapters {
diff --git a/antora/components/system/modules/generated/pages/index/applib/jaxb/JavaTimeXMLGregorianCalendarMarshalling.adoc b/antora/components/system/modules/generated/pages/index/applib/jaxb/JavaTimeXMLGregorianCalendarMarshalling.adoc
index 9bd8487..a6c7b95 100644
--- a/antora/components/system/modules/generated/pages/index/applib/jaxb/JavaTimeXMLGregorianCalendarMarshalling.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/jaxb/JavaTimeXMLGregorianCalendarMarshalling.adoc
@@ -1,33 +1,22 @@
-= JavaTimeXMLGregorianCalendarMarshalling : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.JavaTimeXMLGregorianCalendarMarshalling.java
[source,java]
----
class JavaTimeXMLGregorianCalendarMarshalling {
-
LocalDate toLocalDate(XMLGregorianCalendar cal)
-
LocalTime toLocalTime(XMLGregorianCalendar cal)
-
LocalDateTime toLocalDateTime(XMLGregorianCalendar cal)
-
OffsetDateTime toOffsetDateTime(XMLGregorianCalendar cal)
-
OffsetTime toOffsetTime(XMLGregorianCalendar cal)
-
ZonedDateTime toZonedDateTime(XMLGregorianCalendar cal)
-
XMLGregorianCalendar toXMLGregorianCalendar2(LocalDate localDate)
-
XMLGregorianCalendar toXMLGregorianCalendar2(LocalTime localTime)
-
XMLGregorianCalendar toXMLGregorianCalendar2(LocalDateTime localDateTime)
-
XMLGregorianCalendar toXMLGregorianCalendar2(OffsetTime offsetTime)
-
XMLGregorianCalendar toXMLGregorianCalendar2(OffsetDateTime offsetDateTime)
-
XMLGregorianCalendar toXMLGregorianCalendar2(ZonedDateTime zonedDateTime)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/jaxb/JavaUtilJaxbAdapters.adoc b/antora/components/system/modules/generated/pages/index/applib/jaxb/JavaUtilJaxbAdapters.adoc
index 69953f2..14fa60b 100644
--- a/antora/components/system/modules/generated/pages/index/applib/jaxb/JavaUtilJaxbAdapters.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/jaxb/JavaUtilJaxbAdapters.adoc
@@ -1,4 +1,3 @@
-= JavaUtilJaxbAdapters : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Provides JAXB XmlAdapters for Java util temporal types.
@@ -11,7 +10,9 @@ Example:
@Getter @Setter private java.utilDate javaLocalDate;
----
-.Java Sources
+== API
+
+.JavaUtilJaxbAdapters.java
[source,java]
----
class JavaUtilJaxbAdapters {
diff --git a/antora/components/system/modules/generated/pages/index/applib/jaxb/JodaTimeJaxbAdapters.adoc b/antora/components/system/modules/generated/pages/index/applib/jaxb/JodaTimeJaxbAdapters.adoc
index e4214a2..0f35777 100644
--- a/antora/components/system/modules/generated/pages/index/applib/jaxb/JodaTimeJaxbAdapters.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/jaxb/JodaTimeJaxbAdapters.adoc
@@ -1,7 +1,8 @@
-= JodaTimeJaxbAdapters : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.JodaTimeJaxbAdapters.java
[source,java]
----
class JodaTimeJaxbAdapters {
diff --git a/antora/components/system/modules/generated/pages/index/applib/jaxb/JodaTimeXMLGregorianCalendarMarshalling.adoc b/antora/components/system/modules/generated/pages/index/applib/jaxb/JodaTimeXMLGregorianCalendarMarshalling.adoc
index 5b57426..fe044bb 100644
--- a/antora/components/system/modules/generated/pages/index/applib/jaxb/JodaTimeXMLGregorianCalendarMarshalling.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/jaxb/JodaTimeXMLGregorianCalendarMarshalling.adoc
@@ -1,25 +1,18 @@
-= JodaTimeXMLGregorianCalendarMarshalling : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.JodaTimeXMLGregorianCalendarMarshalling.java
[source,java]
----
class JodaTimeXMLGregorianCalendarMarshalling {
-
DateTime toDateTime(final XMLGregorianCalendar xgc)
-
LocalDate toLocalDate(final XMLGregorianCalendar xgc)
-
LocalDateTime toLocalDateTime(final XMLGregorianCalendar xgc)
-
LocalTime toLocalTime(final XMLGregorianCalendar xgc)
-
XMLGregorianCalendar toXMLGregorianCalendar(DateTime dateTime)
-
XMLGregorianCalendar toXMLGregorianCalendar(final LocalDateTime localDateTime)
-
XMLGregorianCalendar toXMLGregorianCalendar(final LocalDate localDate)
-
XMLGregorianCalendar toXMLGregorianCalendar(final LocalTime localTime)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/jaxb/PersistentEntitiesAdapter.adoc b/antora/components/system/modules/generated/pages/index/applib/jaxb/PersistentEntitiesAdapter.adoc
index 1d51290..b53c3ae 100644
--- a/antora/components/system/modules/generated/pages/index/applib/jaxb/PersistentEntitiesAdapter.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/jaxb/PersistentEntitiesAdapter.adoc
@@ -1,13 +1,12 @@
-= PersistentEntitiesAdapter : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.PersistentEntitiesAdapter.java
[source,java]
----
class PersistentEntitiesAdapter {
-
List<Object> unmarshal(final OidsDto oidsDto)
-
OidsDto marshal(final List<Object> domainObjects)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/jaxb/PersistentEntityAdapter.adoc b/antora/components/system/modules/generated/pages/index/applib/jaxb/PersistentEntityAdapter.adoc
index f429e5e..0451289 100644
--- a/antora/components/system/modules/generated/pages/index/applib/jaxb/PersistentEntityAdapter.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/jaxb/PersistentEntityAdapter.adoc
@@ -1,13 +1,12 @@
-= PersistentEntityAdapter : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.PersistentEntityAdapter.java
[source,java]
----
class PersistentEntityAdapter {
-
Object unmarshal(final OidDto oidDto)
-
OidDto marshal(final Object domainObject)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/jaxb/PrimitiveJaxbAdapters.adoc b/antora/components/system/modules/generated/pages/index/applib/jaxb/PrimitiveJaxbAdapters.adoc
index 6f1f079..6134945 100644
--- a/antora/components/system/modules/generated/pages/index/applib/jaxb/PrimitiveJaxbAdapters.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/jaxb/PrimitiveJaxbAdapters.adoc
@@ -1,7 +1,8 @@
-= PrimitiveJaxbAdapters : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.PrimitiveJaxbAdapters.java
[source,java]
----
class PrimitiveJaxbAdapters {
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/component/ActionLayoutData.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/component/ActionLayoutData.adoc
index f4b90b6..f66c91a 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/component/ActionLayoutData.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/component/ActionLayoutData.adoc
@@ -1,77 +1,45 @@
-= ActionLayoutData : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Describes the layout of a single action, broadly corresponding to _org.apache.isis.applib.annotation.ActionLayout_ .
-.Java Sources
+== API
+
+.ActionLayoutData.java
[source,java]
----
class ActionLayoutData {
-
ActionLayoutData()
-
ActionLayoutData(final String id)
-
- String getId() // <.>
-
+ String getId() // <.>
void setId(String id)
-
BookmarkPolicy getBookmarking()
-
void setBookmarking(BookmarkPolicy bookmarking)
-
String getCssClass()
-
void setCssClass(String cssClass)
-
String getCssClassFa()
-
void setCssClassFa(String cssClassFa)
-
CssClassFaPosition getCssClassFaPosition()
-
void setCssClassFaPosition(CssClassFaPosition cssClassFaPosition)
-
String getDescribedAs()
-
void setDescribedAs(String describedAs)
-
Where getHidden()
-
void setHidden(Where hidden)
-
String getNamed()
-
void setNamed(String named)
-
Boolean getNamedEscaped()
-
void setNamedEscaped(Boolean namedEscaped)
-
org.apache.isis.applib.annotation.ActionLayout.Position getPosition()
-
void setPosition(org.apache.isis.applib.annotation.ActionLayout.Position position)
-
PromptStyle getPromptStyle()
-
void setPromptStyle(PromptStyle promptStyle)
-
Redirect getRedirect()
-
void setRedirect(Redirect redirect)
-
- ActionLayoutDataOwner getOwner() // <.>
-
+ ActionLayoutDataOwner getOwner() // <.>
void setOwner(final ActionLayoutDataOwner owner)
-
- String getMetadataError() // <.>
-
+ String getMetadataError() // <.>
void setMetadataError(final String metadataError)
-
- Link getLink() // <.>
-
+ Link getLink() // <.>
void setLink(final Link link)
-
String toString()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/component/ActionLayoutDataOwner.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/component/ActionLayoutDataOwner.adoc
index 26db570..b46fdda 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/component/ActionLayoutDataOwner.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/component/ActionLayoutDataOwner.adoc
@@ -1,13 +1,12 @@
-= ActionLayoutDataOwner : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.ActionLayoutDataOwner.java
[source,java]
----
interface ActionLayoutDataOwner {
-
List<ActionLayoutData> getActions()
-
void setActions(List<ActionLayoutData> actions)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/component/CollectionLayoutData.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/component/CollectionLayoutData.adoc
index 6dbffe4..afd3ebe 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/component/CollectionLayoutData.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/component/CollectionLayoutData.adoc
@@ -1,69 +1,41 @@
-= CollectionLayoutData : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Describes the layout of a single collection, broadly corresponds to the _org.apache.isis.applib.annotation.CollectionLayout_ annotation.
-.Java Sources
+== API
+
+.CollectionLayoutData.java
[source,java]
----
class CollectionLayoutData {
-
CollectionLayoutData()
-
CollectionLayoutData(final String id)
-
- String getId() // <.>
-
+ String getId() // <.>
void setId(String id)
-
String getCssClass()
-
void setCssClass(String cssClass)
-
String getDescribedAs()
-
void setDescribedAs(String describedAs)
-
- String getDefaultView() // <.>
-
+ String getDefaultView() // <.>
void setDefaultView(String defaultView)
-
Where getHidden()
-
void setHidden(Where hidden)
-
String getNamed()
-
void setNamed(String named)
-
Boolean getNamedEscaped()
-
void setNamedEscaped(Boolean namedEscaped)
-
Integer getPaged()
-
void setPaged(Integer paged)
-
String getSortedBy()
-
void setSortedBy(String sortedBy)
-
List<ActionLayoutData> getActions()
-
void setActions(List<ActionLayoutData> actionLayoutDatas)
-
- CollectionLayoutDataOwner getOwner() // <.>
-
+ CollectionLayoutDataOwner getOwner() // <.>
void setOwner(final CollectionLayoutDataOwner owner)
-
- String getMetadataError() // <.>
-
+ String getMetadataError() // <.>
void setMetadataError(final String metadataError)
-
- Link getLink() // <.>
-
+ Link getLink() // <.>
void setLink(final Link link)
-
String toString()
}
----
@@ -76,7 +48,7 @@ Collection identifier, being the getter method without "get" prefix, first lette
<.> `[teal]#*getDefaultView*#()` : `String`
+
--
-Typicallytableorhidden, but could be any other named view that is configured and appropriate, eggmap3orfullcalendar2.
+Typically `tableor `hidden, but could be any other named view that is configured and appropriate, eg `gmap3or `fullcalendar2.
--
<.> `[teal]#*getOwner*#()` : `xref:system:generated:index/applib/layout/component/CollectionLayoutDataOwner.adoc[CollectionLayoutDataOwner]`
+
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/component/CollectionLayoutDataOwner.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/component/CollectionLayoutDataOwner.adoc
index 4a48090..2529e9e 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/component/CollectionLayoutDataOwner.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/component/CollectionLayoutDataOwner.adoc
@@ -1,11 +1,11 @@
-= CollectionLayoutDataOwner : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.CollectionLayoutDataOwner.java
[source,java]
----
interface CollectionLayoutDataOwner {
-
List<CollectionLayoutData> getCollections()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/component/CssClassFaPosition.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/component/CssClassFaPosition.adoc
index a6be340..34b72f9 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/component/CssClassFaPosition.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/component/CssClassFaPosition.adoc
@@ -1,15 +1,13 @@
-= CssClassFaPosition : _enum_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.CssClassFaPosition.java
[source,java]
----
enum CssClassFaPosition {
-
LEFT
-
RIGHT
-
boolean isLeftOrUnspecified(final CssClassFaPosition posistion)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/component/DomainObjectLayoutData.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/component/DomainObjectLayoutData.adoc
index 65628ca..84eff9a 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/component/DomainObjectLayoutData.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/component/DomainObjectLayoutData.adoc
@@ -1,57 +1,35 @@
-= DomainObjectLayoutData : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Describes the layout of the title and icon of a domain object, broadly corresponding to _org.apache.isis.applib.annotation.DomainObjectLayout_ .
-.Java Sources
+== API
+
+.DomainObjectLayoutData.java
[source,java]
----
class DomainObjectLayoutData {
-
DomainObjectLayoutData()
-
BookmarkPolicy getBookmarking()
-
void setBookmarking(BookmarkPolicy bookmarking)
-
String getCssClass()
-
void setCssClass(String cssClass)
-
String getCssClassFa()
-
void setCssClassFa(String cssClassFa)
-
CssClassFaPosition getCssClassFaPosition()
-
void setCssClassFaPosition(CssClassFaPosition cssClassFaPosition)
-
String getDescribedAs()
-
void setDescribedAs(String describedAs)
-
String getNamed()
-
void setNamed(String named)
-
Boolean getNamedEscaped()
-
void setNamedEscaped(Boolean namedEscaped)
-
String getPlural()
-
void setPlural(String plural)
-
- String getMetadataError() // <.>
-
+ String getMetadataError() // <.>
void setMetadataError(final String metadataError)
-
- DomainObjectLayoutDataOwner getOwner() // <.>
-
+ DomainObjectLayoutDataOwner getOwner() // <.>
void setOwner(final DomainObjectLayoutDataOwner owner)
-
- Link getLink() // <.>
-
+ Link getLink() // <.>
void setLink(final Link link)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/component/DomainObjectLayoutDataOwner.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/component/DomainObjectLayoutDataOwner.adoc
index 8100efc..1bce3c5 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/component/DomainObjectLayoutDataOwner.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/component/DomainObjectLayoutDataOwner.adoc
@@ -1,13 +1,12 @@
-= DomainObjectLayoutDataOwner : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.DomainObjectLayoutDataOwner.java
[source,java]
----
interface DomainObjectLayoutDataOwner {
-
DomainObjectLayoutData getDomainObject()
-
void setDomainObject(DomainObjectLayoutData domainObjectLayoutData)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/component/FieldSet.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/component/FieldSet.adoc
index d9d208e..3a0b454 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/component/FieldSet.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/component/FieldSet.adoc
@@ -1,49 +1,31 @@
-= FieldSet : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
A xref:system:generated:index/applib/layout/component/MemberRegion.adoc[MemberRegion] of the page containing a set of related xref:system:generated:index/applib/layout/component/PropertyLayoutData.adoc[PropertyLayoutData] and associated xref:system:generated:index/applib/layout/component/ActionLayoutData.adoc[ActionLayoutData] .
-.Java Sources
+== API
+
+.FieldSet.java
[source,java]
----
class FieldSet {
-
FieldSet()
-
FieldSet(final String name)
-
- String getId() // <.>
-
+ String getId() // <.>
void setId(final String id)
-
- Boolean isUnreferencedActions() // <.>
-
+ Boolean isUnreferencedActions() // <.>
void setUnreferencedActions(final Boolean unreferencedActions)
-
- Boolean isUnreferencedProperties() // <.>
-
+ Boolean isUnreferencedProperties() // <.>
void setUnreferencedProperties(final Boolean unreferencedProperties)
-
- String getName() // <.>
-
+ String getName() // <.>
void setName(String name)
-
List<ActionLayoutData> getActions()
-
void setActions(List<ActionLayoutData> actionLayoutDatas)
-
List<PropertyLayoutData> getProperties()
-
void setProperties(List<PropertyLayoutData> properties)
-
- FieldSetOwner getOwner() // <.>
-
+ FieldSetOwner getOwner() // <.>
void setOwner(final FieldSetOwner owner)
-
- String getMetadataError() // <.>
-
+ String getMetadataError() // <.>
void setMetadataError(final String metadataError)
-
String toString()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/component/FieldSetOwner.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/component/FieldSetOwner.adoc
index d831081..f677382 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/component/FieldSetOwner.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/component/FieldSetOwner.adoc
@@ -1,11 +1,11 @@
-= FieldSetOwner : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.FieldSetOwner.java
[source,java]
----
interface FieldSetOwner {
-
List<FieldSet> getFieldSets()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/component/HasBookmarking.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/component/HasBookmarking.adoc
index 0f4ee75..7c212dc 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/component/HasBookmarking.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/component/HasBookmarking.adoc
@@ -1,13 +1,12 @@
-= HasBookmarking : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.HasBookmarking.java
[source,java]
----
interface HasBookmarking {
-
BookmarkPolicy getBookmarking()
-
void setBookmarking(BookmarkPolicy bookmarking)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/component/HasCssClass.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/component/HasCssClass.adoc
index a8c92d5..f4ebdb6 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/component/HasCssClass.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/component/HasCssClass.adoc
@@ -1,13 +1,12 @@
-= HasCssClass : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.HasCssClass.java
[source,java]
----
interface HasCssClass {
-
String getCssClass()
-
void setCssClass(String cssClass)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/component/HasCssClassFa.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/component/HasCssClassFa.adoc
index 9c85bd4..ad68ae0 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/component/HasCssClassFa.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/component/HasCssClassFa.adoc
@@ -1,17 +1,14 @@
-= HasCssClassFa : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.HasCssClassFa.java
[source,java]
----
interface HasCssClassFa {
-
String getCssClassFa()
-
void setCssClassFa(String cssClassFa)
-
CssClassFaPosition getCssClassFaPosition()
-
void setCssClassFaPosition(CssClassFaPosition cssClassFaPosition)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/component/HasDescribedAs.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/component/HasDescribedAs.adoc
index 57053a4..c39fb10 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/component/HasDescribedAs.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/component/HasDescribedAs.adoc
@@ -1,13 +1,12 @@
-= HasDescribedAs : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.HasDescribedAs.java
[source,java]
----
interface HasDescribedAs {
-
String getDescribedAs()
-
void setDescribedAs(String describedAs)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/component/HasHidden.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/component/HasHidden.adoc
index 4e38d68..503909e 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/component/HasHidden.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/component/HasHidden.adoc
@@ -1,13 +1,12 @@
-= HasHidden : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.HasHidden.java
[source,java]
----
interface HasHidden {
-
Where getHidden()
-
void setHidden(Where hidden)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/component/HasNamed.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/component/HasNamed.adoc
index 6cdadfe..b36f26a 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/component/HasNamed.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/component/HasNamed.adoc
@@ -1,17 +1,14 @@
-= HasNamed : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.HasNamed.java
[source,java]
----
interface HasNamed {
-
String getNamed()
-
void setNamed(String named)
-
Boolean getNamedEscaped()
-
void setNamedEscaped(Boolean namedEscaped)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/component/MemberRegion.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/component/MemberRegion.adoc
index 75579ea..c3930e6 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/component/MemberRegion.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/component/MemberRegion.adoc
@@ -1,11 +1,12 @@
-= MemberRegion : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Represents an area on the page containing one or several related members.
-Implementations include aFieldSet(containing a number of properties and their actions), and aCollectionLayoutData(containing a single collection and associated actions)
+Implementations include a `FieldSet(containing a number of properties and their actions), and a `CollectionLayoutData(containing a single collection and associated actions)
-.Java Sources
+== API
+
+.MemberRegion.java
[source,java]
----
interface MemberRegion {
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/component/MemberRegionOwner.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/component/MemberRegionOwner.adoc
index 5b67df8..b8cf002 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/component/MemberRegionOwner.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/component/MemberRegionOwner.adoc
@@ -1,7 +1,8 @@
-= MemberRegionOwner : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.MemberRegionOwner.java
[source,java]
----
interface MemberRegionOwner {
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/component/Owned.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/component/Owned.adoc
index e876c60..494acba 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/component/Owned.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/component/Owned.adoc
@@ -1,11 +1,11 @@
-= Owned : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.Owned.java
[source,java]
----
interface Owned {
-
T getOwner()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/component/Owner.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/component/Owner.adoc
index 57ac280..91532d1 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/component/Owner.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/component/Owner.adoc
@@ -1,7 +1,8 @@
-= Owner : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.Owner.java
[source,java]
----
interface Owner {
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/component/PropertyLayoutData.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/component/PropertyLayoutData.adoc
index 9430fd1..dee05a9 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/component/PropertyLayoutData.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/component/PropertyLayoutData.adoc
@@ -1,81 +1,47 @@
-= PropertyLayoutData : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Describes the layout of a single property, broadly corresponds to the _org.apache.isis.applib.annotation.PropertyLayout_ annotation.
-.Java Sources
+== API
+
+.PropertyLayoutData.java
[source,java]
----
class PropertyLayoutData {
-
PropertyLayoutData()
-
PropertyLayoutData(final String id)
-
- String getId() // <.>
-
+ String getId() // <.>
void setId(String id)
-
String getCssClass()
-
void setCssClass(String cssClass)
-
String getDescribedAs()
-
void setDescribedAs(String describedAs)
-
Where getHidden()
-
void setHidden(Where hidden)
-
LabelPosition getLabelPosition()
-
void setLabelPosition(LabelPosition labelPosition)
-
Integer getMultiLine()
-
void setMultiLine(Integer multiLine)
-
String getNamed()
-
void setNamed(String named)
-
Boolean getNamedEscaped()
-
void setNamedEscaped(Boolean namedEscaped)
-
PromptStyle getPromptStyle()
-
void setPromptStyle(PromptStyle promptStyle)
-
RenderDay getRenderDay()
-
void setRenderDay(final RenderDay renderDay)
-
Integer getTypicalLength()
-
void setTypicalLength(Integer typicalLength)
-
Repainting getRepainting()
-
void setRepainting(final Repainting repainting)
-
List<ActionLayoutData> getActions()
-
void setActions(List<ActionLayoutData> actionLayoutDatas)
-
- FieldSet getOwner() // <.>
-
+ FieldSet getOwner() // <.>
void setOwner(final FieldSet owner)
-
- String getMetadataError() // <.>
-
+ String getMetadataError() // <.>
void setMetadataError(final String metadataError)
-
- Link getLink() // <.>
-
+ Link getLink() // <.>
void setLink(final Link link)
-
String toString()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/component/ServiceActionLayoutData.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/component/ServiceActionLayoutData.adoc
index b40bd8f..d9298dd 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/component/ServiceActionLayoutData.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/component/ServiceActionLayoutData.adoc
@@ -1,63 +1,38 @@
-= ServiceActionLayoutData : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Describes the layout of a single action, broadly corresponding to _org.apache.isis.applib.annotation.ActionLayout_ .
-.Java Sources
+== API
+
+.ServiceActionLayoutData.java
[source,java]
----
class ServiceActionLayoutData {
-
ServiceActionLayoutData()
-
ServiceActionLayoutData(final String objectType, final String id)
-
String getObjectType()
-
void setObjectType(final String objectType)
-
- String getId() // <.>
-
+ String getId() // <.>
void setId(String id)
-
BookmarkPolicy getBookmarking()
-
void setBookmarking(BookmarkPolicy bookmarking)
-
String getCssClass()
-
void setCssClass(String cssClass)
-
String getCssClassFa()
-
void setCssClassFa(String cssClassFa)
-
String getDescribedAs()
-
void setDescribedAs(String describedAs)
-
String getNamed()
-
void setNamed(String named)
-
Boolean getNamedEscaped()
-
void setNamedEscaped(Boolean namedEscaped)
-
- ServiceActionLayoutDataOwner getOwner() // <.>
-
+ ServiceActionLayoutDataOwner getOwner() // <.>
void setOwner(final ServiceActionLayoutDataOwner owner)
-
- String getMetadataError() // <.>
-
+ String getMetadataError() // <.>
void setMetadataError(final String metadataError)
-
- Link getLink() // <.>
-
+ Link getLink() // <.>
void setLink(final Link link)
-
String getObjectTypeAndId()
-
String toString()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/component/ServiceActionLayoutDataOwner.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/component/ServiceActionLayoutDataOwner.adoc
index 7861793..d1ea46d 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/component/ServiceActionLayoutDataOwner.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/component/ServiceActionLayoutDataOwner.adoc
@@ -1,13 +1,12 @@
-= ServiceActionLayoutDataOwner : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.ServiceActionLayoutDataOwner.java
[source,java]
----
interface ServiceActionLayoutDataOwner {
-
List<ServiceActionLayoutData> getServiceActions()
-
void setServiceActions(List<ServiceActionLayoutData> actions)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/grid/Grid.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/grid/Grid.adoc
index bc48d11..60f6cad 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/grid/Grid.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/grid/Grid.adoc
@@ -1,33 +1,24 @@
-= Grid : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
All top-level page layout classes should implement this interface.
It is used by the xref:system:generated:index/applib/services/layout/LayoutService.adoc[LayoutService] as a common based type for any layouts read in from XML.
-.Java Sources
+== API
+
+.Grid.java
[source,java]
----
interface Grid {
-
Class<?> getDomainClass()
-
void setDomainClass(final Class<?> domainClass)
-
String getTnsAndSchemaLocation()
-
void setTnsAndSchemaLocation(final String tnsAndSchemaLocation)
-
boolean isNormalized()
-
void setNormalized(final boolean normalized)
-
LinkedHashMap<String, PropertyLayoutData> getAllPropertiesById()
-
LinkedHashMap<String, CollectionLayoutData> getAllCollectionsById()
-
LinkedHashMap<String, ActionLayoutData> getAllActionsById()
-
void visit(final Grid.Visitor visitor)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/grid/GridAbstract.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/grid/GridAbstract.adoc
index a05459d..fb48472 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/grid/GridAbstract.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/grid/GridAbstract.adoc
@@ -1,33 +1,24 @@
-= GridAbstract : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
All top-level page layout classes should implement this interface.
It is used by the xref:system:generated:index/applib/services/layout/LayoutService.adoc[LayoutService] as a common based type for any layouts read in from XML.
-.Java Sources
+== API
+
+.GridAbstract.java
[source,java]
----
class GridAbstract {
-
Class<?> getDomainClass()
-
void setDomainClass(final Class<?> domainClass)
-
String getTnsAndSchemaLocation()
-
void setTnsAndSchemaLocation(final String tnsAndSchemaLocation)
-
boolean isNormalized()
-
void setNormalized(final boolean normalized)
-
LinkedHashMap<String, PropertyLayoutData> getAllPropertiesById()
-
LinkedHashMap<String, CollectionLayoutData> getAllCollectionsById()
-
LinkedHashMap<String, ActionLayoutData> getAllActionsById()
-
LinkedHashMap<String, FieldSet> getAllFieldSetsByName()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3ClearFix.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3ClearFix.adoc
index 4f54214..242d5da 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3ClearFix.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3ClearFix.adoc
@@ -1,7 +1,8 @@
-= BS3ClearFix : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.BS3ClearFix.java
[source,java]
----
class BS3ClearFix {
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3ClearFixHidden.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3ClearFixHidden.adoc
index 025aefe..a795d63 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3ClearFixHidden.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3ClearFixHidden.adoc
@@ -1,15 +1,15 @@
-= BS3ClearFixHidden : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
One of theResponsive utility classes.
It is rendered as a (eg) <div class="clearfix hidden-xs ...">
-.Java Sources
+== API
+
+.BS3ClearFixHidden.java
[source,java]
----
class BS3ClearFixHidden {
-
String toCssClass()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3ClearFixVisible.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3ClearFixVisible.adoc
index ae99ae6..018cc20 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3ClearFixVisible.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3ClearFixVisible.adoc
@@ -1,19 +1,17 @@
-= BS3ClearFixVisible : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
One of theResponsive utility classes.
It is rendered as a (eg) <div class="clearfix visible-xs-block ...">
-.Java Sources
+== API
+
+.BS3ClearFixVisible.java
[source,java]
----
class BS3ClearFixVisible {
-
CssDisplay getCssDisplay()
-
void setCssDisplay(final CssDisplay cssDisplay)
-
String toCssClass()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3Col.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3Col.adoc
index e63d09b..84b9794 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3Col.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3Col.adoc
@@ -1,4 +1,3 @@
-= BS3Col : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
A column within a row which, depending on its _#getSpan()_ , could be as narrow as 1/12th of the page's width, all the way up to spanning the entire page.
@@ -7,61 +6,37 @@ Pretty much other content can be contained within a column, though most commonly
It is rendered as a (eg) <div class="col-md-4 ...">
-.Java Sources
+== API
+
+.BS3Col.java
[source,java]
----
class BS3Col {
-
- String getId() // <.>
-
+ String getId() // <.>
void setId(final String id)
-
int getSpan()
-
void setSpan(final int span)
-
- Boolean isUnreferencedActions() // <.>
-
+ Boolean isUnreferencedActions() // <.>
void setUnreferencedActions(final Boolean unreferencedActions)
-
- Boolean isUnreferencedCollections() // <.>
-
+ Boolean isUnreferencedCollections() // <.>
void setUnreferencedCollections(final Boolean unreferencedCollections)
-
- DomainObjectLayoutData getDomainObject() // <.>
-
+ DomainObjectLayoutData getDomainObject() // <.>
void setDomainObject(final DomainObjectLayoutData domainObjectLayoutData)
-
List<SizeSpan> getSizeSpans()
-
void setSizeSpans(final List<SizeSpan> sizeSpans)
-
List<ActionLayoutData> getActions()
-
void setActions(final List<ActionLayoutData> actions)
-
List<BS3Row> getRows()
-
void setRows(final List<BS3Row> rows)
-
List<BS3TabGroup> getTabGroups()
-
void setTabGroups(final List<BS3TabGroup> tabGroups)
-
List<FieldSet> getFieldSets()
-
void setFieldSets(final List<FieldSet> fieldSets)
-
List<CollectionLayoutData> getCollections()
-
void setCollections(final List<CollectionLayoutData> collections)
-
- String getMetadataError() // <.>
-
+ String getMetadataError() // <.>
void setMetadataError(final String metadataError)
-
String toCssClass()
-
String toString()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3Element.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3Element.adoc
index b585b68..c0e308f 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3Element.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3Element.adoc
@@ -1,13 +1,12 @@
-= BS3Element : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.BS3Element.java
[source,java]
----
interface BS3Element {
-
- String getCssClass() // <.>
-
+ String getCssClass() // <.>
void setCssClass(final String cssClass)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3ElementAbstract.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3ElementAbstract.adoc
index ca5302a..fde5656 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3ElementAbstract.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3ElementAbstract.adoc
@@ -1,15 +1,14 @@
-= BS3ElementAbstract : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Superclass for all layout classes, factoring out the common _#getCssClass()_ attribute.
-.Java Sources
+== API
+
+.BS3ElementAbstract.java
[source,java]
----
class BS3ElementAbstract {
-
- String getCssClass() // <.>
-
+ String getCssClass() // <.>
void setCssClass(final String cssClass)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3Grid.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3Grid.adoc
index 30188f3..0fd4818 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3Grid.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3Grid.adoc
@@ -1,33 +1,24 @@
-= BS3Grid : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
This is the top-level for rendering the domain object's properties, collections and actions. It simply consists of a number of rows.
The element is rendered as a <div class="...">
-.Java Sources
+== API
+
+.BS3Grid.java
[source,java]
----
class BS3Grid {
-
String getCssClass()
-
void setCssClass(final String cssClass)
-
List<BS3Row> getRows()
-
void setRows(final List<BS3Row> rows)
-
- List<String> getMetadataErrors() // <.>
-
+ List<String> getMetadataErrors() // <.>
void setMetadataErrors(final List<String> metadataErrors)
-
void visit(final Grid.Visitor visitor)
-
LinkedHashMap<String, BS3Tab> getAllTabsByName()
-
LinkedHashMap<String, HasCssId> getAllCssId()
-
BS3Grid getGrid()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3Row.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3Row.adoc
index 10bb685..48adf61 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3Row.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3Row.adoc
@@ -1,33 +1,24 @@
-= BS3Row : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Contains a row of content, either on the top-level xref:system:generated:index/applib/layout/grid/bootstrap3/BS3Grid.adoc[BS3Grid] or at any other lower-level element that can contain rows, eg xref:system:generated:index/applib/layout/grid/bootstrap3/BS3Tab.adoc[BS3Tab] .
It is rendered as a <div class="row ...">
-.Java Sources
+== API
+
+.BS3Row.java
[source,java]
----
class BS3Row {
-
- String getId() // <.>
-
+ String getId() // <.>
void setId(final String id)
-
List<BS3RowContent> getCols()
-
void setCols(final List<BS3RowContent> cols)
-
- String getMetadataError() // <.>
-
+ String getMetadataError() // <.>
void setMetadataError(final String metadataError)
-
- BS3RowOwner getOwner() // <.>
-
+ BS3RowOwner getOwner() // <.>
void setOwner(final BS3RowOwner owner)
-
BS3Grid getGrid()
-
String toString()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3RowContent.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3RowContent.adoc
index 2c01dbc..6b55d14 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3RowContent.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3RowContent.adoc
@@ -1,23 +1,19 @@
-= BS3RowContent : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Common superclass for any content of a row.
Most commonly the content of a row is xref:system:generated:index/applib/layout/grid/bootstrap3/BS3Col.adoc[BS3Col] umns, but it may be either of the xref:system:generated:index/applib/layout/grid/bootstrap3/BS3ClearFix.adoc[BS3ClearFix] classes.
-.Java Sources
+== API
+
+.BS3RowContent.java
[source,java]
----
class BS3RowContent {
-
- Size getSize() // <.>
-
+ Size getSize() // <.>
void setSize(final Size size)
-
- BS3RowContentOwner getOwner() // <.>
-
+ BS3RowContentOwner getOwner() // <.>
void setOwner(final BS3RowContentOwner owner)
-
BS3Grid getGrid()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3RowContentOwner.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3RowContentOwner.adoc
index 6f27e5d..96f2f6a 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3RowContentOwner.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3RowContentOwner.adoc
@@ -1,7 +1,8 @@
-= BS3RowContentOwner : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.BS3RowContentOwner.java
[source,java]
----
interface BS3RowContentOwner {
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3RowOwner.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3RowOwner.adoc
index d4ccdb0..d9c9889 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3RowOwner.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3RowOwner.adoc
@@ -1,11 +1,11 @@
-= BS3RowOwner : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.BS3RowOwner.java
[source,java]
----
interface BS3RowOwner {
-
List<BS3Row> getRows()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3Tab.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3Tab.adoc
index 7b8afd0..de11179 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3Tab.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3Tab.adoc
@@ -1,29 +1,22 @@
-= BS3Tab : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Represents a tab within a xref:system:generated:index/applib/layout/grid/bootstrap3/BS3TabGroup.adoc[BS3TabGroup] .
They simply contain one or more xref:system:generated:index/applib/layout/grid/bootstrap3/BS3Row.adoc[BS3Row] s.
-.Java Sources
+== API
+
+.BS3Tab.java
[source,java]
----
class BS3Tab {
-
String getName()
-
void setName(final String name)
-
List<BS3Row> getRows()
-
void setRows(final List<BS3Row> rows)
-
- BS3TabOwner getOwner() // <.>
-
+ BS3TabOwner getOwner() // <.>
void setOwner(final BS3TabOwner owner)
-
BS3Grid getGrid()
-
String toString()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3TabGroup.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3TabGroup.adoc
index 1b1e76e..b710c5a 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3TabGroup.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3TabGroup.adoc
@@ -1,33 +1,23 @@
-= BS3TabGroup : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Represents a tab group containing one or more xref:system:generated:index/applib/layout/grid/bootstrap3/BS3Tab.adoc[BS3Tab] s.
-.Java Sources
+== API
+
+.BS3TabGroup.java
[source,java]
----
class BS3TabGroup {
-
- Boolean isUnreferencedCollections() // <.>
-
+ Boolean isUnreferencedCollections() // <.>
void setUnreferencedCollections(final Boolean unreferencedCollections)
-
- Boolean isCollapseIfOne() // <.>
-
+ Boolean isCollapseIfOne() // <.>
void setCollapseIfOne(final Boolean collapseIfOne)
-
List<BS3Tab> getTabs()
-
void setTabs(final List<BS3Tab> tabs)
-
- BS3TabGroupOwner getOwner() // <.>
-
+ BS3TabGroupOwner getOwner() // <.>
void setOwner(final BS3TabGroupOwner owner)
-
- String getMetadataError() // <.>
-
+ String getMetadataError() // <.>
void setMetadataError(final String metadataError)
-
BS3Grid getGrid()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3TabGroupOwner.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3TabGroupOwner.adoc
index 7289758..902dfc9 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3TabGroupOwner.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3TabGroupOwner.adoc
@@ -1,11 +1,11 @@
-= BS3TabGroupOwner : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.BS3TabGroupOwner.java
[source,java]
----
interface BS3TabGroupOwner {
-
List<BS3TabGroup> getTabGroups()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3TabOwner.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3TabOwner.adoc
index 0dc816c..8f42108 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3TabOwner.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/BS3TabOwner.adoc
@@ -1,11 +1,11 @@
-= BS3TabOwner : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.BS3TabOwner.java
[source,java]
----
interface BS3TabOwner {
-
List<BS3Tab> getTabs()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/HasCssId.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/HasCssId.adoc
index 92b3b88..a0e9ac4 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/HasCssId.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/HasCssId.adoc
@@ -1,12 +1,12 @@
-= HasCssId : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.HasCssId.java
[source,java]
----
interface HasCssId {
-
- String getId() // <.>
+ String getId() // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/Size.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/Size.adoc
index 6370e12..296642b 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/Size.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/Size.adoc
@@ -1,21 +1,17 @@
-= Size : _enum_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
As pergrid options, also used inresponsive utilityclasses.
-.Java Sources
+== API
+
+.Size.java
[source,java]
----
enum Size {
-
XS
-
SM
-
MD
-
LG
-
String toCssClassFragment()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/SizeSpan.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/SizeSpan.adoc
index bf6195ae..8b6e2f7 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/SizeSpan.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/SizeSpan.adoc
@@ -1,29 +1,20 @@
-= SizeSpan : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.SizeSpan.java
[source,java]
----
class SizeSpan {
-
SizeSpan with(final Size size, final int span)
-
SizeSpan offset(final Size size, final int span)
-
Size getSize()
-
void setSize(final Size size)
-
int getSpan()
-
void setSpan(final int span)
-
Boolean isOffset()
-
void setOffset(final Boolean offset)
-
String toCssClassFragment()
-
StringBuilder appendCssClassFragment(final StringBuilder buf)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/WithinGrid.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/WithinGrid.adoc
index d54c6f5..258b791 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/WithinGrid.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/grid/bootstrap3/WithinGrid.adoc
@@ -1,11 +1,11 @@
-= WithinGrid : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.WithinGrid.java
[source,java]
----
interface WithinGrid {
-
BS3Grid getGrid()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/links/Link.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/links/Link.adoc
index 2c1780f..7ebc078 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/links/Link.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/links/Link.adoc
@@ -1,23 +1,17 @@
-= Link : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.Link.java
[source,java]
----
class Link {
-
Link()
-
Link(final String rel, final String method, final String href, final String type)
-
String getRel()
-
String getMethod()
-
String getHref()
-
String getType()
-
String toString()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/menubars/HasNamed.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/menubars/HasNamed.adoc
index 9ddc7d8..093405c 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/menubars/HasNamed.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/menubars/HasNamed.adoc
@@ -1,11 +1,11 @@
-= HasNamed : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.HasNamed.java
[source,java]
----
interface HasNamed {
-
String getNamed()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/menubars/Menu.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/menubars/Menu.adoc
index abcfce2..a077c67 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/menubars/Menu.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/menubars/Menu.adoc
@@ -1,7 +1,8 @@
-= Menu : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.Menu.java
[source,java]
----
interface Menu {
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/menubars/MenuBar.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/menubars/MenuBar.adoc
index 4093673..f6dbccf 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/menubars/MenuBar.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/menubars/MenuBar.adoc
@@ -1,7 +1,8 @@
-= MenuBar : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.MenuBar.java
[source,java]
----
interface MenuBar {
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/menubars/MenuBars.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/menubars/MenuBars.adoc
index 0fa49ef..4f24443 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/menubars/MenuBars.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/menubars/MenuBars.adoc
@@ -1,19 +1,15 @@
-= MenuBars : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.MenuBars.java
[source,java]
----
interface MenuBars {
-
String getTnsAndSchemaLocation()
-
void setTnsAndSchemaLocation(final String tnsAndSchemaLocation)
-
MenuBar menuBarFor(DomainServiceLayout.MenuBar menuBar)
-
void visit(Visitor visitor)
-
Map<String, ServiceActionLayoutData> getAllServiceActionsByObjectTypeAndId()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/menubars/MenuBarsAbstract.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/menubars/MenuBarsAbstract.adoc
index 0b26941..2c70651 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/menubars/MenuBarsAbstract.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/menubars/MenuBarsAbstract.adoc
@@ -1,15 +1,13 @@
-= MenuBarsAbstract : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.MenuBarsAbstract.java
[source,java]
----
class MenuBarsAbstract {
-
String getTnsAndSchemaLocation()
-
void setTnsAndSchemaLocation(final String tnsAndSchemaLocation)
-
LinkedHashMap<String, ServiceActionLayoutData> getAllServiceActionsByObjectTypeAndId()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/menubars/MenuSection.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/menubars/MenuSection.adoc
index 39b5ac1..d06a26e 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/menubars/MenuSection.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/menubars/MenuSection.adoc
@@ -1,11 +1,11 @@
-= MenuSection : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.MenuSection.java
[source,java]
----
interface MenuSection {
-
List<ServiceActionLayoutData> getServiceActions()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/menubars/bootstrap3/BS3Menu.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/menubars/bootstrap3/BS3Menu.adoc
index 9953dca..bfb8e82 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/menubars/bootstrap3/BS3Menu.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/menubars/bootstrap3/BS3Menu.adoc
@@ -1,29 +1,21 @@
-= BS3Menu : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Describes the collection of domain services into menubars, broadly corresponding to the aggregation of information of xref:system:generated:index/applib/annotation/DomainServiceLayout.adoc[DomainServiceLayout] that have the same value of _DomainServiceLayout#named()_ .
-.Java Sources
+== API
+
+.BS3Menu.java
[source,java]
----
class BS3Menu {
-
BS3Menu()
-
BS3Menu(String named)
-
String getNamed()
-
void setNamed(String named)
-
String getCssClassFa()
-
void setCssClassFa(final String cssClassFa)
-
List<BS3MenuSection> getSections()
-
- Boolean isUnreferencedActions() // <.>
-
+ Boolean isUnreferencedActions() // <.>
void setUnreferencedActions(final Boolean unreferencedActions)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/menubars/bootstrap3/BS3MenuBar.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/menubars/bootstrap3/BS3MenuBar.adoc
index 2f3fa53..e939117 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/menubars/bootstrap3/BS3MenuBar.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/menubars/bootstrap3/BS3MenuBar.adoc
@@ -1,17 +1,15 @@
-= BS3MenuBar : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Describes the collection of domain services into menubars, broadly corresponding to the aggregation of information of xref:system:generated:index/applib/annotation/DomainServiceLayout.adoc[DomainServiceLayout] that have the same value of _DomainServiceLayout#named()_ .
-.Java Sources
+== API
+
+.BS3MenuBar.java
[source,java]
----
class BS3MenuBar {
-
BS3MenuBar()
-
List<BS3Menu> getMenus()
-
void setMenus(List<BS3Menu> menus)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/menubars/bootstrap3/BS3MenuBars.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/menubars/bootstrap3/BS3MenuBars.adoc
index 84adb3c..9d5610c 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/menubars/bootstrap3/BS3MenuBars.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/menubars/bootstrap3/BS3MenuBars.adoc
@@ -1,33 +1,23 @@
-= BS3MenuBars : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Describes the collection of domain services into menubars, broadly corresponding to the aggregation of information within xref:system:generated:index/applib/annotation/DomainServiceLayout.adoc[DomainServiceLayout] .
-.Java Sources
+== API
+
+.BS3MenuBars.java
[source,java]
----
class BS3MenuBars {
-
BS3MenuBars()
-
BS3MenuBar getPrimary()
-
void setPrimary(final BS3MenuBar primary)
-
BS3MenuBar getSecondary()
-
void setSecondary(final BS3MenuBar secondary)
-
BS3MenuBar getTertiary()
-
void setTertiary(final BS3MenuBar tertiary)
-
BS3MenuBar menuBarFor(final DomainServiceLayout.MenuBar menuBar)
-
void visit(final MenuBars.Visitor visitor)
-
- String getMetadataError() // <.>
-
+ String getMetadataError() // <.>
void setMetadataError(final String metadataError)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/layout/menubars/bootstrap3/BS3MenuSection.adoc b/antora/components/system/modules/generated/pages/index/applib/layout/menubars/bootstrap3/BS3MenuSection.adoc
index d9600d9..3e602a3 100644
--- a/antora/components/system/modules/generated/pages/index/applib/layout/menubars/bootstrap3/BS3MenuSection.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/layout/menubars/bootstrap3/BS3MenuSection.adoc
@@ -1,21 +1,17 @@
-= BS3MenuSection : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Corresponds to a domain service that contributes its serviceActions under a particular xref:system:generated:index/applib/layout/menubars/bootstrap3/BS3MenuBar.adoc[BS3MenuBar] .
-.Java Sources
+== API
+
+.BS3MenuSection.java
[source,java]
----
class BS3MenuSection {
-
BS3MenuSection()
-
String getNamed()
-
void setNamed(String named)
-
List<ServiceActionLayoutData> getServiceActions()
-
void setServiceActions(List<ServiceActionLayoutData> actionLayoutDatas)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/mixins/MixinConstants.adoc b/antora/components/system/modules/generated/pages/index/applib/mixins/MixinConstants.adoc
index 5b163f9..3ec553f 100644
--- a/antora/components/system/modules/generated/pages/index/applib/mixins/MixinConstants.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/mixins/MixinConstants.adoc
@@ -1,15 +1,13 @@
-= MixinConstants : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.MixinConstants.java
[source,java]
----
class MixinConstants {
-
public static final String METADATA_LAYOUT_GROUPNAME;
-
public static final String FILENAME_PROPERTY_NAME;
-
public static final String FILENAME_PROPERTY_DESCRIPTION;
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/mixins/dto/Dto.adoc b/antora/components/system/modules/generated/pages/index/applib/mixins/dto/Dto.adoc
index 1b6a383..d5d99fe 100644
--- a/antora/components/system/modules/generated/pages/index/applib/mixins/dto/Dto.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/mixins/dto/Dto.adoc
@@ -1,7 +1,8 @@
-= Dto : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.Dto.java
[source,java]
----
interface Dto {
diff --git a/antora/components/system/modules/generated/pages/index/applib/mixins/dto/Dto_downloadXml.adoc b/antora/components/system/modules/generated/pages/index/applib/mixins/dto/Dto_downloadXml.adoc
index b5d3c5c..2e379cf 100644
--- a/antora/components/system/modules/generated/pages/index/applib/mixins/dto/Dto_downloadXml.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/mixins/dto/Dto_downloadXml.adoc
@@ -1,16 +1,14 @@
-= Dto_downloadXml : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.Dto_downloadXml.java
[source,java]
----
class Dto_downloadXml {
-
@Inject
JaxbService jaxbService;
-
Object act(final String fileName)
-
String default0Act()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/mixins/dto/Dto_downloadXsd.adoc b/antora/components/system/modules/generated/pages/index/applib/mixins/dto/Dto_downloadXsd.adoc
index 5d803d1..0daa7ec 100644
--- a/antora/components/system/modules/generated/pages/index/applib/mixins/dto/Dto_downloadXsd.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/mixins/dto/Dto_downloadXsd.adoc
@@ -1,21 +1,17 @@
-= Dto_downloadXsd : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.Dto_downloadXsd.java
[source,java]
----
class Dto_downloadXsd {
-
@Inject
MessageService messageService;
-
@Inject
JaxbService jaxbService;
-
Object act(final String fileName, final JaxbService.IsisSchemas isisSchemas)
-
String default0Act()
-
JaxbService.IsisSchemas default1Act()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/mixins/layout/Object_downloadLayoutXml.adoc b/antora/components/system/modules/generated/pages/index/applib/mixins/layout/Object_downloadLayoutXml.adoc
index f57ab4c..ffda79c 100644
--- a/antora/components/system/modules/generated/pages/index/applib/mixins/layout/Object_downloadLayoutXml.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/mixins/layout/Object_downloadLayoutXml.adoc
@@ -1,18 +1,15 @@
-= Object_downloadLayoutXml : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.Object_downloadLayoutXml.java
[source,java]
----
class Object_downloadLayoutXml {
-
@Inject
LayoutService layoutService;
-
Object act(final String fileName, final LayoutService.Style style)
-
String default0Act()
-
LayoutService.Style default1Act()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/mixins/layout/Object_openRestApi.adoc b/antora/components/system/modules/generated/pages/index/applib/mixins/layout/Object_openRestApi.adoc
index 5535433..bd132f0 100644
--- a/antora/components/system/modules/generated/pages/index/applib/mixins/layout/Object_openRestApi.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/mixins/layout/Object_openRestApi.adoc
@@ -1,17 +1,15 @@
-= Object_openRestApi : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.Object_openRestApi.java
[source,java]
----
class Object_openRestApi {
-
@Inject
BookmarkService bookmarkService;
-
@Inject
RestfulPathProvider restfulPathProvider;
-
LocalResourcePath act()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/mixins/layout/Object_rebuildMetamodel.adoc b/antora/components/system/modules/generated/pages/index/applib/mixins/layout/Object_rebuildMetamodel.adoc
index 7f66f5c..0543bed 100644
--- a/antora/components/system/modules/generated/pages/index/applib/mixins/layout/Object_rebuildMetamodel.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/mixins/layout/Object_rebuildMetamodel.adoc
@@ -1,14 +1,13 @@
-= Object_rebuildMetamodel : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.Object_rebuildMetamodel.java
[source,java]
----
class Object_rebuildMetamodel {
-
@Inject
MetaModelService metaModelService;
-
Object act()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/mixins/metamodel/Object_downloadMetamodelXml.adoc b/antora/components/system/modules/generated/pages/index/applib/mixins/metamodel/Object_downloadMetamodelXml.adoc
index c6834a5..2f7f274 100644
--- a/antora/components/system/modules/generated/pages/index/applib/mixins/metamodel/Object_downloadMetamodelXml.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/mixins/metamodel/Object_downloadMetamodelXml.adoc
@@ -1,22 +1,18 @@
-= Object_downloadMetamodelXml : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.Object_downloadMetamodelXml.java
[source,java]
----
class Object_downloadMetamodelXml {
-
@Inject
MetaModelService metaModelService;
-
@Inject
JaxbService jaxbService;
-
@Inject
MetaModelServiceMenu metaModelServiceMenu;
-
Object act(final String fileName)
-
String default0Act()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/mixins/metamodel/Object_objectIdentifier.adoc b/antora/components/system/modules/generated/pages/index/applib/mixins/metamodel/Object_objectIdentifier.adoc
index cb0681c..654c82b 100644
--- a/antora/components/system/modules/generated/pages/index/applib/mixins/metamodel/Object_objectIdentifier.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/mixins/metamodel/Object_objectIdentifier.adoc
@@ -1,11 +1,11 @@
-= Object_objectIdentifier : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.Object_objectIdentifier.java
[source,java]
----
class Object_objectIdentifier {
-
String prop()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/mixins/metamodel/Object_objectType.adoc b/antora/components/system/modules/generated/pages/index/applib/mixins/metamodel/Object_objectType.adoc
index b01c134..5e54eac 100644
--- a/antora/components/system/modules/generated/pages/index/applib/mixins/metamodel/Object_objectType.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/mixins/metamodel/Object_objectType.adoc
@@ -1,11 +1,11 @@
-= Object_objectType : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.Object_objectType.java
[source,java]
----
class Object_objectType {
-
String prop()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/query/AllInstancesQuery.adoc b/antora/components/system/modules/generated/pages/index/applib/query/AllInstancesQuery.adoc
index 6c6f3fe..d26c6b9 100644
--- a/antora/components/system/modules/generated/pages/index/applib/query/AllInstancesQuery.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/query/AllInstancesQuery.adoc
@@ -1,7 +1,8 @@
-= AllInstancesQuery : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.AllInstancesQuery.java
[source,java]
----
interface AllInstancesQuery {
diff --git a/antora/components/system/modules/generated/pages/index/applib/query/NamedQuery.adoc b/antora/components/system/modules/generated/pages/index/applib/query/NamedQuery.adoc
index bc4ae7c..96052f6 100644
--- a/antora/components/system/modules/generated/pages/index/applib/query/NamedQuery.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/query/NamedQuery.adoc
@@ -1,17 +1,14 @@
-= NamedQuery : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.NamedQuery.java
[source,java]
----
interface NamedQuery {
-
String getName()
-
Map<String, Object> getParametersByName()
-
NamedQuery<T> withRange(QueryRange range)
-
NamedQuery<T> withParameter(String parameterName, Object parameterValue)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/query/Query.adoc b/antora/components/system/modules/generated/pages/index/applib/query/Query.adoc
index b2c134c..006c2cc 100644
--- a/antora/components/system/modules/generated/pages/index/applib/query/Query.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/query/Query.adoc
@@ -1,4 +1,3 @@
-= Query : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
For use by repository implementations, representing the values of a query.
@@ -9,27 +8,20 @@ Implementations are expected to implement the _#getRange()_ method, which is use
*Note:* not every object store will necessarily support this interface. In particular, the in-memory object store does not. For this, you can use the _Predicate_ interface to similar effect, for example in _RepositoryService#allMatches(Class, Predicate, long, long)_ ). *Note:* that the predicate is applied within the xref:system:generated:index/applib/services/repository/RepositoryService.adoc[RepositoryService] (ie client-side) rather than being pushed back to the object store.
-.Java Sources
+== API
+
+.Query.java
[source,java]
----
interface Query {
-
- Class<T> getResultType() // <.>
-
- String getDescription() // <.>
-
- QueryRange getRange() // <.>
-
+ Class<T> getResultType() // <.>
+ String getDescription() // <.>
+ QueryRange getRange() // <.>
Query<T> withRange(QueryRange range)
-
Query<T> withRange(long... range)
-
Query<T> withStart(long start)
-
Query<T> withLimit(long limit)
-
Query<T> allInstances(final Class<T> resultType)
-
NamedQuery<T> named(final Class<T> resultType, final String queryName)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/query/QueryRange.adoc b/antora/components/system/modules/generated/pages/index/applib/query/QueryRange.adoc
index bf48272..d99c3e9 100644
--- a/antora/components/system/modules/generated/pages/index/applib/query/QueryRange.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/query/QueryRange.adoc
@@ -1,39 +1,25 @@
-= QueryRange : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.QueryRange.java
[source,java]
----
interface QueryRange {
-
boolean isUnconstrained()
-
boolean hasOffset()
-
boolean hasLimit()
-
- long getStart() // <.>
-
- long getLimit() // <.>
-
- long getEnd() // <.>
-
- int getStartAsInt() // <.>
-
- int getLimitAsInt() // <.>
-
- int getEndAsInt() // <.>
-
+ long getStart() // <.>
+ long getLimit() // <.>
+ long getEnd() // <.>
+ int getStartAsInt() // <.>
+ int getLimitAsInt() // <.>
+ int getEndAsInt() // <.>
QueryRange unconstrained()
-
QueryRange start(long start)
-
QueryRange limit(long limit)
-
QueryRange of(long... range)
-
QueryRange withStart(long start)
-
QueryRange withLimit(long limit)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/DomainChangeRecord.adoc b/antora/components/system/modules/generated/pages/index/applib/services/DomainChangeRecord.adoc
index bdedbbf..71cea27 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/DomainChangeRecord.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/DomainChangeRecord.adoc
@@ -1,30 +1,22 @@
-= DomainChangeRecord : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
An abstraction of some sort of recorded change to a domain object: commands, audit entries or published events.
-.Java Sources
+== API
+
+.DomainChangeRecord.java
[source,java]
----
interface DomainChangeRecord {
-
- ChangeType getType() // <.>
-
- UUID getUniqueId() // <.>
-
- String getUsername() // <.>
-
- Timestamp getTimestamp() // <.>
-
- String getTargetObjectType() // <.>
-
- Bookmark getTarget() // <.>
-
- String getTargetMember() // <.>
-
- String getPreValue() // <.>
-
- String getPostValue() // <.>
+ ChangeType getType() // <.>
+ UUID getUniqueId() // <.>
+ String getUsername() // <.>
+ Timestamp getTimestamp() // <.>
+ String getTargetObjectType() // <.>
+ Bookmark getTarget() // <.>
+ String getTargetMember() // <.>
+ String getPreValue() // <.>
+ String getPostValue() // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/MethodReferences.adoc b/antora/components/system/modules/generated/pages/index/applib/services/MethodReferences.adoc
index 1e77920..b3bdc77 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/MethodReferences.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/MethodReferences.adoc
@@ -1,7 +1,8 @@
-= MethodReferences : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.MethodReferences.java
[source,java]
----
class MethodReferences {
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/RepresentsInteractionMemberExecution.adoc b/antora/components/system/modules/generated/pages/index/applib/services/RepresentsInteractionMemberExecution.adoc
index b820457..b9309cd 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/RepresentsInteractionMemberExecution.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/RepresentsInteractionMemberExecution.adoc
@@ -1,15 +1,15 @@
-= RepresentsInteractionMemberExecution : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Extends xref:system:generated:index/commons/having/HasUniqueId.adoc[HasUniqueId] , where the _HasUniqueId#getUniqueId()_ is interpreted as an interaction (cf _InteractionDto_ ) that has at least one member execution (cf _MemberExecutionDto_ ) and may (by way of xref:system:generated:index/applib/services/wrapper/WrapperFactory.adoc[WrapperFactory] ) contain several.
Examples could include SPI services that persist published events and status messages.
-.Java Sources
+== API
+
+.RepresentsInteractionMemberExecution.java
[source,java]
----
interface RepresentsInteractionMemberExecution {
-
int getSequence()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/acceptheader/AcceptHeaderService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/acceptheader/AcceptHeaderService.adoc
index d269fac..9805e10 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/acceptheader/AcceptHeaderService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/acceptheader/AcceptHeaderService.adoc
@@ -1,12 +1,24 @@
-= AcceptHeaderService : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+This service simply exposes the HTTP `Accept` header to the domain.
+
+Its intended use is to support multiple versions of a REST API, where the responsibility for content negotiation (determining which version of the REST API is to be used) is managed by logic in the domain objects themselves.
+
+== API
+
+.AcceptHeaderService.java
[source,java]
----
interface AcceptHeaderService {
-
- List<MediaType> getAcceptableMediaTypes()
+ List<MediaType> getAcceptableMediaTypes() // <.>
}
----
+<.> `[teal]#*getAcceptableMediaTypes*#()` : `List<MediaType>`
++
+--
+The intention is that this service only returns a list when the request is initiated through the _Restful Objects viewer_.
+
+Otherwise the service will likely return `null`.
+--
+
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/appfeat/ApplicationFeatureRepository.adoc b/antora/components/system/modules/generated/pages/index/applib/services/appfeat/ApplicationFeatureRepository.adoc
index 55d3950..6a210e6 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/appfeat/ApplicationFeatureRepository.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/appfeat/ApplicationFeatureRepository.adoc
@@ -1,19 +1,17 @@
-= ApplicationFeatureRepository : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+Provides the access to string representations of the packages, classes and class members (collectively: "application features") of the domain classes within the framework's internal metamodel.
+
+== API
+
+.ApplicationFeatureRepository.java
[source,java]
----
interface ApplicationFeatureRepository {
-
SortedSet<String> packageNames()
-
SortedSet<String> packageNamesContainingClasses(ApplicationMemberType memberType)
-
SortedSet<String> classNamesContainedIn(String packageFqn, ApplicationMemberType memberType)
-
SortedSet<String> classNamesRecursivelyContainedIn(String packageFqn)
-
SortedSet<String> memberNamesOf(String packageFqn, String className, ApplicationMemberType memberType)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/appfeat/ApplicationMemberType.adoc b/antora/components/system/modules/generated/pages/index/applib/services/appfeat/ApplicationMemberType.adoc
index b931fae..02dc670 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/appfeat/ApplicationMemberType.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/appfeat/ApplicationMemberType.adoc
@@ -1,17 +1,14 @@
-= ApplicationMemberType : _enum_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.ApplicationMemberType.java
[source,java]
----
enum ApplicationMemberType {
-
PROPERTY
-
COLLECTION
-
ACTION
-
String toString()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/bookmark/Bookmark.adoc b/antora/components/system/modules/generated/pages/index/applib/services/bookmark/Bookmark.adoc
index 7c0321d..f162c5f 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/bookmark/Bookmark.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/bookmark/Bookmark.adoc
@@ -1,27 +1,21 @@
-= Bookmark : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
String representation of any persistable or re-createable object managed by the framework.
Analogous to the `RootOid` .
-.Java Sources
+== API
+
+.Bookmark.java
[source,java]
----
class Bookmark {
-
Bookmark of(String objectType, String identifier)
-
- Optional<Bookmark> parse(String str) // <.>
-
+ Optional<Bookmark> parse(String str) // <.>
OidDto toOidDto()
-
Bookmark from(OidDto oidDto)
-
- String toString() // <.>
-
+ String toString() // <.>
Bookmark withHintId(String hintId)
-
String toStringUsingIdentifier(String id)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/bookmark/BookmarkHolder.adoc b/antora/components/system/modules/generated/pages/index/applib/services/bookmark/BookmarkHolder.adoc
index b2ac31d..f60388d 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/bookmark/BookmarkHolder.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/bookmark/BookmarkHolder.adoc
@@ -1,11 +1,11 @@
-= BookmarkHolder : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.BookmarkHolder.java
[source,java]
----
interface BookmarkHolder {
-
Bookmark bookmark()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/bookmark/BookmarkHolder_lookup.adoc b/antora/components/system/modules/generated/pages/index/applib/services/bookmark/BookmarkHolder_lookup.adoc
index 07df383..3c18883 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/bookmark/BookmarkHolder_lookup.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/bookmark/BookmarkHolder_lookup.adoc
@@ -1,11 +1,11 @@
-= BookmarkHolder_lookup : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.BookmarkHolder_lookup.java
[source,java]
----
class BookmarkHolder_lookup {
-
Object act()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/bookmark/BookmarkHolder_object.adoc b/antora/components/system/modules/generated/pages/index/applib/services/bookmark/BookmarkHolder_object.adoc
index 78a10b7..27a4c1b 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/bookmark/BookmarkHolder_object.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/bookmark/BookmarkHolder_object.adoc
@@ -1,11 +1,11 @@
-= BookmarkHolder_object : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.BookmarkHolder_object.java
[source,java]
----
class BookmarkHolder_object {
-
Object prop()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/bookmark/BookmarkService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/bookmark/BookmarkService.adoc
index 5c4c4aa..9b571d3 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/bookmark/BookmarkService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/bookmark/BookmarkService.adoc
@@ -1,24 +1,19 @@
-= BookmarkService : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-This service enables a serializable 'bookmark' to be created for an entity.
+This service provides a serializable 'bookmark' for any entity, and conversely to lookup an entity from a bookmark.
-.Java Sources
+== API
+
+.BookmarkService.java
[source,java]
----
interface BookmarkService {
-
- Bookmark bookmarkFor(Object domainObject) // <.>
-
- Bookmark bookmarkForElseThrow(Object domainObject) // <.>
-
- Bookmark bookmarkFor(Class<?> cls, String identifier) // <.>
-
- Object lookup(BookmarkHolder bookmarkHolder) // <.>
-
- Object lookup(Bookmark bookmark) // <.>
-
- T lookup(Bookmark bookmark, Class<T> cls) // <.>
+ Bookmark bookmarkFor(Object domainObject) // <.>
+ Bookmark bookmarkForElseThrow(Object domainObject) // <.>
+ Bookmark bookmarkFor(Class<?> cls, String identifier) // <.>
+ Object lookup(BookmarkHolder bookmarkHolder) // <.>
+ Object lookup(Bookmark bookmark) // <.>
+ T lookup(Bookmark bookmark, Class<T> cls) // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/bookmarkui/BookmarkUiService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/bookmarkui/BookmarkUiService.adoc
index a260c2b..01daa51 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/bookmarkui/BookmarkUiService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/bookmarkui/BookmarkUiService.adoc
@@ -1,12 +1,20 @@
-= BookmarkUiService : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+Provides the ability to programmatically interact with bookmarked pages and breadcrumbs, as rendered by the Wicket viewer.
+
+== API
+
+.BookmarkUiService.java
[source,java]
----
interface BookmarkUiService {
-
- void clear()
+ void clear() // <.>
}
----
+<.> `[teal]#*clear*#()` : `void`
++
+--
+Simply clears the current list of breadcrumbs and bookmarks.
+--
+
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/clock/ClockService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/clock/ClockService.adoc
index 97cd126..58474a9 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/clock/ClockService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/clock/ClockService.adoc
@@ -1,15 +1,14 @@
-= ClockService : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
This service allows an application to be decoupled from the system time. The most common use case is in support of testing scenarios, to "mock the clock". Use of this service also opens up the use of centralized co-ordinated time management through a centralized time service.
-.Java Sources
+== API
+
+.ClockService.java
[source,java]
----
interface ClockService {
-
VirtualClock getClock()
-
long getEpochMillis()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/command/Command.adoc b/antora/components/system/modules/generated/pages/index/applib/services/command/Command.adoc
index 7f79709..9c06358 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/command/Command.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/command/Command.adoc
@@ -1,4 +1,3 @@
-= Command : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Represents the _intention to_ invoke either an action or modify a property. There can be only one such intention per (web) request, so a command is in effect interaction-scoped.
@@ -11,20 +10,17 @@ Note that when invoking an action, other actions may be invoked courtesy of the
That said, if the sub-action is invoked asynchronously (using _WrapperFactory#asyncWrap(Object, AsyncControl)_ or _WrapperFactory#asyncWrapMixin(Class, Object, AsyncControl)_ ), then a separate xref:system:generated:index/applib/services/command/Command.adoc[Command] object is created, and the originating xref:system:generated:index/applib/services/command/Command.adoc[Command] is set to be its _Command#getParent() parent_ .
-.Java Sources
+== API
+
+.Command.java
[source,java]
----
class Command {
-
- String getUsername() // <.>
-
- Timestamp getTimestamp() // <.>
-
- Bookmark getTarget() // <.>
-
- String getLogicalMemberIdentifier() // <.>
-
- Updater updater() // <.>
+ String getUsername() // <.>
+ Timestamp getTimestamp() // <.>
+ Bookmark getTarget() // <.>
+ String getLogicalMemberIdentifier() // <.>
+ Updater updater() // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/command/CommandExecutorService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/command/CommandExecutorService.adoc
index a1fb582..6691b30 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/command/CommandExecutorService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/command/CommandExecutorService.adoc
@@ -1,17 +1,14 @@
-= CommandExecutorService : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.CommandExecutorService.java
[source,java]
----
interface CommandExecutorService {
-
- Bookmark executeCommand(SudoPolicy sudoPolicy, Command command) // <.>
-
+ Bookmark executeCommand(SudoPolicy sudoPolicy, Command command) // <.>
Bookmark executeCommand(SudoPolicy sudoPolicy, CommandDto commandDto, CommandOutcomeHandler outcomeHandler)
-
Bookmark executeCommand(Command command)
-
Bookmark executeCommand(CommandDto commandDto, CommandOutcomeHandler outcomeHandler)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/command/CommandOutcomeHandler.adoc b/antora/components/system/modules/generated/pages/index/applib/services/command/CommandOutcomeHandler.adoc
index 409e365..6c4d18a 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/command/CommandOutcomeHandler.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/command/CommandOutcomeHandler.adoc
@@ -1,19 +1,15 @@
-= CommandOutcomeHandler : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.CommandOutcomeHandler.java
[source,java]
----
interface CommandOutcomeHandler {
-
CommandOutcomeHandler NULL;
-
Timestamp getStartedAt()
-
void setStartedAt(Timestamp startedAt)
-
void setCompletedAt(Timestamp completedAt)
-
void setResult(Result<Bookmark> resultBookmark)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/commanddto/HasCommandDto.adoc b/antora/components/system/modules/generated/pages/index/applib/services/commanddto/HasCommandDto.adoc
index afbff80..91148fa 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/commanddto/HasCommandDto.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/commanddto/HasCommandDto.adoc
@@ -1,13 +1,13 @@
-= HasCommandDto : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Objects implementing this interface will be processed automatically by _org.apache.isis.applib.services.commanddto.conmap.ContentMappingServiceForCommandDto_ .
-.Java Sources
+== API
+
+.HasCommandDto.java
[source,java]
----
interface HasCommandDto {
-
CommandDto getCommandDto()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/commanddto/conmap/ContentMappingServiceForCommandDto.adoc b/antora/components/system/modules/generated/pages/index/applib/services/commanddto/conmap/ContentMappingServiceForCommandDto.adoc
index 2a06715..ca74195 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/commanddto/conmap/ContentMappingServiceForCommandDto.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/commanddto/conmap/ContentMappingServiceForCommandDto.adoc
@@ -1,19 +1,16 @@
-= ContentMappingServiceForCommandDto : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.ContentMappingServiceForCommandDto.java
[source,java]
----
class ContentMappingServiceForCommandDto {
-
@Inject
MetaModelService metaModelService;
-
@Inject
List<CommandDtoProcessorService> commandDtoProcessorServices;
-
Object map(final Object object, final List<MediaType> acceptableMediaTypes)
-
CommandDto asProcessedDto(final Object object)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/commanddto/conmap/ContentMappingServiceForCommandsDto.adoc b/antora/components/system/modules/generated/pages/index/applib/services/commanddto/conmap/ContentMappingServiceForCommandsDto.adoc
index aa393e9..05d341e 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/commanddto/conmap/ContentMappingServiceForCommandsDto.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/commanddto/conmap/ContentMappingServiceForCommandsDto.adoc
@@ -1,17 +1,15 @@
-= ContentMappingServiceForCommandsDto : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.ContentMappingServiceForCommandsDto.java
[source,java]
----
class ContentMappingServiceForCommandsDto {
-
@Inject
ContentMappingServiceForCommandDto contentMappingServiceForCommandDto;
-
Object map(Object object, final List<MediaType> acceptableMediaTypes)
-
- CommandsDto map(final Object object) // <.>
+ CommandsDto map(final Object object) // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/commanddto/conmap/UserDataKeys.adoc b/antora/components/system/modules/generated/pages/index/applib/services/commanddto/conmap/UserDataKeys.adoc
index 5a0a321..8cc59c6 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/commanddto/conmap/UserDataKeys.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/commanddto/conmap/UserDataKeys.adoc
@@ -1,15 +1,14 @@
-= UserDataKeys : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Keys used in _CommandDto#getUserData()_ to marshall the command's results
-.Java Sources
+== API
+
+.UserDataKeys.java
[source,java]
----
class UserDataKeys {
-
public static String RESULT;
-
public static String EXCEPTION;
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/commanddto/processor/CommandDtoProcessor.adoc b/antora/components/system/modules/generated/pages/index/applib/services/commanddto/processor/CommandDtoProcessor.adoc
index 528d6f4..9962781 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/commanddto/processor/CommandDtoProcessor.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/commanddto/processor/CommandDtoProcessor.adoc
@@ -1,14 +1,14 @@
-= CommandDtoProcessor : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Refine (or possibly ignore) a command when replicating from primary to secondary.
-.Java Sources
+== API
+
+.CommandDtoProcessor.java
[source,java]
----
interface CommandDtoProcessor {
-
- CommandDto process(CommandDto commandDto) // <.>
+ CommandDto process(CommandDto commandDto) // <.>
}
----
@@ -17,6 +17,6 @@ interface CommandDtoProcessor {
--
The implementation can if necessary refine or alter the _CommandDto_ to be replicated from primary to secondary.
-That said, the most common use case is to returnnull, which results in the command effectively being ignore.
+That said, the most common use case is to return `null, which results in the command effectively being ignore.
--
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/commanddto/processor/CommandDtoProcessorForActionAbstract.adoc b/antora/components/system/modules/generated/pages/index/applib/services/commanddto/processor/CommandDtoProcessorForActionAbstract.adoc
index cc5c9c4..01d32f1 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/commanddto/processor/CommandDtoProcessorForActionAbstract.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/commanddto/processor/CommandDtoProcessorForActionAbstract.adoc
@@ -1,9 +1,10 @@
-= CommandDtoProcessorForActionAbstract : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Convenience adapter for command processors for action invocations.
-.Java Sources
+== API
+
+.CommandDtoProcessorForActionAbstract.java
[source,java]
----
class CommandDtoProcessorForActionAbstract {
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/commanddto/processor/CommandDtoProcessorForPropertyAbstract.adoc b/antora/components/system/modules/generated/pages/index/applib/services/commanddto/processor/CommandDtoProcessorForPropertyAbstract.adoc
index 1bec0cb..fb3cbc1 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/commanddto/processor/CommandDtoProcessorForPropertyAbstract.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/commanddto/processor/CommandDtoProcessorForPropertyAbstract.adoc
@@ -1,9 +1,10 @@
-= CommandDtoProcessorForPropertyAbstract : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Convenience adapter for command processors for property edits.
-.Java Sources
+== API
+
+.CommandDtoProcessorForPropertyAbstract.java
[source,java]
----
class CommandDtoProcessorForPropertyAbstract {
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/commanddto/processor/spi/CommandDtoProcessorService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/commanddto/processor/spi/CommandDtoProcessorService.adoc
index 7a75d4f..77b9283 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/commanddto/processor/spi/CommandDtoProcessorService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/commanddto/processor/spi/CommandDtoProcessorService.adoc
@@ -1,14 +1,16 @@
-= CommandDtoProcessorService : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-Optional SPI called by xref:system:generated:index/applib/services/commanddto/conmap/ContentMappingServiceForCommandDto.adoc[ContentMappingServiceForCommandDto] . Similar to xref:system:generated:index/applib/services/commanddto/processor/CommandDtoProcessor.adoc[CommandDtoProcessor] , but applied to all _CommandDto_ s globally.
+Service used to convert a domain object into a _CommandDto_ , called by xref:system:generated:index/applib/services/commanddto/conmap/ContentMappingServiceForCommandDto.adoc[ContentMappingServiceForCommandDto] .
-.Java Sources
+The service is used as a fallback if an xref:system:generated:index/applib/services/commanddto/processor/CommandDtoProcessor.adoc[CommandDtoProcessor] , hasn't been explicitly specified using _Action#commandDtoProcessor()_ or _Property#commandDtoProcessor()_ .
+
+== API
+
+.CommandDtoProcessorService.java
[source,java]
----
interface CommandDtoProcessorService {
-
- CommandDto process(final Object domainObject, final CommandDto commandDto) // <.>
+ CommandDto process(final Object domainObject, final CommandDto commandDto) // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/commanddto/processor/spi/CommandDtoProcessorServiceIdentity.adoc b/antora/components/system/modules/generated/pages/index/applib/services/commanddto/processor/spi/CommandDtoProcessorServiceIdentity.adoc
index fd5adf3..27e1fb2 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/commanddto/processor/spi/CommandDtoProcessorServiceIdentity.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/commanddto/processor/spi/CommandDtoProcessorServiceIdentity.adoc
@@ -1,13 +1,13 @@
-= CommandDtoProcessorServiceIdentity : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
At least one implementation is required.
-.Java Sources
+== API
+
+.CommandDtoProcessorServiceIdentity.java
[source,java]
----
class CommandDtoProcessorServiceIdentity {
-
CommandDto process(final Object domainObject, final CommandDto commandDto)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/confview/ConfigurationMenu.adoc b/antora/components/system/modules/generated/pages/index/applib/services/confview/ConfigurationMenu.adoc
index 5a1326b..e00e8d2 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/confview/ConfigurationMenu.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/confview/ConfigurationMenu.adoc
@@ -1,13 +1,12 @@
-= ConfigurationMenu : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.ConfigurationMenu.java
[source,java]
----
class ConfigurationMenu {
-
ConfigurationMenu(ConfigurationViewService configurationService)
-
Set<ConfigurationProperty> configuration()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/confview/ConfigurationProperty.adoc b/antora/components/system/modules/generated/pages/index/applib/services/confview/ConfigurationProperty.adoc
index 39a830c..6253548 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/confview/ConfigurationProperty.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/confview/ConfigurationProperty.adoc
@@ -1,13 +1,12 @@
-= ConfigurationProperty : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.ConfigurationProperty.java
[source,java]
----
class ConfigurationProperty {
-
ConfigurationProperty(final String key, final String value)
-
int compareTo(final ConfigurationProperty other)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/confview/ConfigurationViewService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/confview/ConfigurationViewService.adoc
index 79f9e67..d3d4e2f 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/confview/ConfigurationViewService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/confview/ConfigurationViewService.adoc
@@ -1,12 +1,12 @@
-= ConfigurationViewService : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.ConfigurationViewService.java
[source,java]
----
interface ConfigurationViewService {
-
- Set<ConfigurationProperty> allProperties() // <.>
+ Set<ConfigurationProperty> allProperties() // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/conmap/ContentMappingService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/conmap/ContentMappingService.adoc
index 36f9dc7..e399d21 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/conmap/ContentMappingService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/conmap/ContentMappingService.adoc
@@ -1,12 +1,12 @@
-= ContentMappingService : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.ContentMappingService.java
[source,java]
----
interface ContentMappingService {
-
- Object map(Object object, final List<MediaType> acceptableMediaTypes) // <.>
+ Object map(Object object, final List<MediaType> acceptableMediaTypes) // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/email/EmailService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/email/EmailService.adoc
index faf3e52..063c109 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/email/EmailService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/email/EmailService.adoc
@@ -1,20 +1,18 @@
-= EmailService : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Provides the ability to send emails to one or more recipients.
The core framework also provides a default implementation `EmailServiceDefault` that sends email as an HTML message, using an external SMTP provider. See the Isis website for further details.
-.Java Sources
+== API
+
+.EmailService.java
[source,java]
----
interface EmailService {
-
void init()
-
boolean send(List<String> to, List<String> cc, List<String> bcc, String subject, String body, DataSource... attachments)
-
- boolean isConfigured() // <.>
+ boolean isConfigured() // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/error/ErrorDetails.adoc b/antora/components/system/modules/generated/pages/index/applib/services/error/ErrorDetails.adoc
index 7227fbf..15e0356 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/error/ErrorDetails.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/error/ErrorDetails.adoc
@@ -1,11 +1,12 @@
-= ErrorDetails : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Details of the error (obtained from the thrown exception), passed as part of the request to the xref:system:generated:index/applib/services/error/ErrorReportingService.adoc[ErrorReportingService] .
Implementation note: a class has been used here so that additional fields might be added in the future.
-.Java Sources
+== API
+
+.ErrorDetails.java
[source,java]
----
class ErrorDetails {
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/error/ErrorReportingService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/error/ErrorReportingService.adoc
index fb0c5d6..5e3505e 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/error/ErrorReportingService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/error/ErrorReportingService.adoc
@@ -1,13 +1,13 @@
-= ErrorReportingService : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Optional SPI service providing the ability to record errors occurring in the application into an external incident recording system (such as JIRA) and to provide a user-friendly (jargon-free) error message to the end-user, along with incident reference.
-.Java Sources
+== API
+
+.ErrorReportingService.java
[source,java]
----
interface ErrorReportingService {
-
Ticket reportError(final ErrorDetails errorDetails)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/error/SimpleTicket.adoc b/antora/components/system/modules/generated/pages/index/applib/services/error/SimpleTicket.adoc
index a9867dc..0f80231 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/error/SimpleTicket.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/error/SimpleTicket.adoc
@@ -1,4 +1,3 @@
-= SimpleTicket : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Response from the xref:system:generated:index/applib/services/error/ErrorReportingService.adoc[ErrorReportingService] , containing information to show to the end-user.
@@ -10,29 +9,21 @@ Implementation notes:
so that it can be stored by the Wicket viewer as a Wicket model.
-.Java Sources
+== API
+
+.SimpleTicket.java
[source,java]
----
class SimpleTicket {
-
SimpleTicket(final String reference, final String userMessage, final String details)
-
SimpleTicket(final String reference, final String userMessage, final String details, final StackTracePolicy stackTracePolicy)
-
SimpleTicket(final String reference, final String userMessage, final String details, final String kittenUrl)
-
SimpleTicket(final String reference, final String userMessage, final String details, final StackTracePolicy stackTracePolicy, final String kittenUrl)
-
String getReference()
-
String getUserMessage()
-
String getDetails()
-
StackTracePolicy getStackTracePolicy()
-
- String getKittenUrl() // <.>
-
+ String getKittenUrl() // <.>
String getMarkup()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/error/Ticket.adoc b/antora/components/system/modules/generated/pages/index/applib/services/error/Ticket.adoc
index 82330a7..c813e9b 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/error/Ticket.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/error/Ticket.adoc
@@ -1,4 +1,3 @@
-= Ticket : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Response from the xref:system:generated:index/applib/services/error/ErrorReportingService.adoc[ErrorReportingService] , containing information to show to the end-user.
@@ -10,20 +9,17 @@ Implementation notes:
so that it can be stored by the Wicket viewer as a Wicket model.
-.Java Sources
+== API
+
+.Ticket.java
[source,java]
----
interface Ticket {
-
- String getReference() // <.>
-
- String getUserMessage() // <.>
-
- String getDetails() // <.>
-
- StackTracePolicy getStackTracePolicy() // <.>
-
- String getMarkup() // <.>
+ String getReference() // <.>
+ String getUserMessage() // <.>
+ String getDetails() // <.>
+ StackTracePolicy getStackTracePolicy() // <.>
+ String getMarkup() // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/eventbus/EventBusService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/eventbus/EventBusService.adoc
index 09e2a44..71670ff 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/eventbus/EventBusService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/eventbus/EventBusService.adoc
@@ -1,13 +1,13 @@
-= EventBusService : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
A service implementing an Event Bus, allowing arbitrary events to be posted.
-.Java Sources
+== API
+
+.EventBusService.java
[source,java]
----
interface EventBusService {
-
void post(Object event)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/exceprecog/ExceptionRecognizer.adoc b/antora/components/system/modules/generated/pages/index/applib/services/exceprecog/ExceptionRecognizer.adoc
index 03e6942..bd8e744 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/exceprecog/ExceptionRecognizer.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/exceprecog/ExceptionRecognizer.adoc
@@ -1,4 +1,3 @@
-= ExceptionRecognizer : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Domain service to (attempt) to recognize certain exceptions, and return user-friendly messages instead.
@@ -11,12 +10,13 @@ The Isis framework also provides a default implementation of this service that r
Initially introduced for the Wicket viewer; check the documentation of other viewers to determine whether they also support this service.
-.Java Sources
+== API
+
+.ExceptionRecognizer.java
[source,java]
----
interface ExceptionRecognizer {
-
- Optional<Recognition> recognize(Throwable ex) // <.>
+ Optional<Recognition> recognize(Throwable ex) // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/exceprecog/ExceptionRecognizerAbstract.adoc b/antora/components/system/modules/generated/pages/index/applib/services/exceprecog/ExceptionRecognizerAbstract.adoc
index 4ebf6c0..cb11a4a 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/exceprecog/ExceptionRecognizerAbstract.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/exceprecog/ExceptionRecognizerAbstract.adoc
@@ -1,23 +1,19 @@
-= ExceptionRecognizerAbstract : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Abstract implementation of xref:system:generated:index/applib/services/exceprecog/ExceptionRecognizer.adoc[ExceptionRecognizer] that looks exceptions meeting the _Predicate_ supplied in the constructor and, if found anywhere in the causal chain, then returns a non-null message indicating that the exception has been recognized.
If a messaging-parsing _Function_ is provided through the constructor, then the message can be altered. Otherwise the exception's _Throwable#getMessage() message_ is returned as-is.
-.Java Sources
+== API
+
+.ExceptionRecognizerAbstract.java
[source,java]
----
class ExceptionRecognizerAbstract {
-
ExceptionRecognizerAbstract(final Category category, Predicate<Throwable> predicate, final Function<String, String> messageParser)
-
ExceptionRecognizerAbstract(Predicate<Throwable> predicate, final Function<String, String> messageParser)
-
ExceptionRecognizerAbstract(Category category, Predicate<Throwable> predicate)
-
ExceptionRecognizerAbstract(Predicate<Throwable> predicate)
-
Optional<Recognition> recognize(Throwable ex)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/exceprecog/ExceptionRecognizerForType.adoc b/antora/components/system/modules/generated/pages/index/applib/services/exceprecog/ExceptionRecognizerForType.adoc
index 65a2473..bab6813 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/exceprecog/ExceptionRecognizerForType.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/exceprecog/ExceptionRecognizerForType.adoc
@@ -1,25 +1,20 @@
-= ExceptionRecognizerForType : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
A specific implementation of xref:system:generated:index/applib/services/exceprecog/ExceptionRecognizer.adoc[ExceptionRecognizer] that looks for an exception of the type provided in the constructor and, if found anywhere in the causal chain, then returns a non-null message indicating that the exception has been recognized.
If a messaging-parsing _Function_ is provided through the constructor, then the message can be altered. Otherwise the exception's _Throwable#getMessage() message_ is returned as-is.
-.Java Sources
+== API
+
+.ExceptionRecognizerForType.java
[source,java]
----
class ExceptionRecognizerForType {
-
ExceptionRecognizerForType(final Category category, final Class<? extends Exception> exceptionType, final UnaryOperator<String> messageParser)
-
ExceptionRecognizerForType(final Category category, final Predicate<Throwable> predicate, final UnaryOperator<String> messageParser)
-
ExceptionRecognizerForType(final Category category, final Class<? extends Exception> exceptionType)
-
ExceptionRecognizerForType(final Class<? extends Exception> exceptionType, final UnaryOperator<String> messageParser)
-
ExceptionRecognizerForType(final Predicate<Throwable> predicate, final UnaryOperator<String> messageParser)
-
ExceptionRecognizerForType(Class<? extends Exception> exceptionType)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/exceprecog/ExceptionRecognizerService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/exceprecog/ExceptionRecognizerService.adoc
index 97b9891..f6a6400 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/exceprecog/ExceptionRecognizerService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/exceprecog/ExceptionRecognizerService.adoc
@@ -1,16 +1,14 @@
-= ExceptionRecognizerService : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.ExceptionRecognizerService.java
[source,java]
----
interface ExceptionRecognizerService {
-
- Can<ExceptionRecognizer> getExceptionRecognizers() // <.>
-
- Optional<Recognition> recognize(Throwable ex) // <.>
-
- Optional<Recognition> recognizeFromSelected(Can<ExceptionRecognizer> recognizers, Throwable ex) // <.>
+ Can<ExceptionRecognizer> getExceptionRecognizers() // <.>
+ Optional<Recognition> recognize(Throwable ex) // <.>
+ Optional<Recognition> recognizeFromSelected(Can<ExceptionRecognizer> recognizers, Throwable ex) // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/factory/FactoryService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/factory/FactoryService.adoc
index 76eea7d..c7d4cfe 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/factory/FactoryService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/factory/FactoryService.adoc
@@ -1,30 +1,21 @@
-= FactoryService : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.FactoryService.java
[source,java]
----
interface FactoryService {
-
- T getOrCreate(Class<T> requiredType) // <.>
-
- T get(Class<T> requiredType) // <.>
-
- T detachedEntity(Class<T> domainClass) // <.>
-
- T detachedEntity(T entity) // <.>
-
- T mixin(Class<T> mixinClass, Object mixedIn) // <.>
-
- T viewModel(Class<T> viewModelClass, String mementoStr) // <.>
-
- T viewModel(Class<T> viewModelClass) // <.>
-
- T viewModel(T viewModel) // <.>
-
- T create(Class<T> domainClass) // <.>
-
- T instantiate(Class<T> domainClass) // <.>
+ T getOrCreate(Class<T> requiredType) // <.>
+ T get(Class<T> requiredType) // <.>
+ T detachedEntity(Class<T> domainClass) // <.>
+ T detachedEntity(T entity) // <.>
+ T mixin(Class<T> mixinClass, Object mixedIn) // <.>
+ T viewModel(Class<T> viewModelClass, String mementoStr) // <.>
+ T viewModel(Class<T> viewModelClass) // <.>
+ T viewModel(T viewModel) // <.>
+ T create(Class<T> domainClass) // <.>
+ T instantiate(Class<T> domainClass) // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/grid/GridLoaderService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/grid/GridLoaderService.adoc
index d5224f2..19f7246 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/grid/GridLoaderService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/grid/GridLoaderService.adoc
@@ -1,20 +1,16 @@
-= GridLoaderService : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.GridLoaderService.java
[source,java]
----
interface GridLoaderService {
-
- boolean supportsReloading() // <.>
-
- void remove(Class<?> domainClass) // <.>
-
- boolean existsFor(Class<?> domainClass) // <.>
-
- Grid load(final Class<?> domainClass) // <.>
-
- Grid load(final Class<?> domainClass, String layout) // <.>
+ boolean supportsReloading() // <.>
+ void remove(Class<?> domainClass) // <.>
+ boolean existsFor(Class<?> domainClass) // <.>
+ Grid load(final Class<?> domainClass) // <.>
+ Grid load(final Class<?> domainClass, String layout) // <.>
}
----
@@ -31,16 +27,16 @@ To support metamodel invalidation/rebuilding of spec.
<.> `[teal]#*existsFor*#(Class<?> domainClass)` : `boolean`
+
--
-Whether any persisted layout metadata (eg a.layout.xmlfile) exists for this domain class.
+Whether any persisted layout metadata (eg a `.layout.xmlfile) exists for this domain class.
--
<.> `[teal]#*load*#(Class<?> domainClass)` : `xref:system:generated:index/applib/layout/grid/Grid.adoc[Grid]`
+
--
-Returns a new instance of a xref:system:generated:index/applib/layout/grid/Grid.adoc[Grid] for the specified domain class, eg from alayout.xmlfile, elsenull.
+Returns a new instance of a xref:system:generated:index/applib/layout/grid/Grid.adoc[Grid] for the specified domain class, eg from a `layout.xmlfile, else `null.
--
<.> `[teal]#*load*#(Class<?> domainClass, String layout)` : `xref:system:generated:index/applib/layout/grid/Grid.adoc[Grid]`
+
--
-Returns a new instance of a xref:system:generated:index/applib/layout/grid/Grid.adoc[Grid] for the specified domain class, eg from alayout.xmlfile, elsenull.
+Returns a new instance of a xref:system:generated:index/applib/layout/grid/Grid.adoc[Grid] for the specified domain class, eg from a `layout.xmlfile, else `null.
--
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/grid/GridService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/grid/GridService.adoc
index 4fc353f..e2a99be 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/grid/GridService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/grid/GridService.adoc
@@ -1,28 +1,20 @@
-= GridService : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.GridService.java
[source,java]
----
interface GridService {
-
- boolean supportsReloading() // <.>
-
- void remove(Class<?> domainClass) // <.>
-
- boolean existsFor(Class<?> domainClass) // <.>
-
- Grid load(final Class<?> domainClass) // <.>
-
- Grid load(Class<?> domainClass, String layout) // <.>
-
- Grid defaultGridFor(Class<?> domainClass) // <.>
-
- Grid normalize(final Grid grid) // <.>
-
- Grid complete(Grid grid) // <.>
-
- Grid minimal(Grid grid) // <.>
+ boolean supportsReloading() // <.>
+ void remove(Class<?> domainClass) // <.>
+ boolean existsFor(Class<?> domainClass) // <.>
+ Grid load(final Class<?> domainClass) // <.>
+ Grid load(Class<?> domainClass, String layout) // <.>
+ Grid defaultGridFor(Class<?> domainClass) // <.>
+ Grid normalize(final Grid grid) // <.>
+ Grid complete(Grid grid) // <.>
+ Grid minimal(Grid grid) // <.>
}
----
@@ -39,17 +31,17 @@ To support metamodel invalidation/rebuilding of spec.
<.> `[teal]#*existsFor*#(Class<?> domainClass)` : `boolean`
+
--
-Whether any persisted layout metadata (eg a.layout.xmlfile) exists for this domain class.
+Whether any persisted layout metadata (eg a `.layout.xmlfile) exists for this domain class.
--
<.> `[teal]#*load*#(Class<?> domainClass)` : `xref:system:generated:index/applib/layout/grid/Grid.adoc[Grid]`
+
--
-Returns a new instance of a xref:system:generated:index/applib/layout/grid/Grid.adoc[Grid] for the specified domain class, eg from alayout.xmlfile, elsenull.
+Returns a new instance of a xref:system:generated:index/applib/layout/grid/Grid.adoc[Grid] for the specified domain class, eg from a `layout.xmlfile, else `null.
--
<.> `[teal]#*load*#(Class<?> domainClass, String layout)` : `xref:system:generated:index/applib/layout/grid/Grid.adoc[Grid]`
+
--
-Returns a new instance of a xref:system:generated:index/applib/layout/grid/Grid.adoc[Grid] for the specified domain class, eg from a[domainClass].layout.[layout].xmlfile, elsenull.
+Returns a new instance of a xref:system:generated:index/applib/layout/grid/Grid.adoc[Grid] for the specified domain class, eg from a `[domainClass].layout.[layout].xmlfile, else `null.
--
<.> `[teal]#*defaultGridFor*#(Class<?> domainClass)` : `xref:system:generated:index/applib/layout/grid/Grid.adoc[Grid]`
+
@@ -61,20 +53,20 @@ Returns a default grid; eg where none can be loaded using _#load(Class)_ .
--
Returns a normalized grid for the domain class obtained previously using _#load(Class)_ .
-If a "normalized" grid is persisted as thelayout.xml, then the expectation is that the xref:system:generated:index/applib/annotation/MemberOrder.adoc[MemberOrder] annotation can be removed from the domain class because the binding of properties/collections/actions will be within the XML. However, the layout annotations ( xref:system:generated:index/applib/annotation/DomainObjectLayout.adoc[DomainObjectLayout] , xref:system:generated:index/applib/annotation/ActionLayout.adoc[ActionLayout] [...]
+If a "normalized" grid is persisted as the `layout.xml, then the expectation is that the xref:system:generated:index/applib/annotation/MemberOrder.adoc[MemberOrder] annotation can be removed from the domain class because the binding of properties/collections/actions will be within the XML. However, the layout annotations ( xref:system:generated:index/applib/annotation/DomainObjectLayout.adoc[DomainObjectLayout] , xref:system:generated:index/applib/annotation/ActionLayout.adoc[ActionLayou [...]
--
<.> `[teal]#*complete*#(xref:system:generated:index/applib/layout/grid/Grid.adoc[Grid] grid)` : `xref:system:generated:index/applib/layout/grid/Grid.adoc[Grid]`
+
--
Modifies the provided xref:system:generated:index/applib/layout/grid/Grid.adoc[Grid] with additional metadata, broadly speaking corresponding to the xref:system:generated:index/applib/annotation/DomainObjectLayout.adoc[DomainObjectLayout] , xref:system:generated:index/applib/annotation/ActionLayout.adoc[ActionLayout] , xref:system:generated:index/applib/annotation/PropertyLayout.adoc[PropertyLayout] and xref:system:generated:index/applib/annotation/CollectionLayout.adoc[CollectionLayout] .
-If a "completed" grid is persisted as thelayout.xml, then there should be no need for any of the layout annotations, nor the xref:system:generated:index/applib/annotation/MemberOrder.adoc[MemberOrder] annotations, to be required in the domain class itself.
+If a "completed" grid is persisted as the `layout.xml, then there should be no need for any of the layout annotations, nor the xref:system:generated:index/applib/annotation/MemberOrder.adoc[MemberOrder] annotations, to be required in the domain class itself.
--
<.> `[teal]#*minimal*#(xref:system:generated:index/applib/layout/grid/Grid.adoc[Grid] grid)` : `xref:system:generated:index/applib/layout/grid/Grid.adoc[Grid]`
+
--
Modifies the provided xref:system:generated:index/applib/layout/grid/Grid.adoc[Grid] , removing all metadata except the basic grid structure.
-If a "minimal" grid is persisted as thelayout.xml, then the expectation is that most of the layout annotations ( xref:system:generated:index/applib/annotation/DomainObjectLayout.adoc[DomainObjectLayout] , xref:system:generated:index/applib/annotation/ActionLayout.adoc[ActionLayout] , xref:system:generated:index/applib/annotation/PropertyLayout.adoc[PropertyLayout] , xref:system:generated:index/applib/annotation/CollectionLayout.adoc[CollectionLayout] , but also xref:system:generated:inde [...]
+If a "minimal" grid is persisted as the `layout.xml, then the expectation is that most of the layout annotations ( xref:system:generated:index/applib/annotation/DomainObjectLayout.adoc[DomainObjectLayout] , xref:system:generated:index/applib/annotation/ActionLayout.adoc[ActionLayout] , xref:system:generated:index/applib/annotation/PropertyLayout.adoc[PropertyLayout] , xref:system:generated:index/applib/annotation/CollectionLayout.adoc[CollectionLayout] , but also xref:system:generated:in [...]
--
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/grid/GridSystemService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/grid/GridSystemService.adoc
index c5ac8d6..f0fb561 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/grid/GridSystemService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/grid/GridSystemService.adoc
@@ -1,25 +1,19 @@
-= GridSystemService : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Provides an implementation of xref:system:generated:index/applib/layout/grid/Grid.adoc[Grid] .
-.Java Sources
+== API
+
+.GridSystemService.java
[source,java]
----
interface GridSystemService {
-
- Class<G> gridImplementation() // <.>
-
+ Class<G> gridImplementation() // <.>
String tns()
-
String schemaLocation()
-
G defaultGrid(Class<?> domainClass)
-
- void normalize(G grid, Class<?> domainClass) // <.>
-
+ void normalize(G grid, Class<?> domainClass) // <.>
void complete(G grid, Class<?> domainClass)
-
void minimal(G grid, Class<?> domainClass)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/health/Health.adoc b/antora/components/system/modules/generated/pages/index/applib/services/health/Health.adoc
index 750fabe..338244d 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/health/Health.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/health/Health.adoc
@@ -1,17 +1,14 @@
-= Health : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.Health.java
[source,java]
----
class Health {
-
Health ok()
-
Health error(final Throwable throwable)
-
Health error(String message)
-
boolean getResult()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/health/HealthCheckService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/health/HealthCheckService.adoc
index 0c7b3df..ad292b4 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/health/HealthCheckService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/health/HealthCheckService.adoc
@@ -1,11 +1,11 @@
-= HealthCheckService : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.HealthCheckService.java
[source,java]
----
interface HealthCheckService {
-
Health check()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/hint/HintStore.adoc b/antora/components/system/modules/generated/pages/index/applib/services/hint/HintStore.adoc
index 5d42a42..753721d 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/hint/HintStore.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/hint/HintStore.adoc
@@ -1,19 +1,15 @@
-= HintStore : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.HintStore.java
[source,java]
----
interface HintStore {
-
String get(final Bookmark bookmark, String hintKey)
-
void set(final Bookmark bookmark, String hintKey, String value)
-
void remove(final Bookmark bookmark, String hintKey)
-
void removeAll(Bookmark bookmark)
-
Set<String> findHintKeys(Bookmark bookmark)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/homepage/HomePageResolverService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/homepage/HomePageResolverService.adoc
index e87ee7c..b1300d8 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/homepage/HomePageResolverService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/homepage/HomePageResolverService.adoc
@@ -1,13 +1,13 @@
-= HomePageResolverService : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Returns a view model annotated with xref:system:generated:index/applib/annotation/HomePage.adoc[HomePage] .
-.Java Sources
+== API
+
+.HomePageResolverService.java
[source,java]
----
interface HomePageResolverService {
-
Object getHomePage()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/i18n/LocaleProvider.adoc b/antora/components/system/modules/generated/pages/index/applib/services/i18n/LocaleProvider.adoc
index afedcb3..c7e38ec 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/i18n/LocaleProvider.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/i18n/LocaleProvider.adoc
@@ -1,11 +1,11 @@
-= LocaleProvider : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.LocaleProvider.java
[source,java]
----
interface LocaleProvider {
-
Locale getLocale()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/i18n/TranslatableString.adoc b/antora/components/system/modules/generated/pages/index/applib/services/i18n/TranslatableString.adoc
index 91564f6..d981cf2 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/i18n/TranslatableString.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/i18n/TranslatableString.adoc
@@ -1,35 +1,23 @@
-= TranslatableString : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.TranslatableString.java
[source,java]
----
class TranslatableString {
-
- TranslatableString tr(final String pattern, final Object... paramArgs) // <.>
-
- TranslatableString trn(final String singularPattern, final String pluralPattern, final int number, final Object... paramArgs) // <.>
-
- String getSingularText() // <.>
-
- String getPluralText() // <.>
-
+ TranslatableString tr(final String pattern, final Object... paramArgs) // <.>
+ TranslatableString trn(final String singularPattern, final String pluralPattern, final int number, final Object... paramArgs) // <.>
+ String getSingularText() // <.>
+ String getPluralText() // <.>
boolean isPluralForm()
-
- Map<String, Object> getArgumentsByParameterName() // <.>
-
- String translate(final TranslationService translationService, final String context) // <.>
-
- String getPattern() // <.>
-
+ Map<String, Object> getArgumentsByParameterName() // <.>
+ String translate(final TranslationService translationService, final String context) // <.>
+ String getPattern() // <.>
String translated(final String translatedText)
-
String format(String format, Map<String, Object> values)
-
boolean equals(final Object o)
-
int hashCode()
-
String toString()
}
----
@@ -47,12 +35,12 @@ A translatable string with different patterns for singular and plural forms, sel
<.> `[teal]#*getSingularText*#()` : `String`
+
--
-The text as provided in (either of the _#tr(String, Object...) factory_ _#trn(String, String, int, Object...) method_ s, with placeholders rather than substituted arguments; if _#isPluralForm()_ istruethen used only for the singular form.
+The text as provided in (either of the _#tr(String, Object...) factory_ _#trn(String, String, int, Object...) method_ s, with placeholders rather than substituted arguments; if _#isPluralForm()_ is `truethen used only for the singular form.
--
<.> `[teal]#*getPluralText*#()` : `String`
+
--
-The plural text as provided in the _#trn(String, String, int, Object...) factory method_ , with placeholders rather than substituted arguments; but will benullif _#isPluralForm()_ isfalse.
+The plural text as provided in the _#trn(String, String, int, Object...) factory method_ , with placeholders rather than substituted arguments; but will be `nullif _#isPluralForm()_ is `false.
--
<.> `[teal]#*getArgumentsByParameterName*#()` : `Map<String, Object>`
+
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/i18n/TranslationService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/i18n/TranslationService.adoc
index 8ee9c09..b8a33f6 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/i18n/TranslationService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/i18n/TranslationService.adoc
@@ -1,16 +1,14 @@
-= TranslationService : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.TranslationService.java
[source,java]
----
interface TranslationService {
-
- String translate(final String context, final String text) // <.>
-
- String translate(final String context, final String singularText, final String pluralText, int num) // <.>
-
- Mode getMode() // <.>
+ String translate(final String context, final String text) // <.>
+ String translate(final String context, final String singularText, final String pluralText, int num) // <.>
+ Mode getMode() // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/i18n/TranslationsResolver.adoc b/antora/components/system/modules/generated/pages/index/applib/services/i18n/TranslationsResolver.adoc
index b0009fe..8b23cc6 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/i18n/TranslationsResolver.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/i18n/TranslationsResolver.adoc
@@ -1,11 +1,11 @@
-= TranslationsResolver : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.TranslationsResolver.java
[source,java]
----
interface TranslationsResolver {
-
List<String> readLines(final String file)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/iactn/ExecutionContext.adoc b/antora/components/system/modules/generated/pages/index/applib/services/iactn/ExecutionContext.adoc
index fb1c5cf..0e9adad 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/iactn/ExecutionContext.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/iactn/ExecutionContext.adoc
@@ -1,14 +1,14 @@
-= ExecutionContext : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Provides the user and scenario specific environment for an _Interaction.Execution_
-.Java Sources
+== API
+
+.ExecutionContext.java
[source,java]
----
class ExecutionContext {
-
- ExecutionContext ofUserWithSystemDefaults(final UserMemento user) // <.>
+ ExecutionContext ofUserWithSystemDefaults(final UserMemento user) // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/iactn/Interaction.adoc b/antora/components/system/modules/generated/pages/index/applib/services/iactn/Interaction.adoc
index 570945d..5f31fa5 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/iactn/Interaction.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/iactn/Interaction.adoc
@@ -1,4 +1,3 @@
-= Interaction : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Represents an action invocation or property modification, resulting in some state change of the system. It captures not only the target object and arguments passed, but also builds up the call-graph, and captures metrics, eg for profiling.
@@ -9,18 +8,16 @@ To confuse matters slightly, historically the xref:system:generated:index/applib
NOTE: you could also think of this interface as being analogous to the (database) transaction. The name "Transaction" has not been used for the interface not chosen however because there is also the system-level transaction that manages the persistence of the xref:system:generated:index/applib/services/command/Command.adoc[Command] object itself.
-.Java Sources
+== API
+
+.Interaction.java
[source,java]
----
interface Interaction {
-
Command getCommand()
-
- Execution<?, ?> getCurrentExecution() // <.>
-
- Execution<?, ?> getPriorExecution() // <.>
-
- int next(final String sequenceId) // <.>
+ Execution<?, ?> getCurrentExecution() // <.>
+ Execution<?, ?> getPriorExecution() // <.>
+ int next(final String sequenceId) // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/iactn/InteractionContext.adoc b/antora/components/system/modules/generated/pages/index/applib/services/iactn/InteractionContext.adoc
index c7b19641..897822d 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/iactn/InteractionContext.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/iactn/InteractionContext.adoc
@@ -1,15 +1,14 @@
-= InteractionContext : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Provides the current thread's xref:system:generated:index/applib/services/iactn/Interaction.adoc[Interaction] .
-.Java Sources
+== API
+
+.InteractionContext.java
[source,java]
----
interface InteractionContext {
-
- Optional<Interaction> currentInteraction() // <.>
-
+ Optional<Interaction> currentInteraction() // <.>
Interaction currentInteractionElseFail()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/inject/ServiceInjector.adoc b/antora/components/system/modules/generated/pages/index/applib/services/inject/ServiceInjector.adoc
index 93fe115..11ab3ce 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/inject/ServiceInjector.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/inject/ServiceInjector.adoc
@@ -1,17 +1,16 @@
-= ServiceInjector : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Resolves injection points using the ServiceRegistry.
Implementation must be thread-safe.
-.Java Sources
+== API
+
+.ServiceInjector.java
[source,java]
----
interface ServiceInjector {
-
T injectServicesInto(final T domainObject, Consumer<InjectionPoint> onNotResolvable)
-
T injectServicesInto(final T domainObject)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/jaxb/JaxbService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/jaxb/JaxbService.adoc
index 97ef9fb..b04e305 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/jaxb/JaxbService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/jaxb/JaxbService.adoc
@@ -1,23 +1,17 @@
-= JaxbService : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.JaxbService.java
[source,java]
----
interface JaxbService {
-
Object fromXml(JAXBContext jaxbContext, String xml)
-
Object fromXml(JAXBContext jaxbContext, String xml, Map<String, Object> unmarshallerProperties)
-
- T fromXml(Class<T> domainClass, String xml) // <.>
-
- T fromXml(Class<T> domainClass, String xml, Map<String, Object> unmarshallerProperties) // <.>
-
+ T fromXml(Class<T> domainClass, String xml) // <.>
+ T fromXml(Class<T> domainClass, String xml, Map<String, Object> unmarshallerProperties) // <.>
String toXml(Object domainObject)
-
String toXml(Object domainObject, Map<String, Object> marshallerProperties)
-
Map<String, String> toXsd(Object domainObject, IsisSchemas isisSchemas)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/layout/LayoutService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/layout/LayoutService.adoc
index 1517344..889e51b 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/layout/LayoutService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/layout/LayoutService.adoc
@@ -1,16 +1,14 @@
-= LayoutService : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.LayoutService.java
[source,java]
----
interface LayoutService {
-
- String toXml(Class<?> domainClass, Style style) // <.>
-
- byte[] toZip(final Style style) // <.>
-
- String toMenuBarsXml(final MenuBarsService.Type type) // <.>
+ String toXml(Class<?> domainClass, Style style) // <.>
+ byte[] toZip(final Style style) // <.>
+ String toMenuBarsXml(final MenuBarsService.Type type) // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/layout/LayoutServiceMenu.adoc b/antora/components/system/modules/generated/pages/index/applib/services/layout/LayoutServiceMenu.adoc
index 9872266..0593ad0 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/layout/LayoutServiceMenu.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/layout/LayoutServiceMenu.adoc
@@ -1,24 +1,18 @@
-= LayoutServiceMenu : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.LayoutServiceMenu.java
[source,java]
----
class LayoutServiceMenu {
-
@Inject
LayoutService layoutService;
-
LayoutServiceMenu()
-
Blob downloadLayouts(final LayoutService.Style style)
-
LayoutService.Style default0DownloadLayouts()
-
Clob downloadMenuBarsLayout(final String fileName, final MenuBarsService.Type type)
-
String default0DownloadMenuBarsLayout()
-
MenuBarsService.Type default1DownloadMenuBarsLayout()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/linking/DeepLinkService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/linking/DeepLinkService.adoc
index 792cbad..fed12eb 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/linking/DeepLinkService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/linking/DeepLinkService.adoc
@@ -1,16 +1,16 @@
-= DeepLinkService : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
A service that creates a web link to any domain object in one of the Isis viewers.
The implementation is specific to the viewer(s) configured for Isis. At the time of writing only one implementation is available, for the Wicket viewer.
-.Java Sources
+== API
+
+.DeepLinkService.java
[source,java]
----
interface DeepLinkService {
-
- URI deepLinkFor(Object domainObject) // <.>
+ URI deepLinkFor(Object domainObject) // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsLoaderService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsLoaderService.adoc
index 9c179ab..a335724 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsLoaderService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsLoaderService.adoc
@@ -1,14 +1,13 @@
-= MenuBarsLoaderService : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.MenuBarsLoaderService.java
[source,java]
----
interface MenuBarsLoaderService {
-
- boolean supportsReloading() // <.>
-
- BS3MenuBars menuBars() // <.>
+ boolean supportsReloading() // <.>
+ BS3MenuBars menuBars() // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
index 0e6f0f6..3edebd7 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/menu/MenuBarsService.adoc
@@ -1,13 +1,12 @@
-= MenuBarsService : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.MenuBarsService.java
[source,java]
----
interface MenuBarsService {
-
- MenuBars menuBars() // <.>
-
+ MenuBars menuBars() // <.>
MenuBars menuBars(final Type type)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/message/MessageService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/message/MessageService.adoc
index e2f2f8d..af0f6f6 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/message/MessageService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/message/MessageService.adoc
@@ -1,28 +1,20 @@
-= MessageService : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.MessageService.java
[source,java]
----
interface MessageService {
-
- void informUser(String message) // <.>
-
- String informUser(TranslatableString message, final Class<?> contextClass, final String contextMethod) // <.>
-
- String informUser(TranslatableString message, final String translationContext) // <.>
-
- void warnUser(String message) // <.>
-
- String warnUser(TranslatableString message, final Class<?> contextClass, final String contextMethod) // <.>
-
- String warnUser(TranslatableString message, final String translationContext) // <.>
-
- void raiseError(String message) // <.>
-
- String raiseError(TranslatableString message, final Class<?> contextClass, final String contextMethod) // <.>
-
- String raiseError(TranslatableString message, final String translationContext) // <.>
+ void informUser(String message) // <.>
+ String informUser(TranslatableString message, final Class<?> contextClass, final String contextMethod) // <.>
+ String informUser(TranslatableString message, final String translationContext) // <.>
+ void warnUser(String message) // <.>
+ String warnUser(TranslatableString message, final Class<?> contextClass, final String contextMethod) // <.>
+ String warnUser(TranslatableString message, final String translationContext) // <.>
+ void raiseError(String message) // <.>
+ String raiseError(TranslatableString message, final Class<?> contextClass, final String contextMethod) // <.>
+ String raiseError(TranslatableString message, final String translationContext) // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/metamodel/BeanSort.adoc b/antora/components/system/modules/generated/pages/index/applib/services/metamodel/BeanSort.adoc
index 98fc8f9..93c84c3 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/metamodel/BeanSort.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/metamodel/BeanSort.adoc
@@ -1,45 +1,29 @@
-= BeanSort : _enum_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Top level object classification.
-.Java Sources
+== API
+
+.BeanSort.java
[source,java]
----
enum BeanSort {
-
- VIEW_MODEL // <.>
-
- ENTITY // <.>
-
- MANAGED_BEAN_CONTRIBUTING // <.>
-
- MANAGED_BEAN_NOT_CONTRIBUTING // <.>
-
- MIXIN // <.>
-
- VALUE // <.>
-
- COLLECTION // <.>
-
+ VIEW_MODEL // <.>
+ ENTITY // <.>
+ MANAGED_BEAN_CONTRIBUTING // <.>
+ MANAGED_BEAN_NOT_CONTRIBUTING // <.>
+ MIXIN // <.>
+ VALUE // <.>
+ COLLECTION // <.>
UNKNOWN
-
boolean isManagedBean()
-
boolean isMixin()
-
boolean isViewModel()
-
boolean isValue()
-
boolean isCollection()
-
boolean isEntity()
-
boolean isUnknown()
-
boolean isToBeIntrospected()
-
boolean isWrappingSupported()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/metamodel/DomainMember.adoc b/antora/components/system/modules/generated/pages/index/applib/services/metamodel/DomainMember.adoc
index e28015f..f716808 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/metamodel/DomainMember.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/metamodel/DomainMember.adoc
@@ -1,37 +1,24 @@
-= DomainMember : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.DomainMember.java
[source,java]
----
interface DomainMember {
-
String getClassType()
-
String getClassName()
-
String getPackageName()
-
String getType()
-
String getMemberName()
-
String getNumParams()
-
boolean isMixedIn()
-
String getMixin()
-
String getHidden()
-
String getDisabled()
-
String getValidate()
-
String getChoices()
-
String getAutoComplete()
-
String getDefault()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/metamodel/DomainModel.adoc b/antora/components/system/modules/generated/pages/index/applib/services/metamodel/DomainModel.adoc
index 41feffb..ba1b47e 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/metamodel/DomainModel.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/metamodel/DomainModel.adoc
@@ -1,11 +1,11 @@
-= DomainModel : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.DomainModel.java
[source,java]
----
interface DomainModel {
-
List<DomainMember> getDomainMembers()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/metamodel/MetaModelService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/metamodel/MetaModelService.adoc
index 985778c..a118193 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/metamodel/MetaModelService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/metamodel/MetaModelService.adoc
@@ -1,29 +1,22 @@
-= MetaModelService : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
This service provides a formal API into Isis' metamodel.
This API is currently extremely limited, but the intention is to extend it gradually as use cases emerge.
-.Java Sources
+== API
+
+.MetaModelService.java
[source,java]
----
interface MetaModelService {
-
- Class<?> fromObjectType(final String objectType) // <.>
-
- String toObjectType(final Class<?> domainType) // <.>
-
+ Class<?> fromObjectType(final String objectType) // <.>
+ String toObjectType(final Class<?> domainType) // <.>
void rebuild(final Class<?> domainType)
-
- DomainModel getDomainModel() // <.>
-
+ DomainModel getDomainModel() // <.>
BeanSort sortOf(Class<?> domainType, Mode mode)
-
BeanSort sortOf(Bookmark bookmark, Mode mode)
-
CommandDtoProcessor commandDtoProcessorFor(String logicalMemberIdentifier)
-
MetamodelDto exportMetaModel(final Config config)
}
----
@@ -31,12 +24,12 @@ interface MetaModelService {
<.> `[teal]#*fromObjectType*#(String objectType)` : `Class<?>`
+
--
-Provides a reverse lookup of a domain class' object type, as defined by _DomainObject#objectType()_ (or any other mechanism that corresponds to Isis'ObjectSpecIdFacet).
+Provides a reverse lookup of a domain class' object type, as defined by _DomainObject#objectType()_ (or any other mechanism that corresponds to Isis' `ObjectSpecIdFacet).
--
<.> `[teal]#*toObjectType*#(Class<?> domainType)` : `String`
+
--
-Provides a lookup of a domain class' object type, as defined by _DomainObject#objectType()_ (or any other mechanism that corresponds to Isis'ObjectSpecIdFacet).
+Provides a lookup of a domain class' object type, as defined by _DomainObject#objectType()_ (or any other mechanism that corresponds to Isis' `ObjectSpecIdFacet).
--
<.> `[teal]#*getDomainModel*#()` : `xref:system:generated:index/applib/services/metamodel/DomainModel.adoc[DomainModel]`
+
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/metamodel/MetaModelServiceMenu.adoc b/antora/components/system/modules/generated/pages/index/applib/services/metamodel/MetaModelServiceMenu.adoc
index 2162e61..351b743 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/metamodel/MetaModelServiceMenu.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/metamodel/MetaModelServiceMenu.adoc
@@ -1,35 +1,24 @@
-= MetaModelServiceMenu : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.MetaModelServiceMenu.java
[source,java]
----
class MetaModelServiceMenu {
-
final MimeType mimeTypeTextCsv;
-
final MimeType mimeTypeTextXml;
-
@Inject
MetaModelService metaModelService;
-
@Inject
JaxbService jaxbService;
-
MetaModelServiceMenu()
-
Clob downloadMetaModelCsv(final String csvFileName)
-
String default0DownloadMetaModelCsv()
-
Clob downloadMetaModelXml(final String fileName, final List<String> packages, final boolean ignoreInterfaces)
-
String validateDownloadMetaModelXml(final String fileName, final List<String> packagePrefixes, final boolean ignoreInterfaces)
-
String default0DownloadMetaModelXml()
-
List<String> choices1DownloadMetaModelXml()
-
boolean default2DownloadMetaModelXml()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/metrics/MetricsService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/metrics/MetricsService.adoc
index 0066349..f83e294 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/metrics/MetricsService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/metrics/MetricsService.adoc
@@ -1,14 +1,13 @@
-= MetricsService : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.MetricsService.java
[source,java]
----
interface MetricsService {
-
- int numberEntitiesLoaded() // <.>
-
- int numberEntitiesDirtied() // <.>
+ int numberEntitiesLoaded() // <.>
+ int numberEntitiesDirtied() // <.>
}
----
@@ -17,7 +16,7 @@ interface MetricsService {
--
The number of entities that have, so far in this request, been loaded from the database.
-Corresponds to the number of times thatjavax.jdo.listener.LoadLifecycleListener#postLoad(InstanceLifecycleEvent)(or equivalent) is fired.
+Corresponds to the number of times that `javax.jdo.listener.LoadLifecycleListener#postLoad(InstanceLifecycleEvent)(or equivalent) is fired.
Is captured within _MemberExecutionDto#getMetrics()_ (accessible from _InteractionContext#currentInteraction()_ ).
--
@@ -26,7 +25,7 @@ Is captured within _MemberExecutionDto#getMetrics()_ (accessible from _Interacti
--
The number of objects that have, so far in this request, been dirtied/will need updating in the database); a good measure of the footprint of the interaction.
-Corresponds to the number of times thatjavax.jdo.listener.DirtyLifecycleListener#preDirty(InstanceLifecycleEvent)(or equivalent) callback is fired.
+Corresponds to the number of times that `javax.jdo.listener.DirtyLifecycleListener#preDirty(InstanceLifecycleEvent)(or equivalent) callback is fired.
Is captured within _MemberExecutionDto#getMetrics()_ (accessible from _InteractionContext#currentInteraction()_ .
--
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/publishing/log/CommandLogger.adoc b/antora/components/system/modules/generated/pages/index/applib/services/publishing/log/CommandLogger.adoc
index 7d2ad3f..165c71f 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/publishing/log/CommandLogger.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/publishing/log/CommandLogger.adoc
@@ -1,13 +1,12 @@
-= CommandLogger : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.CommandLogger.java
[source,java]
----
class CommandLogger {
-
boolean isEnabled()
-
void onCompleted(Command command)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/publishing/log/EntityChangesLogger.adoc b/antora/components/system/modules/generated/pages/index/applib/services/publishing/log/EntityChangesLogger.adoc
index 655560b..d0b8d6e 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/publishing/log/EntityChangesLogger.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/publishing/log/EntityChangesLogger.adoc
@@ -1,13 +1,12 @@
-= EntityChangesLogger : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.EntityChangesLogger.java
[source,java]
----
class EntityChangesLogger {
-
boolean isEnabled()
-
void onChanging(final EntityChanges changingEntities)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/publishing/log/EntityPropertyChangeLogger.adoc b/antora/components/system/modules/generated/pages/index/applib/services/publishing/log/EntityPropertyChangeLogger.adoc
index 6f29861..b98f2ef 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/publishing/log/EntityPropertyChangeLogger.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/publishing/log/EntityPropertyChangeLogger.adoc
@@ -1,13 +1,12 @@
-= EntityPropertyChangeLogger : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.EntityPropertyChangeLogger.java
[source,java]
----
class EntityPropertyChangeLogger {
-
boolean isEnabled()
-
void onChanging(final EntityPropertyChange entityPropertyChange)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/publishing/log/ExecutionLogger.adoc b/antora/components/system/modules/generated/pages/index/applib/services/publishing/log/ExecutionLogger.adoc
index 60608d7..c0b10cb 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/publishing/log/ExecutionLogger.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/publishing/log/ExecutionLogger.adoc
@@ -1,13 +1,12 @@
-= ExecutionLogger : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.ExecutionLogger.java
[source,java]
----
class ExecutionLogger {
-
boolean isEnabled()
-
void onExecution(final Interaction.Execution<?, ?> execution)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/publishing/spi/CommandSubscriber.adoc b/antora/components/system/modules/generated/pages/index/applib/services/publishing/spi/CommandSubscriber.adoc
index 27e3106..5fd1f2e 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/publishing/spi/CommandSubscriber.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/publishing/spi/CommandSubscriber.adoc
@@ -1,14 +1,14 @@
-= CommandSubscriber : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Part of the _Publishing SPI_ . A component to receive xref:system:generated:index/applib/services/command/Command.adoc[Command] s (with publishing enabled) that just completed.
-.Java Sources
+== API
+
+.CommandSubscriber.java
[source,java]
----
interface CommandSubscriber {
-
- void onCompleted(Command command) // <.>
+ void onCompleted(Command command) // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/publishing/spi/EntityChanges.adoc b/antora/components/system/modules/generated/pages/index/applib/services/publishing/spi/EntityChanges.adoc
index 724cf98..331e578 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/publishing/spi/EntityChanges.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/publishing/spi/EntityChanges.adoc
@@ -1,23 +1,17 @@
-= EntityChanges : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.EntityChanges.java
[source,java]
----
interface EntityChanges {
-
Timestamp getCompletedAt()
-
int getNumberLoaded()
-
int getNumberCreated()
-
int getNumberUpdated()
-
int getNumberDeleted()
-
int getNumberPropertiesModified()
-
ChangesDto getDto()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/publishing/spi/EntityChangesSubscriber.adoc b/antora/components/system/modules/generated/pages/index/applib/services/publishing/spi/EntityChangesSubscriber.adoc
index 0bc0185..6bfc73c 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/publishing/spi/EntityChangesSubscriber.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/publishing/spi/EntityChangesSubscriber.adoc
@@ -1,14 +1,14 @@
-= EntityChangesSubscriber : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Part of the _Publishing SPI_ . A component to receive the entire set of entities (with publishing enabled) that are about to change, serializable as ChangesDto.
-.Java Sources
+== API
+
+.EntityChangesSubscriber.java
[source,java]
----
interface EntityChangesSubscriber {
-
- void onChanging(EntityChanges entityChanges) // <.>
+ void onChanging(EntityChanges entityChanges) // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/publishing/spi/EntityPropertyChange.adoc b/antora/components/system/modules/generated/pages/index/applib/services/publishing/spi/EntityPropertyChange.adoc
index 98310a4..e867efb 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/publishing/spi/EntityPropertyChange.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/publishing/spi/EntityPropertyChange.adoc
@@ -1,13 +1,13 @@
-= EntityPropertyChange : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Immutable data record for xref:system:generated:index/applib/services/publishing/spi/EntityPropertyChangeSubscriber.adoc[EntityPropertyChangeSubscriber] s.
-.Java Sources
+== API
+
+.EntityPropertyChange.java
[source,java]
----
class EntityPropertyChange {
-
String toString()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/publishing/spi/EntityPropertyChangeSubscriber.adoc b/antora/components/system/modules/generated/pages/index/applib/services/publishing/spi/EntityPropertyChangeSubscriber.adoc
index 3cb6789..be2e3c1 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/publishing/spi/EntityPropertyChangeSubscriber.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/publishing/spi/EntityPropertyChangeSubscriber.adoc
@@ -1,14 +1,14 @@
-= EntityPropertyChangeSubscriber : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Part of the _Publishing SPI_ . A component to receive pre-post property values for each changed entity (with publishing enabled).
-.Java Sources
+== API
+
+.EntityPropertyChangeSubscriber.java
[source,java]
----
interface EntityPropertyChangeSubscriber {
-
- void onChanging(EntityPropertyChange entityPropertyChange) // <.>
+ void onChanging(EntityPropertyChange entityPropertyChange) // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/publishing/spi/ExecutionSubscriber.adoc b/antora/components/system/modules/generated/pages/index/applib/services/publishing/spi/ExecutionSubscriber.adoc
index f8634ac..fd496b7 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/publishing/spi/ExecutionSubscriber.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/publishing/spi/ExecutionSubscriber.adoc
@@ -1,14 +1,14 @@
-= ExecutionSubscriber : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
SPI that allows individual interactions (action invocations or property edits) to be _#onExecution(Interaction.Execution) published_ . Note that re-publishing is not part of this SPI.
-.Java Sources
+== API
+
+.ExecutionSubscriber.java
[source,java]
----
interface ExecutionSubscriber {
-
- void onExecution(Interaction.Execution<?, ?> execution) // <.>
+ void onExecution(Interaction.Execution<?, ?> execution) // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/queryresultscache/QueryResultCacheControl.adoc b/antora/components/system/modules/generated/pages/index/applib/services/queryresultscache/QueryResultCacheControl.adoc
index b2b1652..0fa06ff 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/queryresultscache/QueryResultCacheControl.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/queryresultscache/QueryResultCacheControl.adoc
@@ -1,11 +1,11 @@
-= QueryResultCacheControl : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.QueryResultCacheControl.java
[source,java]
----
interface QueryResultCacheControl {
-
boolean isIgnoreCache()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/queryresultscache/QueryResultsCache.adoc b/antora/components/system/modules/generated/pages/index/applib/services/queryresultscache/QueryResultsCache.adoc
index f4234dd..d2f875a 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/queryresultscache/QueryResultsCache.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/queryresultscache/QueryResultsCache.adoc
@@ -1,29 +1,22 @@
-= QueryResultsCache : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
This service (API and implementation) provides a mechanism by which idempotent query results can be cached for the duration of an interaction. Most commonly this allows otherwise "naive" - eg that makes a repository call many times within a loop - to be performance tuned. The benefit is that the algorithm of the business logic can remain easy to understand.
This implementation has no UI and there is only one implementation (this class) in applib, it is annotated with _org.apache.isis.applib.annotation.DomainService_ . This means that it is automatically registered and available for use; no further configuration is required.
-.Java Sources
+== API
+
+.QueryResultsCache.java
[source,java]
----
interface QueryResultsCache {
-
T execute(Callable<T> callable, Class<?> callingClass, String methodName, Object... keys)
-
- void onTransactionEnded() // <.>
-
+ void onTransactionEnded() // <.>
R execute(MethodReferences.Call0<? extends R> action, Class<?> callingClass, String methodName)
-
R execute(MethodReferences.Call1<? extends R, A0> action, Class<?> callingClass, String methodName, A0 arg0)
-
R execute(MethodReferences.Call2<? extends R, A0, A1> action, Class<?> callingClass, String methodName, A0 arg0, A1 arg1)
-
R execute(MethodReferences.Call3<? extends R, A0, A1, A2> action, Class<?> callingClass, String methodName, A0 arg0, A1 arg1, A2 arg2)
-
R execute(MethodReferences.Call4<? extends R, A0, A1, A2, A3> action, Class<?> callingClass, String methodName, A0 arg0, A1 arg1, A2 arg2, A3 arg3)
-
R execute(MethodReferences.Call5<? extends R, A0, A1, A2, A3, A4> action, Class<?> callingClass, String methodName, A0 arg0, A1 arg1, A2 arg2, A3 arg3, A4 arg4)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/registry/ServiceRegistry.adoc b/antora/components/system/modules/generated/pages/index/applib/services/registry/ServiceRegistry.adoc
index aa89170..55a8f45 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/registry/ServiceRegistry.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/registry/ServiceRegistry.adoc
@@ -1,27 +1,19 @@
-= ServiceRegistry : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.ServiceRegistry.java
[source,java]
----
interface ServiceRegistry {
-
- Can<T> select(Class<T> type, Annotation[] qualifiers) // <.>
-
- Can<T> select(final Class<T> type) // <.>
-
- Stream<_ManagedBeanAdapter> streamRegisteredBeansOfType(Class<?> requiredType) // <.>
-
- Stream<_ManagedBeanAdapter> streamRegisteredBeans() // <.>
-
- Optional<_ManagedBeanAdapter> lookupRegisteredBeanById(String id) // <.>
-
- _ManagedBeanAdapter lookupRegisteredBeanByIdElseFail(String id) // <.>
-
+ Can<T> select(Class<T> type, Annotation[] qualifiers) // <.>
+ Can<T> select(final Class<T> type) // <.>
+ Stream<_ManagedBeanAdapter> streamRegisteredBeansOfType(Class<?> requiredType) // <.>
+ Stream<_ManagedBeanAdapter> streamRegisteredBeans() // <.>
+ Optional<_ManagedBeanAdapter> lookupRegisteredBeanById(String id) // <.>
+ _ManagedBeanAdapter lookupRegisteredBeanByIdElseFail(String id) // <.>
Optional<?> lookupBeanById(final String id)
-
- Optional<T> lookupService(final Class<T> serviceClass) // <.>
-
+ Optional<T> lookupService(final Class<T> serviceClass) // <.>
T lookupServiceElseFail(final Class<T> serviceClass)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc b/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
index 7d5acf9..d10ceff 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/repository/EntityState.adoc
@@ -1,25 +1,18 @@
-= EntityState : _enum_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.EntityState.java
[source,java]
----
enum EntityState {
-
NOT_PERSISTABLE
-
PERSISTABLE_ATTACHED
-
PERSISTABLE_DETACHED
-
PERSISTABLE_DESTROYED
-
boolean isPersistable()
-
boolean isAttached()
-
boolean isDetached()
-
boolean isDestroyed()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/repository/RepositoryService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/repository/RepositoryService.adoc
index 9a14d0b..59e3fbb 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/repository/RepositoryService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/repository/RepositoryService.adoc
@@ -1,54 +1,33 @@
-= RepositoryService : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.RepositoryService.java
[source,java]
----
interface RepositoryService {
-
- EntityState getEntityState(Object object) // <.>
-
- T detachedEntity(T entity) // <.>
-
- T persist(T domainObject) // <.>
-
- T persistAndFlush(T domainObject) // <.>
-
- void remove(Object domainObject) // <.>
-
- void removeAndFlush(Object domainObject) // <.>
-
- void removeAll(Class<T> cls) // <.>
-
- List<T> allInstances(Class<T> ofType) // <.>
-
- List<T> allInstances(Class<T> ofType, long start, long count) // <.>
-
- List<T> allMatches(Class<T> ofType, Predicate<? super T> predicate) // <.>
-
- List<T> allMatches(Class<T> ofType, Predicate<? super T> predicate, long start, long count) // <.>
-
- List<T> allMatches(Query<T> query) // <.>
-
- Optional<T> uniqueMatch(Class<T> ofType, Predicate<T> predicate) // <.>
-
- Optional<T> uniqueMatch(Query<T> query) // <.>
-
- Optional<T> firstMatch(Class<T> ofType, Predicate<T> predicate) // <.>
-
- Optional<T> firstMatch(Query<T> query) // <.>
-
- T refresh(T pojo) // <.>
-
- T detach(T entity) // <.>
-
- T detachedEntity(Class<T> ofType) // <.>
-
- T instantiate(Class<T> ofType) // <.>
-
- boolean isPersistent(Object domainObject) // <.>
-
- boolean isDeleted(Object domainObject) // <.>
+ EntityState getEntityState(Object object) // <.>
+ T detachedEntity(T entity) // <.>
+ T persist(T domainObject) // <.>
+ T persistAndFlush(T domainObject) // <.>
+ void remove(Object domainObject) // <.>
+ void removeAndFlush(Object domainObject) // <.>
+ void removeAll(Class<T> cls) // <.>
+ List<T> allInstances(Class<T> ofType) // <.>
+ List<T> allInstances(Class<T> ofType, long start, long count) // <.>
+ List<T> allMatches(Class<T> ofType, Predicate<? super T> predicate) // <.>
+ List<T> allMatches(Class<T> ofType, Predicate<? super T> predicate, long start, long count) // <.>
+ List<T> allMatches(Query<T> query) // <.>
+ Optional<T> uniqueMatch(Class<T> ofType, Predicate<T> predicate) // <.>
+ Optional<T> uniqueMatch(Query<T> query) // <.>
+ Optional<T> firstMatch(Class<T> ofType, Predicate<T> predicate) // <.>
+ Optional<T> firstMatch(Query<T> query) // <.>
+ T refresh(T pojo) // <.>
+ T detach(T entity) // <.>
+ T detachedEntity(Class<T> ofType) // <.>
+ T instantiate(Class<T> ofType) // <.>
+ boolean isPersistent(Object domainObject) // <.>
+ boolean isDeleted(Object domainObject) // <.>
}
----
@@ -206,7 +185,7 @@ due to ambiguous semantic, use _#getEntityState(Object)_ instead
Determines if the specified object is persistent (that it is stored permanently outside of the virtual machine in the object store).
-This method can also returntrueif the object has been _#isDeleted(Object) deleted_ from the object store.
+This method can also return `trueif the object has been _#isDeleted(Object) deleted_ from the object store.
--
<.> `[line-through gray]#*isDeleted*#(Object domainObject)` : `boolean`
+
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/routing/RoutingService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/routing/RoutingService.adoc
index fd21cc0..73eb8a6 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/routing/RoutingService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/routing/RoutingService.adoc
@@ -1,15 +1,14 @@
-= RoutingService : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Provides the ability to return (and therefore have rendered) an alternative object from an action invocation.
-.Java Sources
+== API
+
+.RoutingService.java
[source,java]
----
interface RoutingService {
-
boolean canRoute(Object original)
-
Object route(Object original)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/scratchpad/Scratchpad.adoc b/antora/components/system/modules/generated/pages/index/applib/services/scratchpad/Scratchpad.adoc
index 5938429..93be836 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/scratchpad/Scratchpad.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/scratchpad/Scratchpad.adoc
@@ -1,18 +1,17 @@
-= Scratchpad : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
This service (API and implementation) provides a mechanism to interchange information between multiple objects invoked in the same interaction. Most commonly this will be as the result of invoking a bulk action.
This implementation has only one implementation (this class) in applib, so it is annotated with _org.apache.isis.applib.annotation.DomainService_ . This means that it is automatically registered and available for use; no further configuration is required.
-.Java Sources
+== API
+
+.Scratchpad.java
[source,java]
----
interface Scratchpad {
-
- Object get(Object key) // <.>
-
- void put(Object key, Object value) // <.>
+ Object get(Object key) // <.>
+ void put(Object key, Object value) // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/session/SessionLoggingService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/session/SessionLoggingService.adoc
index 270d5ab..7187331 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/session/SessionLoggingService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/session/SessionLoggingService.adoc
@@ -1,13 +1,13 @@
-= SessionLoggingService : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Similar to the _org.apache.isis.applib.services.publishing.spi.EntityPropertyChangeSubscriber_ , this defines an API to track the status of the current sessions ("users logged on") on the system.
-.Java Sources
+== API
+
+.SessionLoggingService.java
[source,java]
----
interface SessionLoggingService {
-
void log(Type type, String username, Date date, CausedBy causedBy, String sessionId)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/session/SessionLoggingServiceLogging.adoc b/antora/components/system/modules/generated/pages/index/applib/services/session/SessionLoggingServiceLogging.adoc
index 70a28c5..5781aa6 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/session/SessionLoggingServiceLogging.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/session/SessionLoggingServiceLogging.adoc
@@ -1,11 +1,11 @@
-= SessionLoggingServiceLogging : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.SessionLoggingServiceLogging.java
[source,java]
----
class SessionLoggingServiceLogging {
-
void log(final Type type, final String username, final Date date, final CausedBy causedBy, final String sessionId)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/sudo/SudoService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/sudo/SudoService.adoc
index 97bce57..7e848d4 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/sudo/SudoService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/sudo/SudoService.adoc
@@ -1,18 +1,16 @@
-= SudoService : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Intended only for use by fixture scripts and integration tests, allows a block of code to execute while the xref:system:generated:index/applib/services/user/UserService.adoc[UserService] 's _UserService#currentUser() getUser()_ method returns the specified user/role as the effective user.
-.Java Sources
+== API
+
+.SudoService.java
[source,java]
----
interface SudoService {
-
- RoleMemento ACCESS_ALL_ROLE; // <.>
-
- T call(UnaryOperator<ExecutionContext> sudoMapper, Callable<T> supplier) // <.>
-
- void run(final UnaryOperator<ExecutionContext> sudoMapper, final ThrowingRunnable runnable) // <.>
+ RoleMemento ACCESS_ALL_ROLE; // <.>
+ T call(UnaryOperator<ExecutionContext> sudoMapper, Callable<T> supplier) // <.>
+ void run(final UnaryOperator<ExecutionContext> sudoMapper, final ThrowingRunnable runnable) // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/swagger/SwaggerService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/swagger/SwaggerService.adoc
index d421789..33e3782 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/swagger/SwaggerService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/swagger/SwaggerService.adoc
@@ -1,13 +1,13 @@
-= SwaggerService : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
The xref:system:generated:index/applib/services/swagger/SwaggerService.adoc[SwaggerService] generates Swagger schema definition files to describe the public and/or private RESTful APIs exposed by the RestfulObjects viewer.
-.Java Sources
+== API
+
+.SwaggerService.java
[source,java]
----
interface SwaggerService {
-
String generateSwaggerSpec(final Visibility visibility, final Format format)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/tablecol/TableColumnOrderForCollectionTypeAbstract.adoc b/antora/components/system/modules/generated/pages/index/applib/services/tablecol/TableColumnOrderForCollectionTypeAbstract.adoc
index 78a8791..1e1e49e 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/tablecol/TableColumnOrderForCollectionTypeAbstract.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/tablecol/TableColumnOrderForCollectionTypeAbstract.adoc
@@ -1,13 +1,12 @@
-= TableColumnOrderForCollectionTypeAbstract : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.TableColumnOrderForCollectionTypeAbstract.java
[source,java]
----
class TableColumnOrderForCollectionTypeAbstract {
-
List<String> orderParented(final Object parent, final String collectionId, final Class<?> collectionType, final List<String> propertyIds)
-
List<String> orderStandalone(final Class<?> collectionType, final List<String> propertyIds)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/tablecol/TableColumnOrderService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/tablecol/TableColumnOrderService.adoc
index 155c5a0..d6c4b64 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/tablecol/TableColumnOrderService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/tablecol/TableColumnOrderService.adoc
@@ -1,13 +1,12 @@
-= TableColumnOrderService : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.TableColumnOrderService.java
[source,java]
----
interface TableColumnOrderService {
-
List<String> orderParented(final Object parent, final String collectionId, final Class<?> collectionType, final List<String> propertyIds)
-
List<String> orderStandalone(final Class<?> collectionType, final List<String> propertyIds)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/title/TitleService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/title/TitleService.adoc
index b6dfa85..317f4f2 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/title/TitleService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/title/TitleService.adoc
@@ -1,14 +1,13 @@
-= TitleService : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.TitleService.java
[source,java]
----
interface TitleService {
-
- String titleOf(Object domainObject) // <.>
-
- String iconNameOf(Object domainObject) // <.>
+ String titleOf(Object domainObject) // <.>
+ String iconNameOf(Object domainObject) // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/urlencoding/UrlEncodingService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/urlencoding/UrlEncodingService.adoc
index a0b357e..8163b8c 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/urlencoding/UrlEncodingService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/urlencoding/UrlEncodingService.adoc
@@ -1,17 +1,14 @@
-= UrlEncodingService : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.UrlEncodingService.java
[source,java]
----
interface UrlEncodingService {
-
String encode(final byte[] bytes)
-
byte[] decode(String str)
-
String encodeString(final String str)
-
String decodeToString(final String str)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/urlencoding/UrlEncodingServiceUsingBaseEncodingAbstract.adoc b/antora/components/system/modules/generated/pages/index/applib/services/urlencoding/UrlEncodingServiceUsingBaseEncodingAbstract.adoc
index 6d447d7..abae96f 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/urlencoding/UrlEncodingServiceUsingBaseEncodingAbstract.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/urlencoding/UrlEncodingServiceUsingBaseEncodingAbstract.adoc
@@ -1,13 +1,12 @@
-= UrlEncodingServiceUsingBaseEncodingAbstract : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-.Java Sources
+== API
+
+.UrlEncodingServiceUsingBaseEncodingAbstract.java
[source,java]
----
class UrlEncodingServiceUsingBaseEncodingAbstract {
-
String encode(final byte[] bytes)
-
byte[] decode(final String str)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/user/RoleMemento.adoc b/antora/components/system/modules/generated/pages/index/applib/services/user/RoleMemento.adoc
index cb4274c..8eebfa3 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/user/RoleMemento.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/user/RoleMemento.adoc
@@ -1,17 +1,15 @@
-= RoleMemento : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Immutable serializable value held by xref:system:generated:index/applib/services/user/UserMemento.adoc[UserMemento] .
-.Java Sources
+== API
+
+.RoleMemento.java
[source,java]
----
class RoleMemento {
-
- RoleMemento(final String name) // <.>
-
- RoleMemento(final String name, final String description) // <.>
-
+ RoleMemento(final String name) // <.>
+ RoleMemento(final String name, final String description) // <.>
String title()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/user/UserMemento.adoc b/antora/components/system/modules/generated/pages/index/applib/services/user/UserMemento.adoc
index 117dd65..fd922f1 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/user/UserMemento.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/user/UserMemento.adoc
@@ -1,39 +1,26 @@
-= UserMemento : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Immutable serializable value holding details about a user and its roles.
-.Java Sources
+== API
+
+.UserMemento.java
[source,java]
----
class UserMemento {
-
- UserMemento(final String name, final Stream<RoleMemento> roles) // <.>
-
- UserMemento system() // <.>
-
- UserMemento ofName(final String name) // <.>
-
- UserMemento ofNameAndRoles(final String name, final RoleMemento... roles) // <.>
-
- UserMemento ofNameAndRoleNames(final String name, final String... roleNames) // <.>
-
- UserMemento ofNameAndRoleNames(final String name, final Stream<String> roleNames) // <.>
-
+ UserMemento(final String name, final Stream<RoleMemento> roles) // <.>
+ UserMemento system() // <.>
+ UserMemento ofName(final String name) // <.>
+ UserMemento ofNameAndRoles(final String name, final RoleMemento... roles) // <.>
+ UserMemento ofNameAndRoleNames(final String name, final String... roleNames) // <.>
+ UserMemento ofNameAndRoleNames(final String name, final Stream<String> roleNames) // <.>
String title()
-
List<RoleMemento> getRoles()
-
- boolean isCurrentUser(final String userName) // <.>
-
+ boolean isCurrentUser(final String userName) // <.>
Stream<String> streamRoleNames()
-
boolean hasRoleName(final String roleName)
-
String toString()
-
boolean equals(Object obj)
-
int hashCode()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/user/UserService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/user/UserService.adoc
index b4f2b89..445664c 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/user/UserService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/user/UserService.adoc
@@ -1,24 +1,20 @@
-= UserService : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
The xref:system:generated:index/applib/services/user/UserService.adoc[UserService] allows the domain object to obtain the identity of the user interacting with said object.
If xref:system:generated:index/applib/services/sudo/SudoService.adoc[SudoService] has been used to temporarily override the user and/or roles, then this service will report the overridden values instead.
-.Java Sources
+== API
+
+.UserService.java
[source,java]
----
interface UserService {
-
- Optional<UserMemento> currentUser() // <.>
-
- UserMemento getUser() // <.>
-
- UserMemento currentUserElseFail() // <.>
-
- Optional<String> currentUserName() // <.>
-
- String currentUserNameElseNobody() // <.>
+ Optional<UserMemento> currentUser() // <.>
+ UserMemento getUser() // <.>
+ UserMemento currentUserElseFail() // <.>
+ Optional<String> currentUserName() // <.>
+ String currentUserNameElseNobody() // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/userprof/UserProfileService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/userprof/UserProfileService.adoc
index 74c6837..639380e 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/userprof/UserProfileService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/userprof/UserProfileService.adoc
@@ -1,16 +1,16 @@
-= UserProfileService : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Optional API providing details about the user.
Used by the Wicket viewer in its _org.apache.isis.applib.annotation.DomainServiceLayout.MenuBar#TERTIARY tertiary_ "Me" menu bar.
-.Java Sources
+== API
+
+.UserProfileService.java
[source,java]
----
interface UserProfileService {
-
- String userProfileName() // <.>
+ String userProfileName() // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/userreg/EmailNotificationService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/userreg/EmailNotificationService.adoc
index ef770b1..b1857af 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/userreg/EmailNotificationService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/userreg/EmailNotificationService.adoc
@@ -1,20 +1,18 @@
-= EmailNotificationService : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Supporting service for the user-registration functionality.
-The framework provides a default implementation which in turn uses the _org.apache.isis.applib.services.email.EmailService_ , namelyEmailServiceDefault.
+The framework provides a default implementation which in turn uses the _org.apache.isis.applib.services.email.EmailService_ , namely `EmailServiceDefault.
-.Java Sources
+== API
+
+.EmailNotificationService.java
[source,java]
----
interface EmailNotificationService {
-
boolean send(EmailRegistrationEvent ev)
-
boolean send(PasswordResetEvent ev)
-
- boolean isConfigured() // <.>
+ boolean isConfigured() // <.>
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/userreg/UserDetails.adoc b/antora/components/system/modules/generated/pages/index/applib/services/userreg/UserDetails.adoc
index f784c7e..e676d0a 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/userreg/UserDetails.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/userreg/UserDetails.adoc
@@ -1,9 +1,10 @@
-= UserDetails : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
A model object for the signup page
-.Java Sources
+== API
+
+.UserDetails.java
[source,java]
----
class UserDetails {
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/userreg/UserRegistrationService.adoc b/antora/components/system/modules/generated/pages/index/applib/services/userreg/UserRegistrationService.adoc
index 0ca86ab..9b40d6f 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/userreg/UserRegistrationService.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/userreg/UserRegistrationService.adoc
@@ -1,21 +1,18 @@
-= UserRegistrationService : _interface_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Required API to enable users to register an account on the system (aka "sign up").
-User registration also requires that the xref:system:generated:index/applib/services/userreg/EmailNotificationService.adoc[EmailNotificationService] and _org.apache.isis.applib.services.email.EmailService_ to be configured. The framework provides default implementations of both of these services. The notification service requires no further configuration. The email service (EmailServiceDefault) _does_ require a couple of configuration properties to be set (specifying the SMTP mail server [...]
+User registration also requires that the xref:system:generated:index/applib/services/userreg/EmailNotificationService.adoc[EmailNotificationService] and _org.apache.isis.applib.services.email.EmailService_ to be configured. The framework provides default implementations of both of these services. The notification service requires no further configuration. The email service ( `EmailServiceDefault) _does_ require a couple of configuration properties to be set (specifying the SMTP mail serv [...]
-.Java Sources
+== API
+
+.UserRegistrationService.java
[source,java]
----
interface UserRegistrationService {
-
boolean usernameExists(String username)
-
boolean emailExists(String emailAddress)
-
void registerUser(UserDetails userDetails)
-
boolean updatePasswordByEmail(String emailAddress, String password)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/userreg/events/EmailEventAbstract.adoc b/antora/components/system/modules/generated/pages/index/applib/services/userreg/events/EmailEventAbstract.adoc
index 3e5f9fb..33734ea 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/userreg/events/EmailEventAbstract.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/userreg/events/EmailEventAbstract.adoc
@@ -1,19 +1,16 @@
-= EmailEventAbstract : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
An event sent to all services interested in user registration
-.Java Sources
+== API
+
+.EmailEventAbstract.java
[source,java]
----
class EmailEventAbstract {
-
EmailEventAbstract(final String email, final String confirmationUrl, final String applicationName)
-
String getEmail()
-
String getConfirmationUrl()
-
String getApplicationName()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/userreg/events/EmailRegistrationEvent.adoc b/antora/components/system/modules/generated/pages/index/applib/services/userreg/events/EmailRegistrationEvent.adoc
index e3bcdb3..d0bacaa 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/userreg/events/EmailRegistrationEvent.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/userreg/events/EmailRegistrationEvent.adoc
@@ -1,13 +1,13 @@
-= EmailRegistrationEvent : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
An event send to all services interested in user registration
-.Java Sources
+== API
+
+.EmailRegistrationEvent.java
[source,java]
----
class EmailRegistrationEvent {
-
EmailRegistrationEvent(final String email, final String confirmationUrl, final String applicationName)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/userreg/events/PasswordResetEvent.adoc b/antora/components/system/modules/generated/pages/index/applib/services/userreg/events/PasswordResetEvent.adoc
index f578a8b..51086a3 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/userreg/events/PasswordResetEvent.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/userreg/events/PasswordResetEvent.adoc
@@ -1,13 +1,13 @@
-= PasswordResetEvent : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
An event send to all services interested in user password reset
-.Java Sources
+== API
+
+.PasswordResetEvent.java
[source,java]
----
class PasswordResetEvent {
-
PasswordResetEvent(final String email, final String confirmationUrl, final String applicationName)
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/wrapper/DisabledException.adoc b/antora/components/system/modules/generated/pages/index/applib/services/wrapper/DisabledException.adoc
index 0272fba..b8e1041 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/wrapper/DisabledException.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/wrapper/DisabledException.adoc
@@ -1,15 +1,14 @@
-= DisabledException : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Superclass of exceptions which indicate an attempt to interact with a class member that is disabled.
-.Java Sources
+== API
+
+.DisabledException.java
[source,java]
----
class DisabledException {
-
DisabledException(final InteractionEvent interactionEvent)
-
UsabilityEvent getInteractionEvent()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/wrapper/HiddenException.adoc b/antora/components/system/modules/generated/pages/index/applib/services/wrapper/HiddenException.adoc
index f6dc43d..6d819d9 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/wrapper/HiddenException.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/wrapper/HiddenException.adoc
@@ -1,15 +1,14 @@
-= HiddenException : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Superclass of exceptions which indicate an attempt to interact with a class member that is in some way hidden or invisible.
-.Java Sources
+== API
+
+.HiddenException.java
[source,java]
----
class HiddenException {
-
HiddenException(final InteractionEvent interactionEvent)
-
VisibilityEvent getInteractionEvent()
}
----
diff --git a/antora/components/system/modules/generated/pages/index/applib/services/wrapper/InvalidException.adoc b/antora/components/system/modules/generated/pages/index/applib/services/wrapper/InvalidException.adoc
index 57b0b37..eb40f3f 100644
--- a/antora/components/system/modules/generated/pages/index/applib/services/wrapper/InvalidException.adoc
+++ b/antora/components/system/modules/generated/pages/index/applib/services/wrapper/InvalidException.adoc
@@ -1,15 +1,14 @@
-= InvalidException : _class_
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
Superclass of exceptions which indicate an attempt to interact with an object or member in a way that is invalid.
-.Java Sources
+== API
+
+.InvalidException.java
[source,java]
----
... 28898 lines suppressed ...