ccc.api.core
Class ResourceSummary

java.lang.Object
  ccc.api.core.Res
      ccc.api.core.ResourceSummary

All Implemented Interfaces:

java.io.Serializable

public final class ResourceSummary
extends Res

A summary of a resource. TODO: remove all mutators?

Author:

Civic Computing Ltd.

See Also:

Serialized Form

Field Summary

static java.lang.String	ABSOLUTE_PATH ABSOLUTE_PATH : String.
static java.lang.String	CHILD_COUNT CHILD_COUNT : String.
static java.lang.String	DATE_CHANGED DATE_CHANGED : String.
static java.lang.String	DATE_CREATED DATE_CREATED : String.
static java.lang.String	DESCRIPTION DESCRIPTION : String.
static java.lang.String	FOLDER_COUNT FOLDER_COUNT : String.
static java.lang.String	INDEX_PAGE_ID INDEX_PAGE_ID : String.
static java.lang.String	LOCKED LOCKED : String.
static java.lang.String	MM_INCLUDE MM_INCLUDE : String.
static java.lang.String	NAME NAME : String.
static java.lang.String	PARENT PARENT : String.
static java.lang.String	PUBLISHED PUBLISHED : String.
static java.lang.String	TITLE TITLE : String.
static java.lang.String	TYPE TYPE : String.
static java.lang.String	UUID UUID : String.
static java.lang.String	VISIBLE VISIBLE : String.
static java.lang.String	WORKING_COPY WORKING_COPY : String.

Constructor Summary

ResourceSummary()
Constructor.

ResourceSummary(java.util.UUID id, java.util.UUID parent, java.lang.String name, Username publishedBy, java.lang.String title, Username lockedBy, ResourceType type, int childCount, int folderCount, boolean includeInMainMenu, boolean hasWorkingCopy, java.util.Date dateCreated, java.util.Date dateChanged, java.util.UUID templateId, java.util.Set<java.lang.String> tags, java.lang.String absolutePath, java.util.UUID indexPageId, java.lang.String description, Username createdBy, Username changedBy)
Constructor.

Method Summary

Link	acl() Link.
void	decrementFolderCount() Decrease the folder count by 1.
Link	duration() Link.
Link	excludeMM() Link.
Link	exists() Link.
java.lang.String	getAbsolutePath() Accessor.
Username	getChangedBy() Accessor.
int	getChildCount() Accessor.
Username	getCreatedBy() Accessor.
java.util.Date	getDateChanged() Accessor.
java.util.Date	getDateCreated() Accessor.
java.lang.String	getDescription() Accessor.
int	getFolderCount() Accessor.
java.util.UUID	getId() Accessor.
java.util.UUID	getIndexPageId() Accessor.
Username	getLockedBy() Accessor.
java.lang.String	getName() Accessor.
java.util.UUID	getParent() Accessor.
Username	getPublishedBy() Accessor.
java.util.Set<java.lang.String>	getTags() Accessor.
java.util.UUID	getTemplateId() Accessor.
java.lang.String	getTitle() Accessor.
ResourceType	getType() Accessor.
Link	images() Link.
Link	includeMM() Link.
void	incrementFolderCount() Increase the folder count by 1.
boolean	isHasWorkingCopy() Accessor.
boolean	isIncludeInMainMenu() Accessor.
boolean	isVisible() Accessor.
Link	list() Link.
Link	lock() Link.
Link	move() Link.
Link	rename() Link.
Link	revisions() Link.
java.lang.String	revisionsPath() Retrieve the relative path to a resource's revision data.
Link	self() Link.
Link	selfBinary() Link.
void	setAbsolutePath(java.lang.String absolutePath) Mutator.
void	setChangedBy(Username changedBy) Mutator.
void	setChildCount(int childCount) Mutator.
void	setCreatedBy(Username createdBy) Mutator.
void	setDateChanged(java.util.Date dateChanged) Mutator.
void	setDateCreated(java.util.Date dateCreated) Mutator.
void	setDescription(java.lang.String description) Mutator.
void	setFolderCount(int count) Mutator.
void	setHasWorkingCopy(boolean hasWorkingCopy) Mutator.
void	setId(java.util.UUID id) Mutator.
void	setIncludeInMainMenu(boolean includeInMainMenu) Mutator.
void	setIndexPageId(java.util.UUID indexPageId) Mutator.
void	setLockedBy(Username lockedBy) Mutator.
void	setName(java.lang.String name) Mutator.
void	setParent(java.util.UUID parent) Mutator.
void	setPublishedBy(Username publishedBy) Mutator.
void	setTags(java.util.Set<java.lang.String> tags) Mutator.
void	setTags(java.lang.String tags) Deprecated.
void	setTemplateId(java.util.UUID templateId) Mutator.
void	setTitle(java.lang.String title) Mutator.
void	setType(ResourceType type) Mutator.
void	setVisible(boolean visible) Mutator.
Link	targetName() Link.
Link	templateRevision() Link.
Link	uriAbsPath() Link.
Link	uriMetadata() Link.
Link	uriPublish() Link.
Link	uriTemplate() Link.
Link	wc() Link.

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

UUID

public static final java.lang.String UUID

UUID : String.

See Also:

Constant Field Values

PARENT

public static final java.lang.String PARENT

PARENT : String.

See Also:

Constant Field Values

NAME

public static final java.lang.String NAME

NAME : String.

See Also:

Constant Field Values

PUBLISHED

public static final java.lang.String PUBLISHED

PUBLISHED : String.

See Also:

Constant Field Values

TITLE

public static final java.lang.String TITLE

TITLE : String.

See Also:

Constant Field Values

LOCKED

public static final java.lang.String LOCKED

LOCKED : String.

See Also:

Constant Field Values

TYPE

public static final java.lang.String TYPE

TYPE : String.

See Also:

Constant Field Values

CHILD_COUNT

public static final java.lang.String CHILD_COUNT

CHILD_COUNT : String.

See Also:

Constant Field Values

FOLDER_COUNT

public static final java.lang.String FOLDER_COUNT

FOLDER_COUNT : String.

See Also:

Constant Field Values

MM_INCLUDE

public static final java.lang.String MM_INCLUDE

MM_INCLUDE : String.

See Also:

Constant Field Values

WORKING_COPY

public static final java.lang.String WORKING_COPY

WORKING_COPY : String.

See Also:

Constant Field Values

DATE_CHANGED

public static final java.lang.String DATE_CHANGED

DATE_CHANGED : String.

See Also:

Constant Field Values

DATE_CREATED

public static final java.lang.String DATE_CREATED

DATE_CREATED : String.

See Also:

Constant Field Values

ABSOLUTE_PATH

public static final java.lang.String ABSOLUTE_PATH

ABSOLUTE_PATH : String.

See Also:

Constant Field Values

INDEX_PAGE_ID

public static final java.lang.String INDEX_PAGE_ID

INDEX_PAGE_ID : String.

See Also:

Constant Field Values

DESCRIPTION

public static final java.lang.String DESCRIPTION

DESCRIPTION : String.

See Also:

Constant Field Values

VISIBLE

public static final java.lang.String VISIBLE

VISIBLE : String.

See Also:

Constant Field Values

Constructor Detail

ResourceSummary

public ResourceSummary()

Constructor.

ResourceSummary

public ResourceSummary(java.util.UUID id,
                       java.util.UUID parent,
                       java.lang.String name,
                       Username publishedBy,
                       java.lang.String title,
                       Username lockedBy,
                       ResourceType type,
                       int childCount,
                       int folderCount,
                       boolean includeInMainMenu,
                       boolean hasWorkingCopy,
                       java.util.Date dateCreated,
                       java.util.Date dateChanged,
                       java.util.UUID templateId,
                       java.util.Set<java.lang.String> tags,
                       java.lang.String absolutePath,
                       java.util.UUID indexPageId,
                       java.lang.String description,
                       Username createdBy,
                       Username changedBy)

Constructor.

Parameters:

id - The resource's id.

parent - The resource's parent folder id.

name - The resource's name.

publishedBy - The user that published the resource.

title - The resource's title.

lockedBy - The user that locked the resource.

type - The type of the resource.

childCount - The number of children the resource has.

folderCount - The number of folders the resource contains.

includeInMainMenu - Is the resource included in the main menu.

hasWorkingCopy - Does the resource have a working copy.

dateCreated - When was the resource created.

dateChanged - When was the resource last changed.

templateId - The id of the resource's template.

tags - The resource's tags.

absolutePath - The resource's absolute path.

indexPageId - The id of the index page.

description - The description of the resource.

createdBy - The user who created the resource.

changedBy - The user who changed the resource.

Method Detail

getId

public java.util.UUID getId()

Accessor.

Returns:

Returns the id.

getParent

public java.util.UUID getParent()

Accessor.

Returns:

Returns the parent.

getName

public java.lang.String getName()

Accessor.

Returns:

Returns the name.

getPublishedBy

public Username getPublishedBy()

Accessor.

Returns:

Returns the publishedBy.

getCreatedBy

public Username getCreatedBy()

Accessor.

Returns:

Returns the createdBy.

getChangedBy

public Username getChangedBy()

Accessor.

Returns:

Returns the changedBy.

getTitle

public java.lang.String getTitle()

Accessor.

Returns:

Returns the title.

getLockedBy

public Username getLockedBy()

Accessor.

Returns:

Returns the lockedBy.

getType

public ResourceType getType()

Accessor.

Returns:

Returns the type.

getChildCount

public int getChildCount()

Accessor.

Returns:

Returns the childCount.

getFolderCount

public int getFolderCount()

Accessor.

Returns:

Returns the folderCount.

isIncludeInMainMenu

public boolean isIncludeInMainMenu()

Accessor.

Returns:

Returns the includeInMainMenu.

isHasWorkingCopy

public boolean isHasWorkingCopy()

Accessor.

Returns:

Returns the hasWorkingCopy.

getDateCreated

public java.util.Date getDateCreated()

Accessor.

Returns:

Returns the dateCreated.

getDateChanged

public java.util.Date getDateChanged()

Accessor.

Returns:

Returns the dateChanged.

revisionsPath

public java.lang.String revisionsPath()

Retrieve the relative path to a resource's revision data.

Returns:

The path as a string.

setHasWorkingCopy

public void setHasWorkingCopy(boolean hasWorkingCopy)

Mutator.

Parameters:

hasWorkingCopy - The hasWorkingCopy to set.

setTitle

public void setTitle(java.lang.String title)

Mutator.

Parameters:

title - The title to set.

setName

public void setName(java.lang.String name)

Mutator.

Parameters:

name - The name to set.

setIncludeInMainMenu

public void setIncludeInMainMenu(boolean includeInMainMenu)

Mutator.

Parameters:

includeInMainMenu - The includeInMainMenu to set.

getTemplateId

public java.util.UUID getTemplateId()

Accessor.

Returns:

Returns the dateChanged.

getTags

public java.util.Set<java.lang.String> getTags()

Accessor.

Returns:

Returns the tags.

setLockedBy

public void setLockedBy(Username lockedBy)

Mutator.

Parameters:

lockedBy - The lockedBy to set.

setPublishedBy

public void setPublishedBy(Username publishedBy)

Mutator.

Parameters:

publishedBy - The publishedBy to set.

setTemplateId

public void setTemplateId(java.util.UUID templateId)

Mutator.

Parameters:

templateId - The templateId to set.

setTags

public void setTags(java.util.Set<java.lang.String> tags)

Mutator.

Parameters:

tags - The tags to set.

setTags

@Deprecated
public void setTags(java.lang.String tags)

Deprecated.

Mutator.

Parameters:

tags - The tags to set.

getAbsolutePath

public java.lang.String getAbsolutePath()

Accessor.

Returns:

Returns the absolute path.

setAbsolutePath

public void setAbsolutePath(java.lang.String absolutePath)

Mutator.

Parameters:

absolutePath - The absolutePath to set.

getIndexPageId

public java.util.UUID getIndexPageId()

Accessor.

Returns:

Returns the indexPageId.

setIndexPageId

public void setIndexPageId(java.util.UUID indexPageId)

Mutator.

Parameters:

indexPageId - The indexPageId to set.

getDescription

public java.lang.String getDescription()

Accessor.

Returns:

Returns the description.

setDescription

public void setDescription(java.lang.String description)

Mutator.

Parameters:

description - The description to set.

setId

public void setId(java.util.UUID id)

Mutator.

Parameters:

id - The id to set.

setParent

public void setParent(java.util.UUID parent)

Mutator.

Parameters:

parent - The parent to set.

setCreatedBy

public void setCreatedBy(Username createdBy)

Mutator.

Parameters:

createdBy - The createdBy to set.

setChangedBy

public void setChangedBy(Username changedBy)

Mutator.

Parameters:

changedBy - The changedBy to set.

setType

public void setType(ResourceType type)

Mutator.

Parameters:

type - The type to set.

setChildCount

public void setChildCount(int childCount)

Mutator.

Parameters:

childCount - The childCount to set.

setDateCreated

public void setDateCreated(java.util.Date dateCreated)

Mutator.

Parameters:

dateCreated - The dateCreated to set.

setDateChanged

public void setDateChanged(java.util.Date dateChanged)

Mutator.

Parameters:

dateChanged - The dateChanged to set.

setFolderCount

public void setFolderCount(int count)

Mutator.

Parameters:

count - The folder count.

incrementFolderCount

public void incrementFolderCount()

Increase the folder count by 1.

decrementFolderCount

public void decrementFolderCount()

Decrease the folder count by 1.

rename

public Link rename()

Link.

Returns:

A link to this resource's name.

wc

public Link wc()

Link.

Returns:

A link to this resource's working copy.

list

public Link list()

Link.

Returns:

A link to the resource collection.

revisions

public Link revisions()

Link.

Returns:

A link to this resource's history.

templateRevision

public Link templateRevision()

Link.

Returns:

A link to this resource's history.

uriAbsPath

public Link uriAbsPath()

Link.

Returns:

A link to this resource's absolute path.

includeMM

public Link includeMM()

Link.

Returns:

A link to this resource's 'include in menu' resource.

lock

public Link lock()

Link.

Returns:

A link to the user who has locked this resource.

move

public Link move()

Link.

Returns:

A link to this resource's parent.

duration

public Link duration()

Link.

Returns:

A link to this resource's duration.

acl

public Link acl()

Link.

Returns:

A link to this resource's ACL.

uriPublish

public Link uriPublish()

Link.

Returns:

A link to this resource's publisher.

excludeMM

public Link excludeMM()

Link.

Returns:

A link to this resource's 'include in menu' resource.

uriMetadata

public Link uriMetadata()

Link.

Returns:

A link to this resource's metadata.

uriTemplate

public Link uriTemplate()

Link.

Returns:

A link to this resource's template.

images

public Link images()

Link.

Returns:

A link to this folder's images collection.

self

public Link self()

Link.

Returns:

A link to this resource.

selfBinary

public Link selfBinary()

Link.

Returns:

A link to this file's binary resource.

exists

public Link exists()

Link.

Returns:

A link to the folder collection's 'exists' resource.

targetName

public Link targetName()

Link.

Returns:

A link to this alias' target name.

setVisible

public void setVisible(boolean visible)

Mutator.

Parameters:

visible - Is the resource visible.

isVisible

public boolean isVisible()

Accessor.

Returns:

Returns true if the resource is visible; false otherwise.