DeepLinkService (interface)

A service that returns a web link (java.net.URI) to any domain object in one of the framework’s viewers.

A typical use case is to generate a clickable link for rendering in an email, PDF, tweet or other communication.

Note that the implementation is specific to the viewer(s). At the time of writing only one implementation is available, for the Wicket viewer.

API

DeepLinkService.java
interface DeepLinkService {
  URI deepLinkFor(Object domainObject)     (1)
}
1 deepLinkFor(Object)

Creates a URI that can be used to obtain a representation of the provided domain object in one of the Isis viewers.

Members

deepLinkFor(Object)

Creates a URI that can be used to obtain a representation of the provided domain object in one of the Isis viewers.

Implementation

The Web UI (Wicket viewer) provides an implementation of this service o.a.i.viewer.wicket.viewer.services.DeepLinkServiceWicket.

There is no domain service to support deep links to the URLs of the RestfulObjects viewer. However, a URL can be constructed easily enough according to the Restful Objects spec in conjunction with a Bookmark obtained via the BookmarkService.

Usage within the framework

The EmailNotificationService uses this service in order to generate emails as part of user registration.