ccc.api.core
Class Template

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

All Implemented Interfaces:

java.io.Serializable

public class Template
extends Resource

A new template.

Author:

Civic Computing Ltd.

See Also:

Serialized Form

Field Summary

static java.lang.String	EXISTS EXISTS : String.
static int	MAXIMUM_PARAGRAPHS MAXIMUM_PARAGRAPHS : int.
static java.lang.String	REVISION REVISION : 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

Template()

Method Summary

java.lang.String	getBody() Accessor.
java.lang.String	getDefinition() Accessor.
MimeType	getMimeType() Accessor.
void	setBody(java.lang.String body) Mutator.
void	setDefinition(java.lang.String definition) Mutator.
void	setMimeType(MimeType mimeType) Mutator.
static Template	summary(java.util.UUID id, ResourceName name, java.lang.String title, java.lang.String description, java.lang.String body, java.lang.String definition) Create a summary DTO.

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

MAXIMUM_PARAGRAPHS

public static final int MAXIMUM_PARAGRAPHS

MAXIMUM_PARAGRAPHS : int.

See Also:

Constant Field Values

EXISTS

public static final java.lang.String EXISTS

EXISTS : String.

See Also:

Constant Field Values

REVISION

public static final java.lang.String REVISION

REVISION : String.

See Also:

Constant Field Values

Constructor Detail

Template

public Template()

Method Detail

getBody

public java.lang.String getBody()

Accessor.

Returns:

Returns the body.

setBody

public void setBody(java.lang.String body)

Mutator.

Parameters:

body - The body to set.

getDefinition

public java.lang.String getDefinition()

Accessor.

Returns:

Returns the definition.

setDefinition

public void setDefinition(java.lang.String definition)

Mutator.

Parameters:

definition - The definition to set.

getMimeType

public MimeType getMimeType()

Accessor.

Returns:

Returns the mimeType.

setMimeType

public void setMimeType(MimeType mimeType)

Mutator.

Parameters:

mimeType - The mimeType to set.

summary

public static Template summary(java.util.UUID id,
                               ResourceName name,
                               java.lang.String title,
                               java.lang.String description,
                               java.lang.String body,
                               java.lang.String definition)

Create a summary DTO.

Parameters:

id - The template's UUID.

name - The template's name.

title - The template's title.

description - The template's description.

body - The template's body.

definition - The template's definition.

Returns:

A template DTO with the appropriate fields set.