Package com.axemble.vdoc.sdk.impl

Class EzsSiteModule

java.lang.Object

com.axemble.vdoc.sdk.impl.AbstractTranslaterModule

com.axemble.vdoc.sdk.impl.PortalModule

com.axemble.vdoc.sdk.impl.EzsSiteModule

All Implemented Interfaces:

IBaseSiteModule, IModule, ISiteModule, Remote

public class EzsSiteModule
extends PortalModule
implements ISiteModule

Easysite site module

Author:

vlygeros

Field Summary

Fields

Modifier and Type	Field	Description
protected com.axemble.vdoc.sdk.impl.PortalDirectoryModule	directoryModule
protected IExecutionContext	executionContext
protected static HashMap<Class,Class>	nativeClasses
static final String	POSITION_ASCENDING

Fields inherited from class com.axemble.vdoc.sdk.impl.PortalModule

currentContext, report

Constructor Summary

Constructors

Constructor	Description
EzsSiteModule()

Method Summary

Modifier and Type	Method	Description
void	approve(IContext context, IContentContainer contentContainer)	Approves a content.
void	approve(IContext context, ISite site)	Approves all contents in a site.
void	approve(IContext context, ITopic topic)	Approves all contents in a topic.
IReport	beginTransaction()	Starts a new transaction or use the current one.
IReport	beginTransaction(Object currentObject)	Starts a new transaction if required.
void	commitTransaction()	Commits the current transaction.
void	commitTransaction(Object currentObject)	Commits the current transaction.
void	copyPageContainerInTopic(IContext context, IPageContainer pageContainer, ITopic topic)	Copy a page in a topic
IAlias	createAlias(IContext context, ISite site, String name, String label, IProtocolSupport protocolSupport)	Creates an IAlias object at the root level of a site.
IAlias	createAlias(IContext context, ITopic topic, String name, String label, IProtocolSupport protocolSupport)	Creates an IAlias object into a ITopic object.
IBlock	createBlock(IContext context)
IComponent	createComponent(IContext context, String name)
IContent	createContent(IContext context, IContentContainer contentContainer)
IContent	createContent(IContext context, IContentContainer contentContainer, IBlockTemplateContainer templateContainer)
IPageContainer	createPageContainer(IContext context, ISite site, IBlockTemplateContainer templateContainer, String name, String label)	Creates a IPageContainer object at the root level of a ISite object.
IPageContainer	createPageContainer(IContext context, ISite site, String name, String label)	Creates a IPageContainer object at the root level of a ISite object.
IPageContainer	createPageContainer(IContext context, ITopic topic, IBlockTemplateContainer templateContainer, String name, String label)	Creates a IPageContainer object into a ITopic object.
IPageContainer	createPageContainer(IContext context, ITopic topic, String name, String label)	Creates a IPageContainer object into a ITopic object.
void	createPlugin(IContext context, String parentUri, PluginConfigurationBean pluginConfigurationBean)	Create a plugin in a topic
IProtocolSupport	createProtocolSupport(String freeURL)	Creates a generic IProtocolSupport object from an URL.
ISite	createSite(IContext context, ILibrary library, String name)	Creates a new site and associates it to a ILibrary (same organization).
ISite	createSite(IContext context, IOrganization organization, String name)	Creates a new site into an IOrganization object.
ITopic	createTopic(IContext context, ISite site, String name, String label)	Creates a ITopic object a the root level.
ITopic	createTopic(IContext context, ITopic parent, String name, String label)	Creates a sub ITopic object.
void	delete(IContext context, IElement element)	Deletes an element.
protected void	deleteSite(IContext context, ISite site)
void	deleteSite(IContext context, ISite site, boolean deleteLinkedLibrary)	Delete site
Class	findNativeClass(Class interfaceClass)	Allows to retrieve the inner native class.
String	findObjectUri(String pluginName, Object o)	Find object URI
String	generateSystemName(String label)	Generate a valid system name for this module and this label.
IAlias	getAlias(IContext context, ISite site, String name)	Gets an IAlias object by its name.
IAlias	getAlias(IContext context, ITopic parent, String name)	Gets an IAlias object by its name.
IAlias	getAlias(Object aliasObject)	Access method to get a IAlias object from one of the followings: AliasImpl, java.io.Serializable.
Collection<IAlias>	getAliases(IContext context, ISite site)	Gets all the aliases from the root level of the ISite object.
Collection<IAlias>	getAliases(IContext context, ISite site, boolean recursive)
Collection<IAlias>	getAliases(IContext context, ITopic parent)	Gets all the aliases of a ITopic object.
Collection<IAlias>	getAliases(IContext context, ITopic parent, boolean recursive)
IBlock	getBlock(Object blockObject)	Access method to get a IBlock object from one of the followings: BlockImpl, java.io.Serializable.
IBlockTemplateContainer	getBlockTemplateContainer(Object blockTemplateContainerObject)	Access method to get a IBlockTemplateContainer object from one of the followings: TemplateImpl, java.io.Serializable.
IBlockTemplateContainer	getBlockTemplateContainerByURI(IContext context, String uri)
Collection<IBlockTemplateContainer>	getBlockTemplateContainers(IContext context, ISite site)
Collection<IBlockTemplateContainer>	getBlockTemplateContainers(IContext context, ISite site, int type)	Gets all the templates.
ICatalog	getCatalog(IContext context, ISite site)	Retrieves the catalog of the site.
IComponent	getComponent(Object componentObject)	Access method to get a IComponent object from one of the followings: ElementImpl.
IContent	getContent(Object contentObject)	Access method to get a IContent object from one of the followings: ContentVersionImpl, java.io.Serializable.
IContent	getContentByStatus(IContentContainer contentContainer, int status)	Gets a content of a container by its status.
IContentComponent	getContentComponent(Object contentComponentObject)	Access method to get a IContentComponent object from one of the followings: ContentNodeImpl.
IContentContainer	getContentContainer(IContext context, ISite site, String name)
IContentContainer	getContentContainer(IContext context, ITopic parent, String name)
IContentContainer	getContentContainer(Object contentContainerObject)	Access method to get a IContentContainer object from one of the followings: PageImpl, CommonBlockImpl, TemplateImpl, java.io.Serializable.
Collection<IContentContainer>	getContentContainers(IContext context, ISite site)
Collection<IContentContainer>	getContentContainers(IContext context, ISite site, boolean recursive)
Collection<IContentContainer>	getContentContainers(IContext context, ITopic parent)
Collection<IContentContainer>	getContentContainers(IContext context, ITopic parent, boolean recursive)
Collection<IContent>	getContents(IContentContainer contentContainer)
IProtocolSupport	getElementByProtocolURI(String protocolURI)	Gets an IElement object which implements IProtocolSupport interface.
IElement	getElementByURI(IContext context, String uri)	Gets an IElement by its URI.
InternalSiteExecutionContext	getExecutionContext()	Gets the specific execution context of the current module.
com.axemble.vdoc.sdk.interfaces.ui.components.IComponentsFactory	getFormsComponentsFactory()
com.axemble.vdoc.sdk.interfaces.ui.definitions.IDefinitionsFactory	getFormsDefinitionsFactory()
IMessageController	getMessageController()
protected static Class	getNativeClass(Class interfaceClass)
IPageContainer	getPageContainer(IContext context, ISite site, String name)	Gets a root IPageContainer object by its name.
IPageContainer	getPageContainer(IContext context, ITopic topic, String name)	Gets a IPageContainer object from a ITopic object by its name.
IPageContainer	getPageContainer(Object pageContainerObject)	Access method to get a IPageContainer object from one of the followings: PageImpl, java.io.Serializable.
Collection<IPageContainer>	getPageContainers(IContext context, ISite site)	Gets all the pages from a site at a root level.
Collection<IPageContainer>	getPageContainers(IContext context, ISite site, boolean recursive)
Collection<IPageContainer>	getPageContainers(IContext context, ITopic parent)	Gets all the pages from the ITopic object.
Collection<IPageContainer>	getPageContainers(IContext context, ITopic parent, boolean recursive)
javax.jdo.PersistenceManager	getPersistenceManager()
IPlugin	getPlugin(Object pluginObject)	Access method to get a IPlugin object from one of the followings: ModuleImpl, java.io.Serializable.
Collection<IPlugin>	getPlugins(IContext context, ISite site)	Gets all the plugins from a site at root level.
Collection<IPlugin>	getPlugins(IContext context, ISite site, boolean recursive)
IResourceDefinition	getResourceDefinition(IContext context, IPageContainer pageContainer, String dataFormName)
ISecurityController	getSecurityController(ISecuritySupport securitySupport)	Gets a security controller on a specified object.
ISharedBlockContainer	getSharedBlockContainer(Object sharedBlockContainerObject)	Access method to get a ISharedBlockContainer object from one of the followings: CommonBlockImpl, java.io.Serializable.
ISite	getSite(Object siteObject)	ACCESSORS
ISite	getSiteByName(IContext context, String name)	Retrieves a site by its name.
IBlockTemplateContainer	getSystemBlockTemplateContainer(IContext context, String name)
IElement	getTarget(IAlias alias)	Get target
ITopic	getTopic(IContext context, ISite site, String name)	Gets a root ITopic object by its name.
ITopic	getTopic(IContext context, ITopic parent, String name)	Gets a ITopic object by its name.
ITopic	getTopic(Object topicObject)	Access method to get a ITopic object from one of the followings: FolderImpl, java.io.Serializable.
Collection<ITopic>	getTopics(IContext context, ISite site)	Gets all the topics from a site at a root level.
Collection<ITopic>	getTopics(IContext context, ISite site, boolean recursive)
Collection<ITopic>	getTopics(IContext context, ITopic parent)	Gets all the sub-topics from a parent ITopic object.
Collection<ITopic>	getTopics(IContext context, ITopic parent, boolean recursive)
IView	getView(IContext context, IResourceDefinition resourceDefinition, String viewName)
void	initialize(Properties properties)	Initializes the module.
boolean	isTransactionActive()	Checks if there is a current transaction.
void	reject(IContext context, IContentContainer contentContainer, String comment)	Rejects an approval request.
void	requestApproval(IContext context, IContentContainer contentContainer, String comment)	Requests an approval of the content.
void	rollbackTransaction()	Roll back the current transaction.
void	rollbackTransaction(Object currentObject)	Roll back the current transaction.
void	save(IContext context, IElement element)	SAVE METHODS
void	setExecutionContext(IExecutionContext executionContext)
void	setTransactionTimeout(int transactionTimeout)	Allows the set the transaction timeout.
void	unInitialize()	Releases the module.

Methods inherited from class com.axemble.vdoc.sdk.impl.PortalModule

convertId, getAnonymous, getAnonymousContext, getContext, getContext, getContext, getContextByLogin, getCurrentContext, getElementFromExternalElement, getExternalElement, getExternalElement, getLanguage, getLoggedOnUser, getLoggedOnUserContext, getLoggedOnUserLanguage, getProtocolPath, getProtocolPath, getProtocolURI, getProtocolURI, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getSysadmin, getSysadminContext, getUser, getUser, getUserByLogin, refreshUser

Methods inherited from class com.axemble.vdoc.sdk.impl.AbstractTranslaterModule

getTranslation, getTranslationForLanguage, getTranslationKey

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.axemble.vdoc.sdk.modules.IModule

convertId, getAnonymous, getAnonymousContext, getContext, getContext, getContextByLogin, getElementFromExternalElement, getExternalElement, getExternalElement, getLoggedOnUser, getLoggedOnUserContext, getLoggedOnUserLanguage, getProtocolPath, getProtocolPath, getProtocolURI, getProtocolURI, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getSysadmin, getSysadminContext, getTranslation, getTranslationForLanguage, getTranslationKey

Field Details

POSITION_ASCENDING

public static final String POSITION_ASCENDING

See Also:

• Constant Field Values

nativeClasses

protected static HashMap<Class,Class> nativeClasses

directoryModule

protected com.axemble.vdoc.sdk.impl.PortalDirectoryModule directoryModule

executionContext

protected IExecutionContext executionContext

Constructor Details

EzsSiteModule

public EzsSiteModule()

Method Details

initialize

public void initialize(Properties properties)

Description copied from interface: IModule

Initializes the module.

Specified by:

initialize in interface IModule

Parameters:

properties - The custom properties.

unInitialize

public void unInitialize()

Description copied from interface: IModule

Releases the module.

Specified by:

unInitialize in interface IModule

getPersistenceManager

public javax.jdo.PersistenceManager getPersistenceManager()

Specified by:

getPersistenceManager in class PortalModule

beginTransaction

public IReport beginTransaction()

Description copied from interface: IModule

Starts a new transaction or use the current one.

Specified by:

beginTransaction in interface IModule

Returns:

The report object.

commitTransaction

public void commitTransaction()

Description copied from interface: IModule

Commits the current transaction.

Specified by:

commitTransaction in interface IModule

rollbackTransaction

public void rollbackTransaction()

Description copied from interface: IModule

Roll back the current transaction.

Specified by:

rollbackTransaction in interface IModule

beginTransaction

public IReport beginTransaction(Object currentObject)

Description copied from interface: IModule

Starts a new transaction if required.

Specified by:

beginTransaction in interface IModule

Parameters:

currentObject - The synchronized object. Not used anymore.

Returns:

The report object.

commitTransaction

public void commitTransaction(Object currentObject)

Description copied from interface: IModule

Commits the current transaction.

Specified by:

commitTransaction in interface IModule

Parameters:

currentObject - The synchronized object. Not used anymore.

rollbackTransaction

public void rollbackTransaction(Object currentObject)

Description copied from interface: IModule

Roll back the current transaction.

Specified by:

rollbackTransaction in interface IModule

Parameters:

currentObject - The synchronized object. Not used anymore.

setTransactionTimeout

public void setTransactionTimeout(int transactionTimeout)
                           throws ModuleException

Description copied from interface: IModule

Allows the set the transaction timeout.

Specified by:

setTransactionTimeout in interface IModule

Parameters:

transactionTimeout - The transaction timeout in milliseconds.

Throws:

ModuleException - The default exception.

isTransactionActive

public boolean isTransactionActive()

Description copied from interface: IModule

Checks if there is a current transaction.

Specified by:

isTransactionActive in interface IModule

Returns:

true if a transaction has been started, false otherwise.

findNativeClass

public Class findNativeClass(Class interfaceClass)

Description copied from interface: IModule

Allows to retrieve the inner native class.

Specified by:

findNativeClass in interface IModule

Parameters:

interfaceClass - A class type.

Returns:

The inner native class.

getNativeClass

protected static Class getNativeClass(Class interfaceClass)

getSiteByName

public ISite getSiteByName(IContext context,
 String name)
                    throws SiteModuleException

Description copied from interface: ISiteModule

Retrieves a site by its name.

Specified by:

getSiteByName in interface IBaseSiteModule

Specified by:

getSiteByName in interface ISiteModule

Parameters:

context - The execution context.

name - The name of the site.

Returns:

A ISite object.

Throws:

SiteModuleException - The default module exception.

getCatalog

public ICatalog getCatalog(IContext context,
 ISite site)
                    throws SiteModuleException

Description copied from interface: ISiteModule

Retrieves the catalog of the site.

Specified by:

getCatalog in interface IBaseSiteModule

Specified by:

getCatalog in interface ISiteModule

Parameters:

context - The execution context.

site - The ISite object.

Returns:

A ICatalog object.

Throws:

SiteModuleException - The default module exception.

getResourceDefinition

public IResourceDefinition getResourceDefinition(IContext context,
 IPageContainer pageContainer,
 String dataFormName)
                                          throws SiteModuleException

Specified by:

getResourceDefinition in interface IBaseSiteModule

Specified by:

getResourceDefinition in interface ISiteModule

Throws:

SiteModuleException

getView

public IView getView(IContext context,
 IResourceDefinition resourceDefinition,
 String viewName)
              throws SiteModuleException

Specified by:

getView in interface IBaseSiteModule

Specified by:

getView in interface ISiteModule

Throws:

SiteModuleException

copyPageContainerInTopic

public void copyPageContainerInTopic(IContext context,
 IPageContainer pageContainer,
 ITopic topic)
                              throws SiteModuleException

Description copied from interface: ISiteModule

Copy a page in a topic

Specified by:

copyPageContainerInTopic in interface IBaseSiteModule

Specified by:

copyPageContainerInTopic in interface ISiteModule

Parameters:

context - The execution context.

pageContainer - The page to copy

topic - The topic destination

Throws:

SiteModuleException - The default module exception.

createSite

public ISite createSite(IContext context,
 IOrganization organization,
 String name)
                 throws SiteModuleException

Description copied from interface: ISiteModule

Creates a new site into an IOrganization object.

Specified by:

createSite in interface IBaseSiteModule

Specified by:

createSite in interface ISiteModule

Parameters:

context - The execution context.

organization - The IOrganization object.

name - The name of the site.

Returns:

A ISite object.

Throws:

SiteModuleException - The default module exception.

createSite

public ISite createSite(IContext context,
 ILibrary library,
 String name)
                 throws SiteModuleException

Description copied from interface: ISiteModule

Creates a new site and associates it to a ILibrary (same organization).

Specified by:

createSite in interface IBaseSiteModule

Specified by:

createSite in interface ISiteModule

Parameters:

context - The execution context.

library - The ILibrary object.

name - The name of the site.

Returns:

A ISite object.

Throws:

SiteModuleException - The default module exception.

createTopic

public ITopic createTopic(IContext context,
 ISite site,
 String name,
 String label)
                   throws SiteModuleException

Description copied from interface: ISiteModule

Creates a ITopic object a the root level.

Specified by:

createTopic in interface IBaseSiteModule

Specified by:

createTopic in interface ISiteModule

Parameters:

context - The execution context.

site - The ISite object.

name - The name of the topic.

label - The label of the topic.

Returns:

A ITopic object.

Throws:

SiteModuleException - The default module exception.

createTopic

public ITopic createTopic(IContext context,
 ITopic parent,
 String name,
 String label)
                   throws SiteModuleException

Description copied from interface: ISiteModule

Creates a sub ITopic object.

Specified by:

createTopic in interface IBaseSiteModule

Specified by:

createTopic in interface ISiteModule

Parameters:

context - The execution context.

parent - The parent ITopic object.

name - The name of the topic.

label - The label of the topic.

Returns:

A ITopic object.

Throws:

SiteModuleException - The default module exception.

createPlugin

public void createPlugin(IContext context,
 String parentUri,
 PluginConfigurationBean pluginConfigurationBean)
                  throws SiteModuleException

Description copied from interface: ISiteModule

Create a plugin in a topic

Specified by:

createPlugin in interface IBaseSiteModule

Specified by:

createPlugin in interface ISiteModule

Parameters:

context - The execution context

parentUri - The URI of the parent where the plugin will be created.

pluginConfigurationBean - The plugin configuration bean.

Throws:

SiteModuleException - The default module exception.

getTopic

public ITopic getTopic(IContext context,
 ISite site,
 String name)
                throws SiteModuleException

Description copied from interface: ISiteModule

Gets a root ITopic object by its name.

Specified by:

getTopic in interface IBaseSiteModule

Specified by:

getTopic in interface ISiteModule

Parameters:

context - The execution context.

site - The ISite object.

name - The system name of the topic.

Returns:

A ITopic object.

Throws:

SiteModuleException - The default module exception.

getTopic

public ITopic getTopic(IContext context,
 ITopic parent,
 String name)
                throws SiteModuleException

Description copied from interface: ISiteModule

Gets a ITopic object by its name.

Specified by:

getTopic in interface IBaseSiteModule

Specified by:

getTopic in interface ISiteModule

Parameters:

context - The execution context.

parent - The ITopic object.

name - The system name of the topic.

Returns:

A ITopic object.

Throws:

SiteModuleException - The default module exception.

getTopics

public Collection<ITopic> getTopics(IContext context,
 ISite site)
                             throws SiteModuleException

Description copied from interface: ISiteModule

Gets all the topics from a site at a root level.

Specified by:

getTopics in interface IBaseSiteModule

Specified by:

getTopics in interface ISiteModule

Parameters:

context - The execution context.

site - The ISite object.

Returns:

A java.util.Collection of ITopic objects.

Throws:

SiteModuleException - The default module exception.

getTopics

public Collection<ITopic> getTopics(IContext context,
 ISite site,
 boolean recursive)
                             throws SiteModuleException

Specified by:

getTopics in interface IBaseSiteModule

Specified by:

getTopics in interface ISiteModule

Throws:

SiteModuleException

getTopics

public Collection<ITopic> getTopics(IContext context,
 ITopic parent)
                             throws SiteModuleException

Description copied from interface: ISiteModule

Gets all the sub-topics from a parent ITopic object.

Specified by:

getTopics in interface IBaseSiteModule

Specified by:

getTopics in interface ISiteModule

Parameters:

context - The execution context.

parent - The ITopic object.

Returns:

A java.util.Collection of ITopic objects.

Throws:

SiteModuleException - The default module exception.

getTopics

public Collection<ITopic> getTopics(IContext context,
 ITopic parent,
 boolean recursive)
                             throws SiteModuleException

Specified by:

getTopics in interface IBaseSiteModule

Specified by:

getTopics in interface ISiteModule

Throws:

SiteModuleException

getPlugins

public Collection<IPlugin> getPlugins(IContext context,
 ISite site)
                               throws SiteModuleException

Description copied from interface: ISiteModule

Gets all the plugins from a site at root level.

Specified by:

getPlugins in interface IBaseSiteModule

Specified by:

getPlugins in interface ISiteModule

Parameters:

context - The execution context.

site - The ISite object.

Returns:

A java.util.Collection of IPlugin objects.

Throws:

SiteModuleException - The default module exception.

getPlugins

public Collection<IPlugin> getPlugins(IContext context,
 ISite site,
 boolean recursive)
                               throws SiteModuleException

Specified by:

getPlugins in interface IBaseSiteModule

Specified by:

getPlugins in interface ISiteModule

Throws:

SiteModuleException

getBlockTemplateContainerByURI

public IBlockTemplateContainer getBlockTemplateContainerByURI(IContext context,
 String uri)
                                                       throws SiteModuleException

Specified by:

getBlockTemplateContainerByURI in interface IBaseSiteModule

Specified by:

getBlockTemplateContainerByURI in interface ISiteModule

Throws:

SiteModuleException

getSystemBlockTemplateContainer

public IBlockTemplateContainer getSystemBlockTemplateContainer(IContext context,
 String name)
                                                        throws SiteModuleException

Specified by:

getSystemBlockTemplateContainer in interface IBaseSiteModule

Specified by:

getSystemBlockTemplateContainer in interface ISiteModule

Throws:

SiteModuleException

getBlockTemplateContainers

public Collection<IBlockTemplateContainer> getBlockTemplateContainers(IContext context,
 ISite site,
 int type)
                                                               throws SiteModuleException

Description copied from interface: ISiteModule

Gets all the templates.

Specified by:

getBlockTemplateContainers in interface IBaseSiteModule

Specified by:

getBlockTemplateContainers in interface ISiteModule

Parameters:

context - The execution context.

type - The type of the block template container, one of the IBlockTemplateContainer.IType structure.

Returns:

A java.util.Collection of IBlockTemplateContainer objects.

Throws:

SiteModuleException - The default module exception.

getBlockTemplateContainers

public Collection<IBlockTemplateContainer> getBlockTemplateContainers(IContext context,
 ISite site)
                                                               throws SiteModuleException

Specified by:

getBlockTemplateContainers in interface IBaseSiteModule

Specified by:

getBlockTemplateContainers in interface ISiteModule

Throws:

SiteModuleException

createPageContainer

public IPageContainer createPageContainer(IContext context,
 ISite site,
 String name,
 String label)
                                   throws SiteModuleException

Description copied from interface: ISiteModule

Creates a IPageContainer object at the root level of a ISite object.

Specified by:

createPageContainer in interface IBaseSiteModule

Specified by:

createPageContainer in interface ISiteModule

Parameters:

context - The execution context.

site - The ISite object.

name - The name of the page.

label - The label of the page.

Returns:

A IPageContainer object.

Throws:

SiteModuleException - The default module exception.

createPageContainer

public IPageContainer createPageContainer(IContext context,
 ISite site,
 IBlockTemplateContainer templateContainer,
 String name,
 String label)
                                   throws SiteModuleException

Description copied from interface: ISiteModule

Creates a IPageContainer object at the root level of a ISite object. This method allows to base the draft IContent of the IPageContainer to a block template container.

Specified by:

createPageContainer in interface IBaseSiteModule

Specified by:

createPageContainer in interface ISiteModule

Parameters:

context - The execution context.

site - The ISite object.

templateContainer - The block template container.

name - The name of the page.

label - The label of the page.

Returns:

A IPageContainer object.

Throws:

SiteModuleException - The default module exception.

createPageContainer

public IPageContainer createPageContainer(IContext context,
 ITopic topic,
 String name,
 String label)
                                   throws SiteModuleException

Description copied from interface: ISiteModule

Creates a IPageContainer object into a ITopic object.

Specified by:

createPageContainer in interface IBaseSiteModule

Specified by:

createPageContainer in interface ISiteModule

Parameters:

context - The execution context.

topic - The ITopic object.

name - The name of the page.

label - The label of the page.

Returns:

A IPageContainer object.

Throws:

SiteModuleException - The default module exception.

createPageContainer

public IPageContainer createPageContainer(IContext context,
 ITopic topic,
 IBlockTemplateContainer templateContainer,
 String name,
 String label)
                                   throws SiteModuleException

Description copied from interface: ISiteModule

Creates a IPageContainer object into a ITopic object.

Specified by:

createPageContainer in interface IBaseSiteModule

Specified by:

createPageContainer in interface ISiteModule

Parameters:

context - The execution context.

topic - The ITopic object.

templateContainer - The block template container.

name - The name of the page.

label - The label of the page.

Returns:

A IPageContainer object.

Throws:

SiteModuleException - SiteModuleException The default module exception.

getPageContainer

public IPageContainer getPageContainer(IContext context,
 ISite site,
 String name)
                                throws SiteModuleException

Description copied from interface: ISiteModule

Gets a root IPageContainer object by its name.

Specified by:

getPageContainer in interface IBaseSiteModule

Specified by:

getPageContainer in interface ISiteModule

Parameters:

context - The execution context.

site - The ISite object.

name - The system name of the topic.

Returns:

A IPageContainer object.

Throws:

SiteModuleException - The default module exception.

getPageContainer

public IPageContainer getPageContainer(IContext context,
 ITopic topic,
 String name)
                                throws SiteModuleException

Description copied from interface: ISiteModule

Gets a IPageContainer object from a ITopic object by its name.

Specified by:

getPageContainer in interface IBaseSiteModule

Specified by:

getPageContainer in interface ISiteModule

Parameters:

context - The execution context.

topic - The ITopic object.

name - The system name of the topic.

Returns:

A IPageContainer object.

Throws:

SiteModuleException - The default module exception.

getPageContainers

public Collection<IPageContainer> getPageContainers(IContext context,
 ISite site)
                                             throws SiteModuleException

Description copied from interface: ISiteModule

Gets all the pages from a site at a root level.

Specified by:

getPageContainers in interface IBaseSiteModule

Specified by:

getPageContainers in interface ISiteModule

Parameters:

context - The execution context.

site - The ISite object.

Returns:

A java.util.Collection of ITopic objects.

Throws:

SiteModuleException - The default module exception.

getPageContainers

public Collection<IPageContainer> getPageContainers(IContext context,
 ITopic parent)
                                             throws SiteModuleException

Description copied from interface: ISiteModule

Gets all the pages from the ITopic object.

Specified by:

getPageContainers in interface IBaseSiteModule

Specified by:

getPageContainers in interface ISiteModule

Parameters:

context - The execution context.

parent - The ITopic object.

Returns:

A java.util.Collection of ITopic objects.

Throws:

SiteModuleException - The default module exception.

getPageContainers

public Collection<IPageContainer> getPageContainers(IContext context,
 ISite site,
 boolean recursive)
                                             throws SiteModuleException

Specified by:

getPageContainers in interface IBaseSiteModule

Specified by:

getPageContainers in interface ISiteModule

Throws:

SiteModuleException

getPageContainers

public Collection<IPageContainer> getPageContainers(IContext context,
 ITopic parent,
 boolean recursive)
                                             throws SiteModuleException

Specified by:

getPageContainers in interface IBaseSiteModule

Specified by:

getPageContainers in interface ISiteModule

Throws:

SiteModuleException

createAlias

public IAlias createAlias(IContext context,
 ISite site,
 String name,
 String label,
 IProtocolSupport protocolSupport)
                   throws SiteModuleException

Description copied from interface: ISiteModule

Creates an IAlias object at the root level of a site.

Specified by:

createAlias in interface IBaseSiteModule

Specified by:

createAlias in interface ISiteModule

Parameters:

context - The execution context.

site - The ISite object.

name - The name of the alias.

label - The label of the alias.

protocolSupport - The IProtocolSupport object to point to.

Returns:

A IAlias object.

Throws:

SiteModuleException - The default module exception.

createAlias

public IAlias createAlias(IContext context,
 ITopic topic,
 String name,
 String label,
 IProtocolSupport protocolSupport)
                   throws SiteModuleException

Description copied from interface: ISiteModule

Creates an IAlias object into a ITopic object.

Specified by:

createAlias in interface IBaseSiteModule

Specified by:

createAlias in interface ISiteModule

Parameters:

context - The execution context.

topic - The ITopic object.

name - The name of the alias.

label - The label of the alias.

protocolSupport - The IProtocolSupport object to point to.

Returns:

A IAlias object.

Throws:

SiteModuleException - The default module exception.

getAlias

public IAlias getAlias(IContext context,
 ISite site,
 String name)
                throws SiteModuleException

Description copied from interface: ISiteModule

Gets an IAlias object by its name.

Specified by:

getAlias in interface IBaseSiteModule

Specified by:

getAlias in interface ISiteModule

Parameters:

context - The execution context.

site - The ISite object.

name - The name of the alias.

Returns:

A IAlias object.

Throws:

SiteModuleException - The default module exception.

getAlias

public IAlias getAlias(IContext context,
 ITopic parent,
 String name)
                throws SiteModuleException

Description copied from interface: ISiteModule

Gets an IAlias object by its name.

Specified by:

getAlias in interface IBaseSiteModule

Specified by:

getAlias in interface ISiteModule

Parameters:

context - The execution context.

parent - The ITopic object.

name - The name of the alias.

Returns:

A IAlias object.

Throws:

SiteModuleException - The default module exception.

getAliases

public Collection<IAlias> getAliases(IContext context,
 ISite site)
                              throws SiteModuleException

Description copied from interface: ISiteModule

Gets all the aliases from the root level of the ISite object.

Specified by:

getAliases in interface IBaseSiteModule

Specified by:

getAliases in interface ISiteModule

Parameters:

context - The execution context.

site - The ISite object.

Returns:

A java.util.Collection of IAlias object.

Throws:

SiteModuleException - The default module exception.

getAliases

public Collection<IAlias> getAliases(IContext context,
 ISite site,
 boolean recursive)
                              throws SiteModuleException

Specified by:

getAliases in interface IBaseSiteModule

Specified by:

getAliases in interface ISiteModule

Throws:

SiteModuleException

getAliases

public Collection<IAlias> getAliases(IContext context,
 ITopic parent)
                              throws SiteModuleException

Description copied from interface: ISiteModule

Gets all the aliases of a ITopic object.

Specified by:

getAliases in interface IBaseSiteModule

Specified by:

getAliases in interface ISiteModule

Parameters:

context - The execution context.

parent - The ITopic object.

Returns:

A java.util.Collection of IAlias object.

Throws:

SiteModuleException - The default module exception.

getAliases

public Collection<IAlias> getAliases(IContext context,
 ITopic parent,
 boolean recursive)
                              throws SiteModuleException

Specified by:

getAliases in interface IBaseSiteModule

Specified by:

getAliases in interface ISiteModule

Throws:

SiteModuleException

getContentContainer

public IContentContainer getContentContainer(IContext context,
 ISite site,
 String name)
                                      throws SiteModuleException

Specified by:

getContentContainer in interface IBaseSiteModule

Specified by:

getContentContainer in interface ISiteModule

Throws:

SiteModuleException

getContentContainer

public IContentContainer getContentContainer(IContext context,
 ITopic parent,
 String name)
                                      throws SiteModuleException

Specified by:

getContentContainer in interface IBaseSiteModule

Specified by:

getContentContainer in interface ISiteModule

Throws:

SiteModuleException

getContentContainers

public Collection<IContentContainer> getContentContainers(IContext context,
 ISite site)
                                                   throws SiteModuleException

Specified by:

getContentContainers in interface IBaseSiteModule

Specified by:

getContentContainers in interface ISiteModule

Throws:

SiteModuleException

getContentContainers

public Collection<IContentContainer> getContentContainers(IContext context,
 ISite site,
 boolean recursive)
                                                   throws SiteModuleException

Specified by:

getContentContainers in interface IBaseSiteModule

Specified by:

getContentContainers in interface ISiteModule

Throws:

SiteModuleException

getContentContainers

public Collection<IContentContainer> getContentContainers(IContext context,
 ITopic parent)
                                                   throws SiteModuleException

Specified by:

getContentContainers in interface IBaseSiteModule

Specified by:

getContentContainers in interface ISiteModule

Throws:

SiteModuleException

getContentContainers

public Collection<IContentContainer> getContentContainers(IContext context,
 ITopic parent,
 boolean recursive)
                                                   throws SiteModuleException

Specified by:

getContentContainers in interface IBaseSiteModule

Specified by:

getContentContainers in interface ISiteModule

Throws:

SiteModuleException

createProtocolSupport

public IProtocolSupport createProtocolSupport(String freeURL)
                                       throws SiteModuleException

Description copied from interface: ISiteModule

Creates a generic IProtocolSupport object from an URL.

Specified by:

createProtocolSupport in interface IBaseSiteModule

Specified by:

createProtocolSupport in interface ISiteModule

Parameters:

freeURL - The free URL.

Returns:

A IProtocolSupport object.

Throws:

SiteModuleException - The default module exception.

createContent

public IContent createContent(IContext context,
 IContentContainer contentContainer)
                       throws SiteModuleException

Specified by:

createContent in interface IBaseSiteModule

Specified by:

createContent in interface ISiteModule

Throws:

SiteModuleException

createContent

public IContent createContent(IContext context,
 IContentContainer contentContainer,
 IBlockTemplateContainer templateContainer)
                       throws SiteModuleException

Specified by:

createContent in interface IBaseSiteModule

Specified by:

createContent in interface ISiteModule

Throws:

SiteModuleException

getContentByStatus

public IContent getContentByStatus(IContentContainer contentContainer,
 int status)
                            throws SiteModuleException

Description copied from interface: ISiteModule

Gets a content of a container by its status.

Specified by:

getContentByStatus in interface IBaseSiteModule

Specified by:

getContentByStatus in interface ISiteModule

Parameters:

contentContainer - The content container object.

status - The value of the status which could be one of the IContent.IStatus structure.

Returns:

A IContent object.

Throws:

SiteModuleException

getContents

public Collection<IContent> getContents(IContentContainer contentContainer)
                                 throws SiteModuleException

Specified by:

getContents in interface IBaseSiteModule

Specified by:

getContents in interface ISiteModule

Throws:

SiteModuleException

requestApproval

public void requestApproval(IContext context,
 IContentContainer contentContainer,
 String comment)
                     throws SiteModuleException

Description copied from interface: ISiteModule

Requests an approval of the content.

Specified by:

requestApproval in interface IBaseSiteModule

Specified by:

requestApproval in interface ISiteModule

Parameters:

context - The execution context.

contentContainer - The IContentContainer object to approve.

comment - The comment why rejecting the approval.

Throws:

SiteModuleException - The default module exception.

approve

public void approve(IContext context,
 IContentContainer contentContainer)
             throws SiteModuleException

Description copied from interface: ISiteModule

Approves a content.

Specified by:

approve in interface IBaseSiteModule

Specified by:

approve in interface ISiteModule

Parameters:

context - The execution context.

contentContainer - The IContentContainer object.

Throws:

SiteModuleException - The default module exception.

approve

public void approve(IContext context,
 ITopic topic)
             throws SiteModuleException

Description copied from interface: ISiteModule

Approves all contents in a topic.

Specified by:

approve in interface IBaseSiteModule

Specified by:

approve in interface ISiteModule

Parameters:

context - The execution context.

topic - The ITopic object.

Throws:

SiteModuleException - The default module exception.

approve

public void approve(IContext context,
 ISite site)
             throws SiteModuleException

Description copied from interface: ISiteModule

Approves all contents in a site.

Specified by:

approve in interface IBaseSiteModule

Specified by:

approve in interface ISiteModule

Parameters:

context - The execution context.

site - The ISite object.

Throws:

SiteModuleException - The default module exception.

reject

public void reject(IContext context,
 IContentContainer contentContainer,
 String comment)
            throws SiteModuleException

Description copied from interface: ISiteModule

Rejects an approval request.

Specified by:

reject in interface IBaseSiteModule

Specified by:

reject in interface ISiteModule

Parameters:

context - The execution context.

contentContainer - The IContentContainer object to reject.

comment - The comment why rejecting the approval.

Throws:

SiteModuleException - The default module exception.

createBlock

public IBlock createBlock(IContext context)
                   throws SiteModuleException

Specified by:

createBlock in interface IBaseSiteModule

Specified by:

createBlock in interface ISiteModule

Throws:

SiteModuleException

createComponent

public IComponent createComponent(IContext context,
 String name)
                           throws SiteModuleException

Specified by:

createComponent in interface IBaseSiteModule

Specified by:

createComponent in interface ISiteModule

Throws:

SiteModuleException

getSecurityController

public ISecurityController getSecurityController(ISecuritySupport securitySupport)
                                          throws SiteModuleException

Description copied from interface: ISiteModule

Gets a security controller on a specified object.

Specified by:

getSecurityController in interface IBaseSiteModule

Specified by:

getSecurityController in interface ISiteModule

Parameters:

securitySupport - Any IElement that implements ISecuritySupport interface.

Returns:

The ISecurityController object.

Throws:

SiteModuleException - The default module exception.

getMessageController

public IMessageController getMessageController()
                                        throws SiteModuleException

Specified by:

getMessageController in interface IBaseSiteModule

Specified by:

getMessageController in interface ISiteModule

Throws:

SiteModuleException

getSite

public ISite getSite(Object siteObject)

ACCESSORS

Specified by:

getSite in interface IBaseSiteModule

Specified by:

getSite in interface ISiteModule

Parameters:

siteObject - The object to transform.

Returns:

A ISite object.

getTopic

public ITopic getTopic(Object topicObject)

Description copied from interface: ISiteModule

Access method to get a ITopic object from one of the followings: FolderImpl, java.io.Serializable.

Specified by:

getTopic in interface IBaseSiteModule

Specified by:

getTopic in interface ISiteModule

Parameters:

topicObject - The object to transform.

Returns:

A ITopic object.

getAlias

public IAlias getAlias(Object aliasObject)

Description copied from interface: ISiteModule

Access method to get a IAlias object from one of the followings: AliasImpl, java.io.Serializable.

Specified by:

getAlias in interface IBaseSiteModule

Specified by:

getAlias in interface ISiteModule

Parameters:

aliasObject - The object to transform.

Returns:

A IAlias object.

getPlugin

public IPlugin getPlugin(Object pluginObject)

Description copied from interface: ISiteModule

Access method to get a IPlugin object from one of the followings: ModuleImpl, java.io.Serializable.

Specified by:

getPlugin in interface IBaseSiteModule

Specified by:

getPlugin in interface ISiteModule

Parameters:

pluginObject - The object to transform.

Returns:

A IPlugin object.

getContentContainer

public IContentContainer getContentContainer(Object contentContainerObject)

Description copied from interface: ISiteModule

Access method to get a IContentContainer object from one of the followings: PageImpl, CommonBlockImpl, TemplateImpl, java.io.Serializable.

Specified by:

getContentContainer in interface IBaseSiteModule

Specified by:

getContentContainer in interface ISiteModule

Parameters:

contentContainerObject - The object to transform.

Returns:

A IContentContainer object.

getContent

public IContent getContent(Object contentObject)

Description copied from interface: ISiteModule

Access method to get a IContent object from one of the followings: ContentVersionImpl, java.io.Serializable.

Specified by:

getContent in interface IBaseSiteModule

Specified by:

getContent in interface ISiteModule

Parameters:

contentObject - The object to transform.

Returns:

A IContent object.

getContentComponent

public IContentComponent getContentComponent(Object contentComponentObject)

Description copied from interface: ISiteModule

Access method to get a IContentComponent object from one of the followings: ContentNodeImpl.

Specified by:

getContentComponent in interface IBaseSiteModule

Specified by:

getContentComponent in interface ISiteModule

Parameters:

contentComponentObject - The object to transform.

Returns:

A IContentComponent object.

getBlock

public IBlock getBlock(Object blockObject)

Description copied from interface: ISiteModule

Access method to get a IBlock object from one of the followings: BlockImpl, java.io.Serializable.

Specified by:

getBlock in interface IBaseSiteModule

Specified by:

getBlock in interface ISiteModule

Parameters:

blockObject - The object to transform.

Returns:

A IBlock object.

getComponent

public IComponent getComponent(Object componentObject)

Description copied from interface: ISiteModule

Access method to get a IComponent object from one of the followings: ElementImpl.

Specified by:

getComponent in interface IBaseSiteModule

Specified by:

getComponent in interface ISiteModule

Parameters:

componentObject - The object to transform.

Returns:

A IComponent object.

getBlockTemplateContainer

public IBlockTemplateContainer getBlockTemplateContainer(Object blockTemplateContainerObject)

Description copied from interface: ISiteModule

Access method to get a IBlockTemplateContainer object from one of the followings: TemplateImpl, java.io.Serializable.

Specified by:

getBlockTemplateContainer in interface IBaseSiteModule

Specified by:

getBlockTemplateContainer in interface ISiteModule

Parameters:

blockTemplateContainerObject - The object to transform.

Returns:

A IBlockTemplateContainer object.

getPageContainer

public IPageContainer getPageContainer(Object pageContainerObject)

Description copied from interface: ISiteModule

Access method to get a IPageContainer object from one of the followings: PageImpl, java.io.Serializable.

Specified by:

getPageContainer in interface IBaseSiteModule

Specified by:

getPageContainer in interface ISiteModule

Parameters:

pageContainerObject - The object to transform.

Returns:

A IPageContainer object.

getSharedBlockContainer

public ISharedBlockContainer getSharedBlockContainer(Object sharedBlockContainerObject)

Description copied from interface: ISiteModule

Access method to get a ISharedBlockContainer object from one of the followings: CommonBlockImpl, java.io.Serializable.

Specified by:

getSharedBlockContainer in interface IBaseSiteModule

Specified by:

getSharedBlockContainer in interface ISiteModule

Parameters:

sharedBlockContainerObject - The object to transform.

Returns:

A ISharedBlockContainer object.

getTarget

public IElement getTarget(IAlias alias)
                   throws SiteModuleException

Get target

Parameters:

alias - the alias

Returns:

the target

Throws:

SiteModuleException - on error

save

public void save(IContext context,
 IElement element)
          throws SiteModuleException

SAVE METHODS

Specified by:

save in interface IBaseSiteModule

Specified by:

save in interface ISiteModule

Parameters:

context - The execution context.

element - The IElement object to save or update.

Throws:

SiteModuleException - The default module exception.

deleteSite

public void deleteSite(IContext context,
 ISite site,
 boolean deleteLinkedLibrary)
                throws SiteModuleException

Delete site

Parameters:

context - the current context

site - the site

deleteLinkedLibrary - true to delete linked libraries

Throws:

SiteModuleException - on error

deleteSite

protected void deleteSite(IContext context,
 ISite site)
                   throws Exception

Throws:

Exception

delete

public void delete(IContext context,
 IElement element)
            throws SiteModuleException

Description copied from interface: ISiteModule

Deletes an element.

Specified by:

delete in interface IBaseSiteModule

Specified by:

delete in interface ISiteModule

Parameters:

context - The execution context.

element - The IElement object to delete.

Throws:

SiteModuleException - The default module exception.

getElementByURI

public IElement getElementByURI(IContext context,
 String uri)
                         throws ModuleException

Description copied from interface: ISiteModule

Gets an IElement by its URI.

Specified by:

getElementByURI in interface IBaseSiteModule

Specified by:

getElementByURI in interface ISiteModule

Parameters:

context - The execution context.

uri - The URI as a java.lang.String.

Returns:

A IElement object.

Throws:

ModuleException - default module exception.

getElementByProtocolURI

public IProtocolSupport getElementByProtocolURI(String protocolURI)
                                         throws ModuleException

Description copied from interface: ISiteModule

Gets an IElement object which implements IProtocolSupport interface.

Specified by:

getElementByProtocolURI in interface IBaseSiteModule

Specified by:

getElementByProtocolURI in interface ISiteModule

Parameters:

protocolURI - The protocol URI as a java.lang.String.

Returns:

A IProtocolSupport object.

Throws:

ModuleException - default module exception.

findObjectUri

public String findObjectUri(String pluginName,
 Object o)
                     throws ModuleException

Find object URI

Parameters:

pluginName - the plugin name

o - the object

Returns:

the URI

Throws:

ModuleException - on error

getExecutionContext

public InternalSiteExecutionContext getExecutionContext()

Description copied from interface: ISiteModule

Gets the specific execution context of the current module.

Specified by:

getExecutionContext in interface IBaseSiteModule

Specified by:

getExecutionContext in interface ISiteModule

Returns:

the executionContext

setExecutionContext

public void setExecutionContext(IExecutionContext executionContext)

Parameters:

executionContext - the executionContext to set

getFormsComponentsFactory

public com.axemble.vdoc.sdk.interfaces.ui.components.IComponentsFactory getFormsComponentsFactory()

Specified by:

getFormsComponentsFactory in interface IBaseSiteModule

Specified by:

getFormsComponentsFactory in interface ISiteModule

getFormsDefinitionsFactory

public com.axemble.vdoc.sdk.interfaces.ui.definitions.IDefinitionsFactory getFormsDefinitionsFactory()

Specified by:

getFormsDefinitionsFactory in interface IBaseSiteModule

Specified by:

getFormsDefinitionsFactory in interface ISiteModule

generateSystemName

public String generateSystemName(String label)

Description copied from interface: IModule

Generate a valid system name for this module and this label.

Specified by:

generateSystemName in interface IModule

Overrides:

generateSystemName in class PortalModule

Parameters:

label - label to normalize

Returns:

normalized value