=== Paging

:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR  CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
:page-partial:

The xref:refguide:applib:index/annotation/CollectionLayout.adoc#paged[paged()] element specifies the number of rows to display in a (parented) collection.

[WARNING]
====
The xref:vro:ROOT:about.adoc[RestfulObjects viewer] currently does not support paging.
The xref:vw:ROOT:about.adoc[Web UI (Wicket viewer)] _does_ support paging, but note that the paging is performed client-side rather than server-side.

We therefore recommend that large collections should instead be modelled as actions (to allow filtering to be applied to limit the number of rows).
====

For example:

[source,java]
----
import lombok.Getter;
import lombok.Setter;

public class Order {

    @CollectionLayout(paged=15)
    @Getter @Setter
    private SortedSet<OrderLine> details = ...
}
----

It is also possible to specify a global default for the page size of parented collections, using the xref:refguide:config:sections/causeway.applib.adoc#causeway.applib.annotation.collection-layout.paged[causeway.applib.annotation.collection-layout.paged] configuration property.


