Package com.axemble.vdoc.sdk.modules

Interface ISiteModule

All Superinterfaces:

IBaseSiteModule, IModule, Remote

All Known Implementing Classes:

EzsSiteModule

public interface ISiteModule
extends IBaseSiteModule

The base site module interface.

Code sample :

 // creation of a site module object
 ISiteModule siteModule = SDKFactory.MODULES.getSiteModule();
 try
 {
 }
 finally
 {
  // release the module
        SDKFactory.MODULES.releaseModule( siteModule );
 }
 

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.
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.
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.
ISiteExecutionContext	getExecutionContext()	Gets the specific execution context of the current module.
com.axemble.vdoc.sdk.interfaces.ui.components.IComponentsFactory	getFormsComponentsFactory()	Deprecated. do not use
com.axemble.vdoc.sdk.interfaces.ui.definitions.IDefinitionsFactory	getFormsDefinitionsFactory()	Deprecated. do not use
IMessageController	getMessageController()
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)
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)	Access method to get a ISite object from one of the followings: SiteImpl, java.io.Serializable.
ISite	getSiteByName(IContext context, String name)	Retrieves a site by its name.
IBlockTemplateContainer	getSystemBlockTemplateContainer(IContext context, String name)
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	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	save(IContext context, IElement element)	Saves or updates an element.

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

beginTransaction, beginTransaction, commitTransaction, commitTransaction, convertId, findNativeClass, generateSystemName, 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, initialize, isTransactionActive, rollbackTransaction, rollbackTransaction, setTransactionTimeout, unInitialize

Method Details

createSite

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

Creates a new site into an IOrganization object.

Specified by:

createSite in interface IBaseSiteModule

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

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

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

Specified by:

createSite in interface IBaseSiteModule

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.

getSiteByName

ISite getSiteByName(IContext context,
 String name)
             throws SiteModuleException

Retrieves a site by its name.

Specified by:

getSiteByName in interface IBaseSiteModule

Parameters:

context - The execution context.

name - The name of the site.

Returns:

A ISite object.

Throws:

SiteModuleException - The default module exception.

getCatalog

ICatalog getCatalog(IContext context,
 ISite site)
             throws SiteModuleException

Retrieves the catalog of the site.

Specified by:

getCatalog in interface IBaseSiteModule

Parameters:

context - The execution context.

site - The ISite object.

Returns:

A ICatalog object.

Throws:

SiteModuleException - The default module exception.

getResourceDefinition

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

Specified by:

getResourceDefinition in interface IBaseSiteModule

Throws:

SiteModuleException

getView

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

Specified by:

getView in interface IBaseSiteModule

Throws:

SiteModuleException

copyPageContainerInTopic

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

Copy a page in a topic

Specified by:

copyPageContainerInTopic in interface IBaseSiteModule

Parameters:

context - The execution context.

pageContainer - The page to copy

topic - The topic destination

Throws:

SiteModuleException - The default module exception.

createTopic

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

Creates a ITopic object a the root level.

Specified by:

createTopic in interface IBaseSiteModule

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

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

Creates a sub ITopic object.

Specified by:

createTopic in interface IBaseSiteModule

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

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

Create a plugin in a topic

Specified by:

createPlugin in interface IBaseSiteModule

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

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

Gets a root ITopic object by its name.

Specified by:

getTopic in interface IBaseSiteModule

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

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

Gets a ITopic object by its name.

Specified by:

getTopic in interface IBaseSiteModule

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

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

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

Specified by:

getTopics in interface IBaseSiteModule

Parameters:

context - The execution context.

site - The ISite object.

Returns:

A java.util.Collection of ITopic objects.

Throws:

SiteModuleException - The default module exception.

getTopics

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

Specified by:

getTopics in interface IBaseSiteModule

Throws:

SiteModuleException

getTopics

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

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

Specified by:

getTopics in interface IBaseSiteModule

Parameters:

context - The execution context.

parent - The ITopic object.

Returns:

A java.util.Collection of ITopic objects.

Throws:

SiteModuleException - The default module exception.

getTopics

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

Specified by:

getTopics in interface IBaseSiteModule

Throws:

SiteModuleException

getPlugins

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

Gets all the plugins from a site at root level.

Specified by:

getPlugins in interface IBaseSiteModule

Parameters:

context - The execution context.

site - The ISite object.

Returns:

A java.util.Collection of IPlugin objects.

Throws:

SiteModuleException - The default module exception.

getPlugins

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

Specified by:

getPlugins in interface IBaseSiteModule

Throws:

SiteModuleException

getBlockTemplateContainerByURI

IBlockTemplateContainer getBlockTemplateContainerByURI(IContext context,
 String uri)
                                                throws SiteModuleException

Specified by:

getBlockTemplateContainerByURI in interface IBaseSiteModule

Throws:

SiteModuleException

getSystemBlockTemplateContainer

IBlockTemplateContainer getSystemBlockTemplateContainer(IContext context,
 String name)
                                                 throws SiteModuleException

Specified by:

getSystemBlockTemplateContainer in interface IBaseSiteModule

Throws:

SiteModuleException

getBlockTemplateContainers

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

Gets all the templates.

Specified by:

getBlockTemplateContainers in interface IBaseSiteModule

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

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

Specified by:

getBlockTemplateContainers in interface IBaseSiteModule

Throws:

SiteModuleException

createPageContainer

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

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

Specified by:

createPageContainer in interface IBaseSiteModule

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

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

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

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

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

Creates a IPageContainer object into a ITopic object.

Specified by:

createPageContainer in interface IBaseSiteModule

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

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

Creates a IPageContainer object into a ITopic object.

Specified by:

createPageContainer in interface IBaseSiteModule

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

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

Gets a root IPageContainer object by its name.

Specified by:

getPageContainer in interface IBaseSiteModule

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

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

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

Specified by:

getPageContainer in interface IBaseSiteModule

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

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

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

Specified by:

getPageContainers in interface IBaseSiteModule

Parameters:

context - The execution context.

site - The ISite object.

Returns:

A java.util.Collection of ITopic objects.

Throws:

SiteModuleException - The default module exception.

getPageContainers

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

Specified by:

getPageContainers in interface IBaseSiteModule

Throws:

SiteModuleException

getPageContainers

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

Gets all the pages from the ITopic object.

Specified by:

getPageContainers in interface IBaseSiteModule

Parameters:

context - The execution context.

parent - The ITopic object.

Returns:

A java.util.Collection of ITopic objects.

Throws:

SiteModuleException - The default module exception.

getPageContainers

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

Specified by:

getPageContainers in interface IBaseSiteModule

Throws:

SiteModuleException

createProtocolSupport

IProtocolSupport createProtocolSupport(String freeURL)
                                throws SiteModuleException

Creates a generic IProtocolSupport object from an URL.

Specified by:

createProtocolSupport in interface IBaseSiteModule

Parameters:

freeURL - The free URL.

Returns:

A IProtocolSupport object.

Throws:

SiteModuleException - The default module exception.

createAlias

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

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

Specified by:

createAlias in interface IBaseSiteModule

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

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

Creates an IAlias object into a ITopic object.

Specified by:

createAlias in interface IBaseSiteModule

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

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

Gets an IAlias object by its name.

Specified by:

getAlias in interface IBaseSiteModule

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

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

Gets an IAlias object by its name.

Specified by:

getAlias in interface IBaseSiteModule

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

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

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

Specified by:

getAliases in interface IBaseSiteModule

Parameters:

context - The execution context.

site - The ISite object.

Returns:

A java.util.Collection of IAlias object.

Throws:

SiteModuleException - The default module exception.

getAliases

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

Specified by:

getAliases in interface IBaseSiteModule

Throws:

SiteModuleException

getAliases

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

Gets all the aliases of a ITopic object.

Specified by:

getAliases in interface IBaseSiteModule

Parameters:

context - The execution context.

parent - The ITopic object.

Returns:

A java.util.Collection of IAlias object.

Throws:

SiteModuleException - The default module exception.

getAliases

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

Specified by:

getAliases in interface IBaseSiteModule

Throws:

SiteModuleException

getContentContainer

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

Specified by:

getContentContainer in interface IBaseSiteModule

Throws:

SiteModuleException

getContentContainer

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

Specified by:

getContentContainer in interface IBaseSiteModule

Throws:

SiteModuleException

getContentContainers

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

Specified by:

getContentContainers in interface IBaseSiteModule

Throws:

SiteModuleException

getContentContainers

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

Specified by:

getContentContainers in interface IBaseSiteModule

Throws:

SiteModuleException

getContentContainers

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

Specified by:

getContentContainers in interface IBaseSiteModule

Throws:

SiteModuleException

getContentContainers

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

Specified by:

getContentContainers in interface IBaseSiteModule

Throws:

SiteModuleException

createContent

IContent createContent(IContext context,
 IContentContainer contentContainer)
                throws SiteModuleException

Specified by:

createContent in interface IBaseSiteModule

Throws:

SiteModuleException

createContent

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

Specified by:

createContent in interface IBaseSiteModule

Throws:

SiteModuleException

requestApproval

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

Requests an approval of the content.

Specified by:

requestApproval in interface IBaseSiteModule

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

void approve(IContext context,
 IContentContainer contentContainer)
      throws SiteModuleException

Approves a content.

Specified by:

approve in interface IBaseSiteModule

Parameters:

context - The execution context.

contentContainer - The IContentContainer object.

Throws:

SiteModuleException - The default module exception.

approve

void approve(IContext context,
 ITopic topic)
      throws SiteModuleException

Approves all contents in a topic.

Specified by:

approve in interface IBaseSiteModule

Parameters:

context - The execution context.

topic - The ITopic object.

Throws:

SiteModuleException - The default module exception.

approve

void approve(IContext context,
 ISite site)
      throws SiteModuleException

Approves all contents in a site.

Specified by:

approve in interface IBaseSiteModule

Parameters:

context - The execution context.

site - The ISite object.

Throws:

SiteModuleException - The default module exception.

reject

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

Rejects an approval request.

Specified by:

reject in interface IBaseSiteModule

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

IBlock createBlock(IContext context)
            throws SiteModuleException

Specified by:

createBlock in interface IBaseSiteModule

Throws:

SiteModuleException

createComponent

IComponent createComponent(IContext context,
 String name)
                    throws SiteModuleException

Specified by:

createComponent in interface IBaseSiteModule

Throws:

SiteModuleException

getContentByStatus

IContent getContentByStatus(IContentContainer contentContainer,
 int status)
                     throws SiteModuleException

Gets a content of a container by its status.

Specified by:

getContentByStatus in interface IBaseSiteModule

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

Collection<IContent> getContents(IContentContainer contentContainer)
                          throws SiteModuleException

Specified by:

getContents in interface IBaseSiteModule

Throws:

SiteModuleException

save

void save(IContext context,
 IElement element)
   throws SiteModuleException

Saves or updates an element.

Specified by:

save in interface IBaseSiteModule

Parameters:

context - The execution context.

element - The IElement object to save or update.

Throws:

SiteModuleException - The default module exception.

delete

void delete(IContext context,
 IElement element)
     throws SiteModuleException

Deletes an element.

Specified by:

delete in interface IBaseSiteModule

Parameters:

context - The execution context.

element - The IElement object to delete.

Throws:

SiteModuleException - The default module exception.

getSecurityController

ISecurityController getSecurityController(ISecuritySupport securitySupport)
                                   throws SiteModuleException

Gets a security controller on a specified object.

Specified by:

getSecurityController in interface IBaseSiteModule

Parameters:

securitySupport - Any IElement that implements ISecuritySupport interface.

Returns:

The ISecurityController object.

Throws:

SiteModuleException - The default module exception.

getMessageController

IMessageController getMessageController()
                                 throws SiteModuleException

Specified by:

getMessageController in interface IBaseSiteModule

Throws:

SiteModuleException

getSite

ISite getSite(Object siteObject)

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

Specified by:

getSite in interface IBaseSiteModule

Parameters:

siteObject - The object to transform.

Returns:

A ISite object.

getTopic

ITopic getTopic(Object topicObject)

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

Specified by:

getTopic in interface IBaseSiteModule

Parameters:

topicObject - The object to transform.

Returns:

A ITopic object.

getAlias

IAlias getAlias(Object aliasObject)

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

Specified by:

getAlias in interface IBaseSiteModule

Parameters:

aliasObject - The object to transform.

Returns:

A IAlias object.

getPlugin

IPlugin getPlugin(Object pluginObject)

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

Specified by:

getPlugin in interface IBaseSiteModule

Parameters:

pluginObject - The object to transform.

Returns:

A IPlugin object.

getContentContainer

IContentContainer getContentContainer(Object contentContainerObject)

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

Specified by:

getContentContainer in interface IBaseSiteModule

Parameters:

contentContainerObject - The object to transform.

Returns:

A IContentContainer object.

getPageContainer

IPageContainer getPageContainer(Object pageContainerObject)

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

Specified by:

getPageContainer in interface IBaseSiteModule

Parameters:

pageContainerObject - The object to transform.

Returns:

A IPageContainer object.

getSharedBlockContainer

ISharedBlockContainer getSharedBlockContainer(Object sharedBlockContainerObject)

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

Specified by:

getSharedBlockContainer in interface IBaseSiteModule

Parameters:

sharedBlockContainerObject - The object to transform.

Returns:

A ISharedBlockContainer object.

getBlockTemplateContainer

IBlockTemplateContainer getBlockTemplateContainer(Object blockTemplateContainerObject)

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

Specified by:

getBlockTemplateContainer in interface IBaseSiteModule

Parameters:

blockTemplateContainerObject - The object to transform.

Returns:

A IBlockTemplateContainer object.

getContent

IContent getContent(Object contentObject)

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

Specified by:

getContent in interface IBaseSiteModule

Parameters:

contentObject - The object to transform.

Returns:

A IContent object.

getContentComponent

IContentComponent getContentComponent(Object contentComponentObject)

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

Specified by:

getContentComponent in interface IBaseSiteModule

Parameters:

contentComponentObject - The object to transform.

Returns:

A IContentComponent object.

getBlock

IBlock getBlock(Object blockObject)

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

Specified by:

getBlock in interface IBaseSiteModule

Parameters:

blockObject - The object to transform.

Returns:

A IBlock object.

getComponent

IComponent getComponent(Object componentObject)

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

Specified by:

getComponent in interface IBaseSiteModule

Parameters:

componentObject - The object to transform.

Returns:

A IComponent object.

getElementByProtocolURI

IProtocolSupport getElementByProtocolURI(String protocolURI)
                                  throws ModuleException

Gets an IElement object which implements IProtocolSupport interface.

Specified by:

getElementByProtocolURI in interface IBaseSiteModule

Parameters:

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

Returns:

A IProtocolSupport object.

Throws:

ModuleException - default module exception.

getElementByURI

IElement getElementByURI(IContext context,
 String uri)
                  throws ModuleException

Gets an IElement by its URI.

Specified by:

getElementByURI in interface IBaseSiteModule

Parameters:

context - The execution context.

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

Returns:

A IElement object.

Throws:

ModuleException - default module exception.

getExecutionContext

ISiteExecutionContext getExecutionContext()

Gets the specific execution context of the current module.

Specified by:

getExecutionContext in interface IBaseSiteModule

Returns:

A ISiteExecutionContext object.

getFormsComponentsFactory

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

Deprecated.

do not use

Specified by:

getFormsComponentsFactory in interface IBaseSiteModule

getFormsDefinitionsFactory

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

Deprecated.

do not use

Specified by:

getFormsDefinitionsFactory in interface IBaseSiteModule