ccc.api.core
Class Page

java.lang.Object
  ccc.api.core.Res
      ccc.api.core.Resource
          ccc.api.core.Page

All Implemented Interfaces:

java.io.Serializable

public class Page
extends Resource

A new page.

Author:

Civic Computing Ltd.

See Also:

Serialized Form

Field Summary

static java.lang.String	VALIDATOR VALIDATOR : String.
static java.lang.String	WORKING_COPY WORKING_COPY : String.

Fields inherited from class ccc.api.core.Resource

ABSOLUTE_PATH, ACL, DELETE, DURATION, EXCLUDE_MM, INCLUDE_MM, LIST, LOCK, METADATA, NAME, PARENT, PUBLISH, REVISIONS, SELF, TEMPLATE, WC

Constructor Summary

Page()
Constructor.

Page(java.util.UUID parentId, java.lang.String name, java.util.UUID templateId, java.lang.String title, java.lang.String comment, boolean majorChange)
Constructor.

Method Summary

static Page	delta(java.util.Set<Paragraph> paragraphs) Deprecated.
java.lang.String	getComment() Accessor.
Paragraph	getParagraph(java.lang.String name) Look up a paragraph on this page by name.
java.util.Set<Paragraph>	getParagraphs() Accessor.
boolean	isMajorChange() Accessor.
void	setComment(java.lang.String comment) Mutator.
void	setMajorChange(boolean majorChange) Mutator.
void	setParagraphs(java.util.Set<Paragraph> paragraphs) Mutator.
Link	workingCopy() Link.

Methods inherited from class ccc.api.core.Resource

duration, getAbsolutePath, getCacheDuration, getDateChanged, getDateCreated, getDescription, getId, getLockedBy, getMetadata, getMetadatum, getName, getParent, getPublishedBy, getRevision, getTags, getTemplate, getTitle, getType, isCacheable, isInMainMenu, isLocked, isPublished, isSecure, isVisible, isWorkingCopy, self, setAbsolutePath, setCacheDuration, setDateChanged, setDateCreated, setDescription, setId, setInMainMenu, setLocked, setLockedBy, setMetadata, setName, setParent, setPublished, setPublishedBy, setRevision, setSecure, setTags, setTags, setTemplate, setTitle, setType, setVisible, uriMetadata, uriTemplate

Methods inherited from class ccc.api.core.Res

addLink, addLinks, getLink, getLinks

Methods inherited from class java.lang.Object

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

Field Detail

WORKING_COPY

public static final java.lang.String WORKING_COPY

WORKING_COPY : String.

See Also:

Constant Field Values

VALIDATOR

public static final java.lang.String VALIDATOR

VALIDATOR : String.

See Also:

Constant Field Values

Constructor Detail

Page

public Page()

Constructor.

Page

public Page(java.util.UUID parentId,
            java.lang.String name,
            java.util.UUID templateId,
            java.lang.String title,
            java.lang.String comment,
            boolean majorChange)

Constructor.

Parameters:

parentId - The page's parent folder id.

name - The page's name.

templateId - The page's template id.

title - The page's title.

comment - The comment for a page update.

majorChange - Is the update a major change.

Method Detail

getComment

public final java.lang.String getComment()

Accessor.

Returns:

Returns the comment.

isMajorChange

public final boolean isMajorChange()

Accessor.

Returns:

Returns the majorChange.

setComment

public void setComment(java.lang.String comment)

Mutator.

Parameters:

comment - The comment to set.

setMajorChange

public void setMajorChange(boolean majorChange)

Mutator.

Parameters:

majorChange - The majorChange to set.

getParagraphs

public java.util.Set<Paragraph> getParagraphs()

Accessor.

Returns:

Returns the paragraphs.

setParagraphs

public void setParagraphs(java.util.Set<Paragraph> paragraphs)

Mutator.

Parameters:

paragraphs - The paragraphs to set.

getParagraph

public Paragraph getParagraph(java.lang.String name)

Look up a paragraph on this page by name.

Parameters:

name - The name of the paragraph to retrieve.

Returns:

The paragraph with the specified name.

delta

@Deprecated
public static Page delta(java.util.Set<Paragraph> paragraphs)

Deprecated.

Factory method - create a page for a set of paragraphs.

Parameters:

paragraphs - The paragraphs for the page.

Returns:

A new page containing the specified paragraphs.

workingCopy

public Link workingCopy()

Link.

Returns:

The link to this Page's working copy.