com.axemble.vdoc.sdk.interfaces

Interface IContentContainer

All Superinterfaces:

IDeletionSupport, IElement, IProtocolSupport, ISecuritySupport, IUriSupport, Serializable

All Known Subinterfaces:

IBlockTemplateContainer, IPageContainer, ISharedBlockContainer

public interface IContentContainer
extends IElement, ISecuritySupport, IDeletionSupport, IUriSupport, IProtocolSupport

This interface represents the base content container.

Since:

2.1

Version:

1.0, 16/06/2009

Author:

vlygeros

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IContentContainer.IStatus

Method Summary

Modifier and Type	Method and Description
Date	getActivatedDate() Gets the activated date.
IContent	getContent(int status) Retrieves a IContent by the IContentContainer.IStatus.
Collection	getContents() Retrieves the available contents.
String	getDescription() Gets the description of the container.
Date	getExpiredDate() Gets the expired date.
String	getLabel()
String	getName()
ISite	getSite() Gets the site of the content.
int	getStatus() Gets the status of the content container.
void	includeToIndex(boolean include) Allows to include the content container to the index.
void	includeToStats(boolean include) Allows to include the content container to the statistics.
boolean	isActive() Checks if the content container is active.
boolean	isIncludedToIndex() Checks if the content container is included to the index.
boolean	isIncludedToStats() Checks if the content container is included to the statistics.
void	setActive(boolean active) Allows to activate the content container.
void	setDescription(String description) Sets the description of the container.
void	setLabel(String label) Sets the label of the container.

Methods inherited from interface com.axemble.vdoc.sdk.interfaces.IElement

getId, getModule, getNativeObject, getPath, save

Methods inherited from interface com.axemble.vdoc.sdk.supports.IProtocolSupport

getProtocolURI, getProtocolURI

Methods inherited from interface com.axemble.vdoc.sdk.supports.IDeletionSupport

delete

Methods inherited from interface com.axemble.vdoc.sdk.supports.IUriSupport

getURI

Method Detail

getName

String getName()

Returns:

The system name of the container.

getLabel

String getLabel()

Returns:

The label of the container.

setLabel

void setLabel(String label)

Sets the label of the container.

Parameters:

label - the new label to set.

getDescription

String getDescription()

Gets the description of the container.

Returns:

a String of the container.

setDescription

void setDescription(String description)

Sets the description of the container.

Parameters:

description - the new description to set.

getStatus

int getStatus()

Gets the status of the content container.

Returns:

An int value.

getContents

Collection getContents()

Retrieves the available contents.

Returns:

A java.util.Collection of IContent objects.

getContent

IContent getContent(int status)

Retrieves a IContent by the IContentContainer.IStatus.

Parameters:

status - The status to search with.

Returns:

A IContent object.

getSite

ISite getSite()

Gets the site of the content.

Returns:

A ISite object.

getActivatedDate

Date getActivatedDate()

Gets the activated date.

Returns:

A Date object.

getExpiredDate

Date getExpiredDate()

Gets the expired date.

Returns:

A Date object.

isActive

boolean isActive()

Checks if the content container is active.

Returns:

true if the content container is active, false otherwise.

setActive

void setActive(boolean active)

Allows to activate the content container.

Parameters:

active - The active parameter.

isIncludedToIndex

boolean isIncludedToIndex()

Checks if the content container is included to the index.

Returns:

true if the content container is included to the index, false otherwise.

includeToIndex

void includeToIndex(boolean include)

Allows to include the content container to the index.

Parameters:

include - The include parameter.

isIncludedToStats

boolean isIncludedToStats()

Checks if the content container is included to the statistics.

Returns:

true if the content container is included to the statistics, false otherwise.

includeToStats

void includeToStats(boolean include)

Allows to include the content container to the statistics.

Parameters:

include - The include parameter.