com.axemble.vdoc.sdk.interfaces

Interface ISite

All Superinterfaces:

IDeletionSupport, IElement, IProtocolSupport, ISecuritySupport, ISeoSupport, IUriSupport, Serializable

public interface ISite
extends IElement, IUriSupport, ISecuritySupport, IProtocolSupport, IDeletionSupport, ISeoSupport

This class represents a site.

Since:

2.1

Version:

1.0, 16/06/2009

Author:

vlygeros

Method Summary

Modifier and Type	Method and Description
void	delete(IContext context, boolean deleteLinkedLibrary) Deletes a site and allows to specify if the linked ILibrary object should be deleted.
String	getBodyTagCode() Gets the body tag code.
Date	getCreatedDate() Gets the created date.
String	getCssClassRules() Gets the CSS class rules.
String	getDescription() Gets the description of the site.
Collection	getDomains() Returns all the domains associated with this site.
String	getHeadTagCode() Gets the head tag code.
String	getLabel()
Collection	getLibraries() Gets all the additional libraries.
ILibrary	getLibrary() Gets the associated ILibrary object.
String	getName()
IOrganization	getOrganization() Gets the organization object.
void	setBodyTagCode(String bodyTagCode) Sets the body tag code.
void	setCreatedDate(Date date) Sets the created date.
void	setCssClassRules(String cssClassRules) Sets the CSS class rules.
void	setDescription(String description) Sets the description of the site.
void	setDomains(Collection domains) Sets the domains associated with this site.
void	setHeadTagCode(String headTagCode) Sets the head tag code.
void	setLabel(String label) Sets the label of the site.
void	setName(String name) Sets the name of the site.

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

getId, getModule, getNativeObject, getPath, save

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

getURI

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.ISeoSupport

getSEO, setSEO

Method Detail

getName

String getName()

Returns:

The system name of the site

setName

void setName(String name)

Sets the name of the site.

Parameters:

name - the new name to set.

getLabel

String getLabel()

Returns:

The label of the site

setLabel

void setLabel(String label)

Sets the label of the site.

Parameters:

label - the new label to set.

getDescription

String getDescription()

Gets the description of the site.

Returns:

a String of the site.

setDescription

void setDescription(String description)

Sets the description of the site.

Parameters:

description - the new description to set.

getCreatedDate

Date getCreatedDate()

Gets the created date.

Returns:

a Date object.

setCreatedDate

void setCreatedDate(Date date)

Sets the created date.

Parameters:

date - The Date to set.

getLibrary

ILibrary getLibrary()

Gets the associated ILibrary object.

Returns:

A ILibrary object.

getLibraries

Collection getLibraries()

Gets all the additional libraries.

Returns:

A java.util.Collection of ILibrary objects.

getOrganization

IOrganization getOrganization()

Gets the organization object.

Returns:

A IOrganization object.

delete

void delete(IContext context,
            boolean deleteLinkedLibrary)

Deletes a site and allows to specify if the linked ILibrary object should be deleted.

Parameters:

context - The execution context.

deleteLinkedLibrary - Flag to specify if the linked library should be deleted.

getHeadTagCode

String getHeadTagCode()

Gets the head tag code.

Returns:

A java.lang.String value.

setHeadTagCode

void setHeadTagCode(String headTagCode)

Sets the head tag code.

Parameters:

headTagCode - The head tag code.

getBodyTagCode

String getBodyTagCode()

Gets the body tag code.

Returns:

A java.lang.String value.

setBodyTagCode

void setBodyTagCode(String bodyTagCode)

Sets the body tag code.

Parameters:

bodyTagCode - The body tag code.

getCssClassRules

String getCssClassRules()

Gets the CSS class rules.

Returns:

A java.lang.String value.

setCssClassRules

void setCssClassRules(String cssClassRules)

Sets the CSS class rules.

Parameters:

cssClassRules - The CSS class rules to set.

getDomains

Collection getDomains()

Returns all the domains associated with this site.

Returns:

A java.util.Collection of java.lang.String domain names.

setDomains

void setDomains(Collection domains)

Sets the domains associated with this site.

Parameters:

domains - A java.util.Collection of java.lang.String domain names