ccc.api.core
Interface Groups

All Known Implementing Classes:

GroupsEJB, GroupsImpl

public interface Groups

Groups API, used to group data in CCC.

Author:

Civic Computing Ltd.

Field Summary

static java.lang.String

NAME NAME : String.

Method Summary

Group	create(Group group) Create a new group in the system.
PagedCollection<Group>	query(java.lang.String name, int pageNo, int pageSize) List available groups.
Group	retrieve(java.util.UUID id) Find the group for a given ID.
Group	update(java.util.UUID id, Group group) Update an existing group in the system.

Field Detail

NAME

static final java.lang.String NAME

NAME : String.

See Also:

Constant Field Values

Method Detail

query

PagedCollection<Group> query(java.lang.String name,
                             int pageNo,
                             int pageSize)

List available groups.

Parameters:

name - Filter based on group name. NULL disables filter.

pageNo - The page to display.

pageSize - The number of results per page.

Returns:

Returns paged list of groups.

retrieve

Group retrieve(java.util.UUID id)

Find the group for a given ID.

Parameters:

id - The group ID.

Returns:

Returns the corresponding group.

create

Group create(Group group)

Create a new group in the system.

Parameters:

group - The new group details.

Returns:

A DTO describing the new group.

update

Group update(java.util.UUID id,
             Group group)

Update an existing group in the system.

Parameters:

group - The updated group details.

id - The ID of the group to update.

Returns:

A DTO describing the updated group.