= CollectionLayoutData
: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.

Describes the layout of a single collection, broadly corresponds to the _org.apache.causeway.applib.annotation.CollectionLayout_ annotation.

== API

[source,java]
.CollectionLayoutData.java
----
class CollectionLayoutData {
  CollectionLayoutData()
  CollectionLayoutData(String id)
  String getId()     // <.>
  void setId(String id)
  String getCssClass()
  void setCssClass(String cssClass)
  String getDescribedAs()
  void setDescribedAs(String describedAs)
  String getDefaultView()     // <.>
  void setDefaultView(String defaultView)
  Where getHidden()
  void setHidden(Where hidden)
  String getNamed()
  void setNamed(String named)
  Integer getPaged()
  void setPaged(Integer paged)
  String getSortedBy()
  void setSortedBy(String sortedBy)
  Class<? extends TableDecorator> getTableDecorator()
  void setTableDecorator(Class<? extends TableDecorator> tableDecorator)
  List<ActionLayoutData> getActions()
  void setActions(List<ActionLayoutData> actionLayoutDatas)
  CollectionLayoutDataOwner getOwner()     // <.>
  void setOwner(CollectionLayoutDataOwner owner)
  String getMetadataError()     // <.>
  void setMetadataError(String metadataError)
  Link getLink()     // <.>
  void setLink(Link link)
  String toString()
}
----

<.> xref:#getId_[getId()]
+
--
Collection identifier, being the getter method without 'get' prefix, first letter lower cased.
--
<.> xref:#getDefaultView_[getDefaultView()]
+
--
Typically `table` or `hidden` , but could be any other named view that is configured and appropriate, eg `gmap3` or `fullcalendar2` .
--
<.> xref:#getOwner_[getOwner()]
+
--
Owner.
--
<.> xref:#getMetadataError_[getMetadataError()]
+
--
For diagnostics; populated by the framework if and only if a metadata error.
--
<.> xref:#getLink_[getLink()]
+
--
The link to access this resource from the REST API (Restful Objects viewer).
--

== Members

[#getId_]
=== getId()

Collection identifier, being the getter method without 'get' prefix, first letter lower cased.

[#getDefaultView_]
=== getDefaultView()

Typically `table` or `hidden` , but could be any other named view that is configured and appropriate, eg `gmap3` or `fullcalendar2` .

[#getOwner_]
=== getOwner()

Owner.

Set programmatically by framework after reading in from XML.

[#getMetadataError_]
=== getMetadataError()

For diagnostics; populated by the framework if and only if a metadata error.

[#getLink_]
=== getLink()

The link to access this resource from the REST API (Restful Objects viewer).

Populated by the framework automatically.
