Skip to content

Commit

Permalink
fix apidoc links
Browse files Browse the repository at this point in the history
  • Loading branch information
Dmytro Rud authored and Dmytro Rud committed Dec 5, 2023
1 parent 7b520f3 commit 512e0f3
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions _pages/ihe/hpd/hpdQueryControls.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ Normative reference: [RFC 2891 "LDAP Control Extension for Server Side Sorting o

The only thing a client application must do to request server-side sorting of search result entries,
is to put an instance of
[`SortControl2`](../../apidocs/org/openehealth/ipf/commons/ihe/hpd/controls/sorting/SortControl2),
[`SortControl2`](../../apidocs/org/openehealth/ipf/commons/ihe/hpd/controls/sorting/SortControl2.html),
rendered as DSMLv2, into the list field `control`of
[`SearchRequest`](../../apidocs/org/openehealth/ipf/commons/ihe/hpd/stub/dsmlv2/SearchRequest), e.g.:
[`SearchRequest`](../../apidocs/org/openehealth/ipf/commons/ihe/hpd/stub/dsmlv2/SearchRequest.html), e.g.:

```groovy
BatchRequest batchRequest = new BatchRequest(
Expand Down Expand Up @@ -51,7 +51,7 @@ from('hpd-iti58:hpd-service?...&supportSorting=true&...')
```

The current implementation supports only one sorting key in request controls
([`SortControl2`](../../apidocs/org/openehealth/ipf/commons/ihe/hpd/controls/sorting/SortControl2)).
([`SortControl2`](../../apidocs/org/openehealth/ipf/commons/ihe/hpd/controls/sorting/SortControl2.html)).

Moreover, the sorting rule specified by the client must be supported by the IPF application.
The following sorting rules are supported out-of-the box:
Expand All @@ -65,7 +65,7 @@ The following sorting rules are supported out-of-the box:

Application developers may extend this list by adding instances of `java.util.Comparator<String>`
into the static map `COMPARATORS` of
[`SearchResponseSorter`](../../apidocs/org/openehealth/ipf/commons/ihe/hpd/controls/sorting/SearchResponseSorter),
[`SearchResponseSorter`](../../apidocs/org/openehealth/ipf/commons/ihe/hpd/controls/sorting/SearchResponseSorter.html),
with sorting rule names as keys.

It is not required that all Search Requests of a Batch Request contain the same Sort Control or contain one at all.
Expand Down Expand Up @@ -93,7 +93,7 @@ On the producer side, the server endpoint URI parameter `supportPagination` shal

Furthermore, an instance of `javax.naming.ldap.PagedResultsControl` rendered as DSMLv2, shall be inserted
into the list field `control`of
[`SearchRequest`](../../apidocs/org/openehealth/ipf/commons/ihe/hpd/stub/dsmlv2/SearchRequest), e.g.:
[`SearchRequest`](../../apidocs/org/openehealth/ipf/commons/ihe/hpd/stub/dsmlv2/SearchRequest.html), e.g.:

```groovy
BatchRequest batchRequest = new BatchRequest(
Expand Down Expand Up @@ -121,16 +121,16 @@ caption="Producer-side support for paging of HPD search result entries" %}

To enable automatic paging of search result entries, the URI of the consumer endpoint shall contain two parameters —
`supportPagination` set to `true`, and `paginationStorage` set to the name of a bean implementing the interface
[`PaginationStorage`](../../apidocs/org/openehealth/ipf/commons/ihe/hpd/controls/pagination/PaginationStorage).
[`PaginationStorage`](../../apidocs/org/openehealth/ipf/commons/ihe/hpd/controls/pagination/PaginationStorage.html).
For example:

```groovy
from('hpd-iti58:hpd-service?...&supportPagination=true&paginationStorage=#myStorage&...')
```
IPF provides an implementation of
[`PaginationStorage`](../../apidocs/org/openehealth/ipf/commons/ihe/hpd/controls/pagination/PaginationStorage)
[`PaginationStorage`](../../apidocs/org/openehealth/ipf/commons/ihe/hpd/controls/pagination/PaginationStorage.html)
the class
[`EhcachePaginationStorage`](../../apidocs/org/openehealth/ipf/commons/ihe/hpd/controls/pagination/EhcachePaginationStorage),
[`EhcachePaginationStorage`](../../apidocs/org/openehealth/ipf/commons/ihe/hpd/controls/pagination/EhcachePaginationStorage.html),
which is backed up by Ehcache or any other javax.cache API (JSR-107) implementation and optionally
supports JAXB serialization of DSMLv2 Search Result Entries which is required for persistent caches.

Expand Down

0 comments on commit 512e0f3

Please sign in to comment.