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 2017/10/16 14:43:01 UTC
[isis] 07/08: ISIS-1742: removes DomainObjectContainer#informUser,
warnUser, raiseError ... use MessageService instead.
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch dev/2.0.0/ISIS-1742-remove-deprecations
in repository https://gitbox.apache.org/repos/asf/isis.git
commit 91ddb8d3aa2df95c3253387df320786c598e30ed
Author: Dan Haywood <da...@haywood-associates.co.uk>
AuthorDate: Mon Oct 16 15:39:30 2017 +0100
ISIS-1742: removes DomainObjectContainer#informUser, warnUser, raiseError ... use MessageService instead.
---
...rgsvc_application-layer-api_MessageService.adoc | 5 ---
...gsvc_core-domain-api_DomainObjectContainer.adoc | 1 -
...ain-api_DomainObjectContainer_messages-api.adoc | 45 --------------------
.../apache/isis/applib/DomainObjectContainer.java | 46 --------------------
.../container/DomainObjectContainerDefault.java | 49 ----------------------
todo-deprecation-list.txt | 2 +-
6 files changed, 1 insertion(+), 147 deletions(-)
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-api_MessageService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-api_MessageService.adoc
index e3c64c2..d6c09ed 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-api_MessageService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_application-layer-api_MessageService.adoc
@@ -8,11 +8,6 @@
The `MessageService` allows domain objects to raise information, warning or error messages.
These messages can either be simple strings, or can be translated.
-[NOTE]
-====
-The methods in this service replace similar methods (now deprecated) in xref:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_DomainObjectContainer[`DomainObjectContainer`].
-====
-
== API and Usage
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_core-domain-api_DomainObjectContainer.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_core-domain-api_DomainObjectContainer.adoc
index 14cd3de..dcea101 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_core-domain-api_DomainObjectContainer.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_core-domain-api_DomainObjectContainer.adoc
@@ -23,7 +23,6 @@ The sections below discuss the functions provided by the service, broken out int
include::_rgsvc_core-domain-api_DomainObjectContainer_object-creation-api.adoc[leveloffset=+2]
include::_rgsvc_core-domain-api_DomainObjectContainer_object-persistence-api.adoc[leveloffset=+2]
-include::_rgsvc_core-domain-api_DomainObjectContainer_messages-api.adoc[leveloffset=+2]
include::_rgsvc_core-domain-api_DomainObjectContainer_security-api.adoc[leveloffset=+2]
include::_rgsvc_core-domain-api_DomainObjectContainer_properties-api.adoc[leveloffset=+2]
include::_rgsvc_core-domain-api_DomainObjectContainer_services-api.adoc[leveloffset=+2]
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_core-domain-api_DomainObjectContainer_messages-api.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_core-domain-api_DomainObjectContainer_messages-api.adoc
deleted file mode 100644
index e93885b..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_core-domain-api_DomainObjectContainer_messages-api.adoc
+++ /dev/null
@@ -1,45 +0,0 @@
-[[_rgsvc_core-domain-api_DomainObjectContainer_messages-api]]
-= Messages API
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-:_basedir: ../../
-:_imagesdir: images/
-
-
-
-The `DomainObjectContainer` allows domain objects to raise information, warning or error messages. These messages can either be simple strings, or can be translated.
-
-[source,java]
-----
-public interface DomainObjectContainer {
-
- void informUser(String message); // <1>
- String informUser(TranslatableString message, Class<?> contextClass, String contextMethod); // <2>
-
- void warnUser(String message); // <3>
- String warnUser(TranslatableString message, Class<?> contextClass, String contextMethod); // <4>
-
- void raiseError(String message); // <5>
- String raiseError(TranslatableString message, Class<?> contextClass, String contextMethod); // <6>
- ...
-}
-----
-<1> display as a transient message to the user (not requiring acknowledgement). In the xref:../ugvw/ugvw.adoc#[Wicket viewer] this is implemented as a toast that automatically disappears after a period of time.
-<2> ditto, but with translatable string, for xref:../ugbtb/ugbtb.adoc#_ugbtb_i18n[i18n support].
-<3> warn the user about a situation with the specified message. In the xref:../ugvw/ugvw.adoc#[Wicket viewer] this is implemented as a toast that must be closed by the end-user.
-<4> ditto, but with translatable string, for i18n support.
-<5> show the user an unexpected application error. In the xref:../ugvw/ugvw.adoc#[Wicket viewer] this is implemented as a toast (with a different colour) that must be closed by the end-user.
-<6> ditto, but with translatable string, for i18n support.
-
-
-For example:
-
-[source,java]
-----
-public Order addItem(Product product, @ParameterLayout(named="Quantity") int quantity) {
- if(productRepository.stockLevel(product) == 0) {
- container.warnUser(
- product.getDescription() + " out of stock; order fulfillment may be delayed");
- }
- ...
-}
-----
diff --git a/core/applib/src/main/java/org/apache/isis/applib/DomainObjectContainer.java b/core/applib/src/main/java/org/apache/isis/applib/DomainObjectContainer.java
index 586f434..e6a5c38 100644
--- a/core/applib/src/main/java/org/apache/isis/applib/DomainObjectContainer.java
+++ b/core/applib/src/main/java/org/apache/isis/applib/DomainObjectContainer.java
@@ -272,52 +272,6 @@ public interface DomainObjectContainer {
//endregion
- //region > info, warn, error (DEPRECATED)
-
- /**
- * @deprecated - use {@link org.apache.isis.applib.services.message.MessageService#informUser(String)} instead.
- */
- @Deprecated
- @Programmatic
- void informUser(String message);
-
- /**
- * @deprecated - use {@link org.apache.isis.applib.services.message.MessageService#informUser(TranslatableString, Class, String)} instead.
- */
- @Deprecated
- @Programmatic
- String informUser(TranslatableString message, final Class<?> contextClass, final String contextMethod);
-
- /**
- * @deprecated - use {@link org.apache.isis.applib.services.message.MessageService#warnUser(String)} instead.
- */
- @Deprecated
- @Programmatic
- void warnUser(String message);
-
- /**
- * @deprecated - use {@link org.apache.isis.applib.services.message.MessageService#warnUser(TranslatableString, Class, String)} instead.
- */
- @Deprecated
- @Programmatic
- String warnUser(TranslatableString message, final Class<?> contextClass, final String contextMethod);
-
- /**
- * @deprecated - use {@link org.apache.isis.applib.services.message.MessageService#raiseError(String)} instead.
- */
- @Deprecated
- @Programmatic
- void raiseError(String message);
-
- /**
- * @deprecated - use {@link org.apache.isis.applib.services.message.MessageService#raiseError(TranslatableString, Class, String)} instead.
- */
- @Deprecated
- @Programmatic
- String raiseError(TranslatableString message, final Class<?> contextClass, final String contextMethod);
-
- //endregion
-
//region > properties (DEPRECATED)
/**
diff --git a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/services/container/DomainObjectContainerDefault.java b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/services/container/DomainObjectContainerDefault.java
index 14ef7bd..e26afc6 100644
--- a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/services/container/DomainObjectContainerDefault.java
+++ b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/services/container/DomainObjectContainerDefault.java
@@ -366,52 +366,6 @@ public class DomainObjectContainerDefault
//endregion
- //region > info, warn, error messages
-
- @Deprecated
- @Programmatic
- @Override
- public void informUser(final String message) {
- messageService.informUser(message);
- }
-
- @Deprecated
- @Programmatic
- @Override
- public String informUser(final TranslatableString message, final Class<?> contextClass, final String contextMethod) {
- return messageService.informUser(message, contextClass, contextMethod);
- }
-
- @Deprecated
- @Programmatic
- @Override
- public void warnUser(final String message) {
- messageService.warnUser(message);
- }
-
- @Deprecated
- @Programmatic
- @Override
- public String warnUser(final TranslatableString message, final Class<?> contextClass, final String contextMethod) {
- return messageService.warnUser(message, contextClass, contextMethod);
- }
-
- @Deprecated
- @Programmatic
- @Override
- public void raiseError(final String message) {
- messageService.raiseError(message);
- }
-
- @Deprecated
- @Programmatic
- @Override
- public String raiseError(final TranslatableString message, final Class<?> contextClass, final String contextMethod) {
- return messageService.raiseError(message, contextClass, contextMethod);
- }
-
-
- //endregion
// //////////////////////////////////////////////////////////////////
@@ -491,9 +445,6 @@ public class DomainObjectContainerDefault
FactoryService factoryService;
@javax.inject.Inject
- MessageService messageService;
-
- @javax.inject.Inject
RepositoryService repositoryService;
@javax.inject.Inject
diff --git a/todo-deprecation-list.txt b/todo-deprecation-list.txt
index 49719db..ceaa561 100644
--- a/todo-deprecation-list.txt
+++ b/todo-deprecation-list.txt
@@ -462,4 +462,4 @@ org.apache.isis.applib
- titleOf ... use TitleService#titleOf(...) instead
- iconNameOf ... use TitleService#iconNameOf(...) instead
- flush() ... use TransactionService#flushTransaction instead
-
+ - informUser, warnUser, raiseError ... use MessageService
--
To stop receiving notification emails like this one, please contact
"commits@isis.apache.org" <co...@isis.apache.org>.