This is an automated email from the ASF dual-hosted git repository.
ahuber pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git
The following commit(s) were added to refs/heads/master by this push:
new 42096537a8 ISIS-3290: Javadoc: add hints on object visibility
42096537a8 is described below
commit 42096537a885514fe9f6ec44eaa33b86fbd546ea
Author: Andi Huber <[email protected]>
AuthorDate: Mon Nov 21 17:38:01 2022 +0100
ISIS-3290: Javadoc: add hints on object visibility
---
.../java/org/apache/causeway/applib/annotation/DomainObject.java | 5 +++++
.../main/java/org/apache/causeway/applib/annotation/HomePage.java | 6 +++++-
2 files changed, 10 insertions(+), 1 deletion(-)
diff --git
a/api/applib/src/main/java/org/apache/causeway/applib/annotation/DomainObject.java
b/api/applib/src/main/java/org/apache/causeway/applib/annotation/DomainObject.java
index 263bd985ff..1c1f441a45 100644
---
a/api/applib/src/main/java/org/apache/causeway/applib/annotation/DomainObject.java
+++
b/api/applib/src/main/java/org/apache/causeway/applib/annotation/DomainObject.java
@@ -44,6 +44,11 @@ import org.apache.causeway.applib.services.bookmark.Bookmark;
/**
* Domain semantics for domain objects (entities and view models;
* for services see {@link
org.apache.causeway.applib.annotation.DomainService}).
+ * <p>
+ * If - for the currently logged on user - none of the domain object's
members are effectively visible,
+ * (or if there are no members to begin with), the object instance is
considered hidden. Hence
+ * a NOT-AUTHORIZED page will be displayed instead.
+ * </p>
*
* @apiNote Meta annotation {@link Component} allows for the Spring framework
to pick up (discover) the
* annotated type.
diff --git
a/api/applib/src/main/java/org/apache/causeway/applib/annotation/HomePage.java
b/api/applib/src/main/java/org/apache/causeway/applib/annotation/HomePage.java
index d7662b8751..db88f72d3c 100644
---
a/api/applib/src/main/java/org/apache/causeway/applib/annotation/HomePage.java
+++
b/api/applib/src/main/java/org/apache/causeway/applib/annotation/HomePage.java
@@ -27,7 +27,11 @@ import java.lang.annotation.Target;
/**
* Annotated on a view model to indicate that it should be used as the home
page.
- *
+ * <p>
+ * If - for the currently logged on user - none of the view model's
members are effectively visible,
+ * (or if there are no members to begin with), the view model instance is
considered hidden. Hence
+ * a NOT-AUTHORIZED page will be displayed instead.
+ * </p>
* <p>
* 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
