net.oneandone.concierge.api

Class Group

java.lang.Object

net.oneandone.concierge.api.Group

All Implemented Interfaces:

Addressable

public class Group
extends java.lang.Object
implements Addressable

An elements group.

Constructor Summary

Constructors

Constructor and Description
Group()

Method Summary

Modifier and Type	Method and Description
java.lang.String	address() Returns the resource name or type.
java.util.List<Element>	elements() Returns the list of elements that belong to this group.
static Group	empty(java.lang.String name) Returns an empty group.
java.time.ZonedDateTime	lastModified() Returns the date time with timezone of the last update.
int	total() Returns the total number of elements for this group.
static Group	withElement(Element element) Returns a result containing only one unique element, as the result of a query with an AddressFilter.
static Group	withElements(java.lang.String name, java.util.List<Element> elements, int total, java.time.ZonedDateTime zonedDateTime) Returns a multi element group.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Group

public Group()

Method Detail

elements

public java.util.List<Element> elements()

Returns the list of elements that belong to this group.

Returns:

the list of elements

total

public int total()

Returns the total number of elements for this group.

An instance of this class may contain only a subset of all available elements.

Returns:

the total number of elements for this group

address

public java.lang.String address()

Description copied from interface: Addressable

Returns the resource name or type.

Specified by:

address in interface Addressable

Returns:

the resource name or type

lastModified

public java.time.ZonedDateTime lastModified()

Description copied from interface: Addressable

Returns the date time with timezone of the last update.

Specified by:

lastModified in interface Addressable

Returns:

the date time with timezone of the last update

empty

public static Group empty(java.lang.String name)

Returns an empty group.

Parameters:

name - the group name

Returns:

an empty group

withElement

public static Group withElement(Element element)

Returns a result containing only one unique element, as the result of a query with an AddressFilter.

Parameters:

element - the unique element

Returns:

a group with a single element

withElements

public static Group withElements(java.lang.String name,
                                 java.util.List<Element> elements,
                                 int total,
                                 java.time.ZonedDateTime zonedDateTime)

Returns a multi element group.

Parameters:

name - the group name

elements - the list of elements for this group (might be a paged result)

total - the number of total results for this group

zonedDateTime - the date of the last update

Returns:

multi element group