ccc.api.core
Interface Pages

All Known Implementing Classes:

PagesEJB, PagesImpl

public interface Pages

Basic API for manipulating pages.

Author:

Civic Computing Ltd.

Field Summary

static java.lang.String

NAME NAME : String.

Method Summary

ResourceSummary	create(Page page) Creates a new page.
PagedCollection<ResourceSummary>	list(PageCriteria criteria, int pageNo, int pageSize) List existing pages.
Page	retrieve(java.util.UUID pageId) Retrieve the page.
Page	retrieveWorkingCopy(java.util.UUID pageId) Retrieve the working copy for a page.
void	update(java.util.UUID pageId, Page delta) Update the specified page on the server.
void	updateWorkingCopy(java.util.UUID pageId, Page delta) Update the working copy of the specified page.
java.lang.String	validate(Page page) Validate a set of paragraphs against a given definition.

Field Detail

NAME

static final java.lang.String NAME

NAME : String.

See Also:

Constant Field Values

Method Detail

validate

java.lang.String validate(Page page)

Validate a set of paragraphs against a given definition.

Parameters:

page - The page to test.

Returns:

A list of errors, as strings.

retrieve

Page retrieve(java.util.UUID pageId)

Retrieve the page.

Parameters:

pageId - The page's id.

Returns:

The corresponding page.

retrieveWorkingCopy

Page retrieveWorkingCopy(java.util.UUID pageId)

Retrieve the working copy for a page.

Parameters:

pageId - The page's id.

Returns:

The corresponding working copy.

update

void update(java.util.UUID pageId,
            Page delta)

Update the specified page on the server.

Parameters:

pageId - The id of the page to update.

delta - The changes to apply.

updateWorkingCopy

void updateWorkingCopy(java.util.UUID pageId,
                       Page delta)

Update the working copy of the specified page.

Parameters:

pageId - The id of the page to update.

delta - The changes to apply.

create

ResourceSummary create(Page page)

Creates a new page.

Parameters:

page - Details of the new page to create.

Returns:

A resource summary describing the new page.

list

PagedCollection<ResourceSummary> list(PageCriteria criteria,
                                      int pageNo,
                                      int pageSize)

List existing pages.

Parameters:

criteria - The criteria by which to filter pages.

pageNo - The page of results to return.

pageSize - The number of results in a page.

Returns:

A list of pages.