Package com.axemble.vdoc.sdk.modules
Interface ISiteModule
- All Superinterfaces:
IBaseSiteModule,IModule,Remote
- All Known Implementing Classes:
EzsSiteModule
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 TypeMethodDescriptionvoidapprove(IContext context, IContentContainer contentContainer) Approves a content.voidApproves all contents in a site.voidApproves all contents in a topic.voidcopyPageContainerInTopic(IContext context, IPageContainer pageContainer, ITopic topic) Copy a page in a topiccreateAlias(IContext context, ISite site, String name, String label, IProtocolSupport protocolSupport) Creates anIAliasobject at the root level of a site.createAlias(IContext context, ITopic topic, String name, String label, IProtocolSupport protocolSupport) createBlock(IContext context) createComponent(IContext context, String name) createContent(IContext context, IContentContainer contentContainer) createContent(IContext context, IContentContainer contentContainer, IBlockTemplateContainer templateContainer) createPageContainer(IContext context, ISite site, IBlockTemplateContainer templateContainer, String name, String label) Creates aIPageContainerobject at the root level of aISiteobject.createPageContainer(IContext context, ISite site, String name, String label) Creates aIPageContainerobject at the root level of aISiteobject.createPageContainer(IContext context, ITopic topic, IBlockTemplateContainer templateContainer, String name, String label) Creates aIPageContainerobject into aITopicobject.createPageContainer(IContext context, ITopic topic, String name, String label) Creates aIPageContainerobject into aITopicobject.voidcreatePlugin(IContext context, String parentUri, PluginConfigurationBean pluginConfigurationBean) Create a plugin in a topiccreateProtocolSupport(String freeURL) Creates a genericIProtocolSupportobject from an URL.createSite(IContext context, ILibrary library, String name) Creates a new site and associates it to aILibrary(same organization).createSite(IContext context, IOrganization organization, String name) Creates a new site into anIOrganizationobject.createTopic(IContext context, ISite site, String name, String label) Creates aITopicobject a the root level.createTopic(IContext context, ITopic parent, String name, String label) Creates a subITopicobject.voidDeletes an element.Gets anIAliasobject by its name.Gets anIAliasobject by its name.Access method to get aIAliasobject from one of the followings: AliasImpl, java.io.Serializable.getAliases(IContext context, ISite site) Gets all the aliases from the root level of theISiteobject.getAliases(IContext context, ISite site, boolean recursive) getAliases(IContext context, ITopic parent) Gets all the aliases of aITopicobject.getAliases(IContext context, ITopic parent, boolean recursive) Access method to get aIBlockobject from one of the followings: BlockImpl, java.io.Serializable.getBlockTemplateContainer(Object blockTemplateContainerObject) Access method to get aIBlockTemplateContainerobject from one of the followings: TemplateImpl, java.io.Serializable.getBlockTemplateContainerByURI(IContext context, String uri) getBlockTemplateContainers(IContext context, ISite site) getBlockTemplateContainers(IContext context, ISite site, int type) Gets all the templates.getCatalog(IContext context, ISite site) Retrieves the catalog of the site.getComponent(Object componentObject) Access method to get aIComponentobject from one of the followings: ElementImpl.getContent(Object contentObject) Access method to get aIContentobject from one of the followings: ContentVersionImpl, java.io.Serializable.getContentByStatus(IContentContainer contentContainer, int status) Gets a content of a container by its status.getContentComponent(Object contentComponentObject) Access method to get aIContentComponentobject from one of the followings: ContentNodeImpl.getContentContainer(IContext context, ISite site, String name) getContentContainer(IContext context, ITopic parent, String name) getContentContainer(Object contentContainerObject) Access method to get aIContentContainerobject from one of the followings: PageImpl, CommonBlockImpl, TemplateImpl, java.io.Serializable.getContentContainers(IContext context, ISite site) getContentContainers(IContext context, ISite site, boolean recursive) getContentContainers(IContext context, ITopic parent) getContentContainers(IContext context, ITopic parent, boolean recursive) getContents(IContentContainer contentContainer) getElementByProtocolURI(String protocolURI) Gets anIElementobject which implementsIProtocolSupportinterface.getElementByURI(IContext context, String uri) Gets anIElementby its URI.Gets the specific execution context of the current module.com.axemble.vdoc.sdk.interfaces.ui.components.IComponentsFactoryDeprecated.do not usecom.axemble.vdoc.sdk.interfaces.ui.definitions.IDefinitionsFactoryDeprecated.do not usegetPageContainer(IContext context, ISite site, String name) Gets a rootIPageContainerobject by its name.getPageContainer(IContext context, ITopic topic, String name) Gets aIPageContainerobject from aITopicobject by its name.getPageContainer(Object pageContainerObject) Access method to get aIPageContainerobject from one of the followings: PageImpl, java.io.Serializable.getPageContainers(IContext context, ISite site) Gets all the pages from a site at a root level.getPageContainers(IContext context, ISite site, boolean recursive) getPageContainers(IContext context, ITopic parent) Gets all the pages from theITopicobject.getPageContainers(IContext context, ITopic parent, boolean recursive) Access method to get aIPluginobject from one of the followings: ModuleImpl, java.io.Serializable.getPlugins(IContext context, ISite site) Gets all the plugins from a site at root level.getPlugins(IContext context, ISite site, boolean recursive) getResourceDefinition(IContext context, IPageContainer pageContainer, String dataFormName) getSecurityController(ISecuritySupport securitySupport) Gets a security controller on a specified object.getSharedBlockContainer(Object sharedBlockContainerObject) Access method to get aISharedBlockContainerobject from one of the followings: CommonBlockImpl, java.io.Serializable.Access method to get aISiteobject from one of the followings: SiteImpl, java.io.Serializable.getSiteByName(IContext context, String name) Retrieves a site by its name.getSystemBlockTemplateContainer(IContext context, String name) Gets a rootITopicobject by its name.Gets aITopicobject by its name.Access method to get aITopicobject from one of the followings: FolderImpl, java.io.Serializable.Gets all the topics from a site at a root level.Gets all the sub-topics from a parentITopicobject.getView(IContext context, IResourceDefinition resourceDefinition, String viewName) voidreject(IContext context, IContentContainer contentContainer, String comment) Rejects an approval request.voidrequestApproval(IContext context, IContentContainer contentContainer, String comment) Requests an approval of the content.voidSaves 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 anIOrganizationobject.- Specified by:
createSitein interfaceIBaseSiteModule- Parameters:
context- The execution context.organization- TheIOrganizationobject.name- The name of the site.- Returns:
- A
ISiteobject. - Throws:
SiteModuleException- The default module exception.
-
createSite
Creates a new site and associates it to aILibrary(same organization).- Specified by:
createSitein interfaceIBaseSiteModule- Parameters:
context- The execution context.library- TheILibraryobject.name- The name of the site.- Returns:
- A
ISiteobject. - Throws:
SiteModuleException- The default module exception.
-
getSiteByName
Retrieves a site by its name.- Specified by:
getSiteByNamein interfaceIBaseSiteModule- Parameters:
context- The execution context.name- The name of the site.- Returns:
- A
ISiteobject. - Throws:
SiteModuleException- The default module exception.
-
getCatalog
Retrieves the catalog of the site.- Specified by:
getCatalogin interfaceIBaseSiteModule- Parameters:
context- The execution context.site- TheISiteobject.- Returns:
- A
ICatalogobject. - Throws:
SiteModuleException- The default module exception.
-
getResourceDefinition
IResourceDefinition getResourceDefinition(IContext context, IPageContainer pageContainer, String dataFormName) throws SiteModuleException - Specified by:
getResourceDefinitionin interfaceIBaseSiteModule- Throws:
SiteModuleException
-
getView
IView getView(IContext context, IResourceDefinition resourceDefinition, String viewName) throws SiteModuleException - Specified by:
getViewin interfaceIBaseSiteModule- Throws:
SiteModuleException
-
copyPageContainerInTopic
void copyPageContainerInTopic(IContext context, IPageContainer pageContainer, ITopic topic) throws SiteModuleException Copy a page in a topic- Specified by:
copyPageContainerInTopicin interfaceIBaseSiteModule- Parameters:
context- The execution context.pageContainer- The page to copytopic- The topic destination- Throws:
SiteModuleException- The default module exception.
-
createTopic
ITopic createTopic(IContext context, ISite site, String name, String label) throws SiteModuleException Creates aITopicobject a the root level.- Specified by:
createTopicin interfaceIBaseSiteModule- Parameters:
context- The execution context.site- TheISiteobject.name- The name of the topic.label- The label of the topic.- Returns:
- A
ITopicobject. - Throws:
SiteModuleException- The default module exception.
-
createTopic
ITopic createTopic(IContext context, ITopic parent, String name, String label) throws SiteModuleException Creates a subITopicobject.- Specified by:
createTopicin interfaceIBaseSiteModule- Parameters:
context- The execution context.parent- The parentITopicobject.name- The name of the topic.label- The label of the topic.- Returns:
- A
ITopicobject. - 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:
createPluginin interfaceIBaseSiteModule- Parameters:
context- The execution contextparentUri- The URI of the parent where the plugin will be created.pluginConfigurationBean- The plugin configuration bean.- Throws:
SiteModuleException- The default module exception.
-
getTopic
Gets a rootITopicobject by its name.- Specified by:
getTopicin interfaceIBaseSiteModule- Parameters:
context- The execution context.site- TheISiteobject.name- The system name of the topic.- Returns:
- A
ITopicobject. - Throws:
SiteModuleException- The default module exception.
-
getTopic
Gets aITopicobject by its name.- Specified by:
getTopicin interfaceIBaseSiteModule- Parameters:
context- The execution context.parent- TheITopicobject.name- The system name of the topic.- Returns:
- A
ITopicobject. - Throws:
SiteModuleException- The default module exception.
-
getTopics
Gets all the topics from a site at a root level.- Specified by:
getTopicsin interfaceIBaseSiteModule- Parameters:
context- The execution context.site- TheISiteobject.- Returns:
- A java.util.Collection of
ITopicobjects. - Throws:
SiteModuleException- The default module exception.
-
getTopics
Collection<ITopic> getTopics(IContext context, ISite site, boolean recursive) throws SiteModuleException - Specified by:
getTopicsin interfaceIBaseSiteModule- Throws:
SiteModuleException
-
getTopics
Gets all the sub-topics from a parentITopicobject.- Specified by:
getTopicsin interfaceIBaseSiteModule- Parameters:
context- The execution context.parent- TheITopicobject.- Returns:
- A java.util.Collection of
ITopicobjects. - Throws:
SiteModuleException- The default module exception.
-
getTopics
Collection<ITopic> getTopics(IContext context, ITopic parent, boolean recursive) throws SiteModuleException - Specified by:
getTopicsin interfaceIBaseSiteModule- Throws:
SiteModuleException
-
getPlugins
Gets all the plugins from a site at root level.- Specified by:
getPluginsin interfaceIBaseSiteModule- Parameters:
context- The execution context.site- The ISite object.- Returns:
- A java.util.Collection of
IPluginobjects. - Throws:
SiteModuleException- The default module exception.
-
getPlugins
Collection<IPlugin> getPlugins(IContext context, ISite site, boolean recursive) throws SiteModuleException - Specified by:
getPluginsin interfaceIBaseSiteModule- Throws:
SiteModuleException
-
getBlockTemplateContainerByURI
IBlockTemplateContainer getBlockTemplateContainerByURI(IContext context, String uri) throws SiteModuleException - Specified by:
getBlockTemplateContainerByURIin interfaceIBaseSiteModule- Throws:
SiteModuleException
-
getSystemBlockTemplateContainer
IBlockTemplateContainer getSystemBlockTemplateContainer(IContext context, String name) throws SiteModuleException - Specified by:
getSystemBlockTemplateContainerin interfaceIBaseSiteModule- Throws:
SiteModuleException
-
getBlockTemplateContainers
Collection<IBlockTemplateContainer> getBlockTemplateContainers(IContext context, ISite site, int type) throws SiteModuleException Gets all the templates.- Specified by:
getBlockTemplateContainersin interfaceIBaseSiteModule- Parameters:
context- The execution context.type- The type of the block template container, one of theIBlockTemplateContainer.ITypestructure.- Returns:
- A java.util.Collection of
IBlockTemplateContainerobjects. - Throws:
SiteModuleException- The default module exception.
-
getBlockTemplateContainers
Collection<IBlockTemplateContainer> getBlockTemplateContainers(IContext context, ISite site) throws SiteModuleException - Specified by:
getBlockTemplateContainersin interfaceIBaseSiteModule- Throws:
SiteModuleException
-
createPageContainer
IPageContainer createPageContainer(IContext context, ISite site, String name, String label) throws SiteModuleException Creates aIPageContainerobject at the root level of aISiteobject.- Specified by:
createPageContainerin interfaceIBaseSiteModule- Parameters:
context- The execution context.site- TheISiteobject.name- The name of the page.label- The label of the page.- Returns:
- A
IPageContainerobject. - Throws:
SiteModuleException- The default module exception.
-
createPageContainer
IPageContainer createPageContainer(IContext context, ISite site, IBlockTemplateContainer templateContainer, String name, String label) throws SiteModuleException Creates aIPageContainerobject at the root level of aISiteobject. This method allows to base the draftIContentof theIPageContainerto a block template container.- Specified by:
createPageContainerin interfaceIBaseSiteModule- Parameters:
context- The execution context.site- TheISiteobject.templateContainer- The block template container.name- The name of the page.label- The label of the page.- Returns:
- A
IPageContainerobject. - Throws:
SiteModuleException- The default module exception.
-
createPageContainer
IPageContainer createPageContainer(IContext context, ITopic topic, String name, String label) throws SiteModuleException Creates aIPageContainerobject into aITopicobject.- Specified by:
createPageContainerin interfaceIBaseSiteModule- Parameters:
context- The execution context.topic- TheITopicobject.name- The name of the page.label- The label of the page.- Returns:
- A
IPageContainerobject. - Throws:
SiteModuleException- The default module exception.
-
createPageContainer
IPageContainer createPageContainer(IContext context, ITopic topic, IBlockTemplateContainer templateContainer, String name, String label) throws SiteModuleException Creates aIPageContainerobject into aITopicobject.- Specified by:
createPageContainerin interfaceIBaseSiteModule- Parameters:
context- The execution context.topic- TheITopicobject.templateContainer- The block template container.name- The name of the page.label- The label of the page.- Returns:
- A
IPageContainerobject. - Throws:
SiteModuleException- SiteModuleException The default module exception.
-
getPageContainer
IPageContainer getPageContainer(IContext context, ISite site, String name) throws SiteModuleException Gets a rootIPageContainerobject by its name.- Specified by:
getPageContainerin interfaceIBaseSiteModule- Parameters:
context- The execution context.site- TheISiteobject.name- The system name of the topic.- Returns:
- A
IPageContainerobject. - Throws:
SiteModuleException- The default module exception.
-
getPageContainer
IPageContainer getPageContainer(IContext context, ITopic topic, String name) throws SiteModuleException Gets aIPageContainerobject from aITopicobject by its name.- Specified by:
getPageContainerin interfaceIBaseSiteModule- Parameters:
context- The execution context.topic- TheITopicobject.name- The system name of the topic.- Returns:
- A
IPageContainerobject. - 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:
getPageContainersin interfaceIBaseSiteModule- Parameters:
context- The execution context.site- TheISiteobject.- Returns:
- A java.util.Collection of
ITopicobjects. - Throws:
SiteModuleException- The default module exception.
-
getPageContainers
Collection<IPageContainer> getPageContainers(IContext context, ISite site, boolean recursive) throws SiteModuleException - Specified by:
getPageContainersin interfaceIBaseSiteModule- Throws:
SiteModuleException
-
getPageContainers
Collection<IPageContainer> getPageContainers(IContext context, ITopic parent) throws SiteModuleException Gets all the pages from theITopicobject.- Specified by:
getPageContainersin interfaceIBaseSiteModule- Parameters:
context- The execution context.parent- TheITopicobject.- Returns:
- A java.util.Collection of
ITopicobjects. - Throws:
SiteModuleException- The default module exception.
-
getPageContainers
Collection<IPageContainer> getPageContainers(IContext context, ITopic parent, boolean recursive) throws SiteModuleException - Specified by:
getPageContainersin interfaceIBaseSiteModule- Throws:
SiteModuleException
-
createProtocolSupport
Creates a genericIProtocolSupportobject from an URL.- Specified by:
createProtocolSupportin interfaceIBaseSiteModule- Parameters:
freeURL- The free URL.- Returns:
- A
IProtocolSupportobject. - Throws:
SiteModuleException- The default module exception.
-
createAlias
IAlias createAlias(IContext context, ISite site, String name, String label, IProtocolSupport protocolSupport) throws SiteModuleException Creates anIAliasobject at the root level of a site.- Specified by:
createAliasin interfaceIBaseSiteModule- Parameters:
context- The execution context.site- TheISiteobject.name- The name of the alias.label- The label of the alias.protocolSupport- TheIProtocolSupportobject to point to.- Returns:
- A
IAliasobject. - Throws:
SiteModuleException- The default module exception.
-
createAlias
IAlias createAlias(IContext context, ITopic topic, String name, String label, IProtocolSupport protocolSupport) throws SiteModuleException - Specified by:
createAliasin interfaceIBaseSiteModule- Parameters:
context- The execution context.topic- TheITopicobject.name- The name of the alias.label- The label of the alias.protocolSupport- TheIProtocolSupportobject to point to.- Returns:
- A
IAliasobject. - Throws:
SiteModuleException- The default module exception.
-
getAlias
Gets anIAliasobject by its name.- Specified by:
getAliasin interfaceIBaseSiteModule- Parameters:
context- The execution context.site- TheISiteobject.name- The name of the alias.- Returns:
- A
IAliasobject. - Throws:
SiteModuleException- The default module exception.
-
getAlias
Gets anIAliasobject by its name.- Specified by:
getAliasin interfaceIBaseSiteModule- Parameters:
context- The execution context.parent- TheITopicobject.name- The name of the alias.- Returns:
- A
IAliasobject. - Throws:
SiteModuleException- The default module exception.
-
getAliases
Gets all the aliases from the root level of theISiteobject.- Specified by:
getAliasesin interfaceIBaseSiteModule- Parameters:
context- The execution context.site- TheISiteobject.- Returns:
- A java.util.Collection of
IAliasobject. - Throws:
SiteModuleException- The default module exception.
-
getAliases
Collection<IAlias> getAliases(IContext context, ISite site, boolean recursive) throws SiteModuleException - Specified by:
getAliasesin interfaceIBaseSiteModule- Throws:
SiteModuleException
-
getAliases
Gets all the aliases of aITopicobject.- Specified by:
getAliasesin interfaceIBaseSiteModule- Parameters:
context- The execution context.parent- TheITopicobject.- Returns:
- A java.util.Collection of
IAliasobject. - Throws:
SiteModuleException- The default module exception.
-
getAliases
Collection<IAlias> getAliases(IContext context, ITopic parent, boolean recursive) throws SiteModuleException - Specified by:
getAliasesin interfaceIBaseSiteModule- Throws:
SiteModuleException
-
getContentContainer
IContentContainer getContentContainer(IContext context, ISite site, String name) throws SiteModuleException - Specified by:
getContentContainerin interfaceIBaseSiteModule- Throws:
SiteModuleException
-
getContentContainer
IContentContainer getContentContainer(IContext context, ITopic parent, String name) throws SiteModuleException - Specified by:
getContentContainerin interfaceIBaseSiteModule- Throws:
SiteModuleException
-
getContentContainers
Collection<IContentContainer> getContentContainers(IContext context, ISite site) throws SiteModuleException - Specified by:
getContentContainersin interfaceIBaseSiteModule- Throws:
SiteModuleException
-
getContentContainers
Collection<IContentContainer> getContentContainers(IContext context, ISite site, boolean recursive) throws SiteModuleException - Specified by:
getContentContainersin interfaceIBaseSiteModule- Throws:
SiteModuleException
-
getContentContainers
Collection<IContentContainer> getContentContainers(IContext context, ITopic parent) throws SiteModuleException - Specified by:
getContentContainersin interfaceIBaseSiteModule- Throws:
SiteModuleException
-
getContentContainers
Collection<IContentContainer> getContentContainers(IContext context, ITopic parent, boolean recursive) throws SiteModuleException - Specified by:
getContentContainersin interfaceIBaseSiteModule- Throws:
SiteModuleException
-
createContent
IContent createContent(IContext context, IContentContainer contentContainer) throws SiteModuleException - Specified by:
createContentin interfaceIBaseSiteModule- Throws:
SiteModuleException
-
createContent
IContent createContent(IContext context, IContentContainer contentContainer, IBlockTemplateContainer templateContainer) throws SiteModuleException - Specified by:
createContentin interfaceIBaseSiteModule- Throws:
SiteModuleException
-
requestApproval
void requestApproval(IContext context, IContentContainer contentContainer, String comment) throws SiteModuleException Requests an approval of the content.- Specified by:
requestApprovalin interfaceIBaseSiteModule- Parameters:
context- The execution context.contentContainer- TheIContentContainerobject to approve.comment- The comment why rejecting the approval.- Throws:
SiteModuleException- The default module exception.
-
approve
Approves a content.- Specified by:
approvein interfaceIBaseSiteModule- Parameters:
context- The execution context.contentContainer- TheIContentContainerobject.- Throws:
SiteModuleException- The default module exception.
-
approve
Approves all contents in a topic.- Specified by:
approvein interfaceIBaseSiteModule- Parameters:
context- The execution context.topic- TheITopicobject.- Throws:
SiteModuleException- The default module exception.
-
approve
Approves all contents in a site.- Specified by:
approvein interfaceIBaseSiteModule- Parameters:
context- The execution context.site- TheISiteobject.- Throws:
SiteModuleException- The default module exception.
-
reject
void reject(IContext context, IContentContainer contentContainer, String comment) throws SiteModuleException Rejects an approval request.- Specified by:
rejectin interfaceIBaseSiteModule- Parameters:
context- The execution context.contentContainer- TheIContentContainerobject to reject.comment- The comment why rejecting the approval.- Throws:
SiteModuleException- The default module exception.
-
createBlock
- Specified by:
createBlockin interfaceIBaseSiteModule- Throws:
SiteModuleException
-
createComponent
- Specified by:
createComponentin interfaceIBaseSiteModule- Throws:
SiteModuleException
-
getContentByStatus
IContent getContentByStatus(IContentContainer contentContainer, int status) throws SiteModuleException Gets a content of a container by its status.- Specified by:
getContentByStatusin interfaceIBaseSiteModule- Parameters:
contentContainer- The content container object.status- The value of the status which could be one of theIContent.IStatusstructure.- Returns:
- A
IContentobject. - Throws:
SiteModuleException
-
getContents
- Specified by:
getContentsin interfaceIBaseSiteModule- Throws:
SiteModuleException
-
save
Saves or updates an element.- Specified by:
savein interfaceIBaseSiteModule- Parameters:
context- The execution context.element- TheIElementobject to save or update.- Throws:
SiteModuleException- The default module exception.
-
delete
Deletes an element.- Specified by:
deletein interfaceIBaseSiteModule- Parameters:
context- The execution context.element- TheIElementobject 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:
getSecurityControllerin interfaceIBaseSiteModule- Parameters:
securitySupport- Any IElement that implements ISecuritySupport interface.- Returns:
- The
ISecurityControllerobject. - Throws:
SiteModuleException- The default module exception.
-
getMessageController
- Specified by:
getMessageControllerin interfaceIBaseSiteModule- Throws:
SiteModuleException
-
getSite
Access method to get aISiteobject from one of the followings: SiteImpl, java.io.Serializable.- Specified by:
getSitein interfaceIBaseSiteModule- Parameters:
siteObject- The object to transform.- Returns:
- A
ISiteobject.
-
getTopic
Access method to get aITopicobject from one of the followings: FolderImpl, java.io.Serializable.- Specified by:
getTopicin interfaceIBaseSiteModule- Parameters:
topicObject- The object to transform.- Returns:
- A
ITopicobject.
-
getAlias
Access method to get aIAliasobject from one of the followings: AliasImpl, java.io.Serializable.- Specified by:
getAliasin interfaceIBaseSiteModule- Parameters:
aliasObject- The object to transform.- Returns:
- A
IAliasobject.
-
getPlugin
Access method to get aIPluginobject from one of the followings: ModuleImpl, java.io.Serializable.- Specified by:
getPluginin interfaceIBaseSiteModule- Parameters:
pluginObject- The object to transform.- Returns:
- A
IPluginobject.
-
getContentContainer
Access method to get aIContentContainerobject from one of the followings: PageImpl, CommonBlockImpl, TemplateImpl, java.io.Serializable.- Specified by:
getContentContainerin interfaceIBaseSiteModule- Parameters:
contentContainerObject- The object to transform.- Returns:
- A
IContentContainerobject.
-
getPageContainer
Access method to get aIPageContainerobject from one of the followings: PageImpl, java.io.Serializable.- Specified by:
getPageContainerin interfaceIBaseSiteModule- Parameters:
pageContainerObject- The object to transform.- Returns:
- A
IPageContainerobject.
-
getBlockTemplateContainer
Access method to get aIBlockTemplateContainerobject from one of the followings: TemplateImpl, java.io.Serializable.- Specified by:
getBlockTemplateContainerin interfaceIBaseSiteModule- Parameters:
blockTemplateContainerObject- The object to transform.- Returns:
- A
IBlockTemplateContainerobject.
-
getContent
Access method to get aIContentobject from one of the followings: ContentVersionImpl, java.io.Serializable.- Specified by:
getContentin interfaceIBaseSiteModule- Parameters:
contentObject- The object to transform.- Returns:
- A
IContentobject.
-
getContentComponent
Access method to get aIContentComponentobject from one of the followings: ContentNodeImpl.- Specified by:
getContentComponentin interfaceIBaseSiteModule- Parameters:
contentComponentObject- The object to transform.- Returns:
- A
IContentComponentobject.
-
getBlock
Access method to get aIBlockobject from one of the followings: BlockImpl, java.io.Serializable.- Specified by:
getBlockin interfaceIBaseSiteModule- Parameters:
blockObject- The object to transform.- Returns:
- A
IBlockobject.
-
getComponent
Access method to get aIComponentobject from one of the followings: ElementImpl.- Specified by:
getComponentin interfaceIBaseSiteModule- Parameters:
componentObject- The object to transform.- Returns:
- A
IComponentobject.
-
getElementByProtocolURI
Gets anIElementobject which implementsIProtocolSupportinterface.- Specified by:
getElementByProtocolURIin interfaceIBaseSiteModule- Parameters:
protocolURI- The protocol URI as a java.lang.String.- Returns:
- A
IProtocolSupportobject. - Throws:
ModuleException- default module exception.
-
getElementByURI
Gets anIElementby its URI.- Specified by:
getElementByURIin interfaceIBaseSiteModule- Parameters:
context- The execution context.uri- The URI as a java.lang.String.- Returns:
- A
IElementobject. - Throws:
ModuleException- default module exception.
-
getExecutionContext
ISiteExecutionContext getExecutionContext()Gets the specific execution context of the current module.- Specified by:
getExecutionContextin interfaceIBaseSiteModule- Returns:
- A
ISiteExecutionContextobject.
-
getFormsComponentsFactory
@Deprecated com.axemble.vdoc.sdk.interfaces.ui.components.IComponentsFactory getFormsComponentsFactory()Deprecated.do not use- Specified by:
getFormsComponentsFactoryin interfaceIBaseSiteModule
-
getFormsDefinitionsFactory
@Deprecated com.axemble.vdoc.sdk.interfaces.ui.definitions.IDefinitionsFactory getFormsDefinitionsFactory()Deprecated.do not use- Specified by:
getFormsDefinitionsFactoryin interfaceIBaseSiteModule
-