lumis.portal.deployment

Class BusinessContextRegisterHelper

java.lang.Object

lumis.portal.deployment.BusinessContextRegisterHelper

public class BusinessContextRegisterHelper
extends Object

Helper that handles business context registration in a module.

Since:

7.1.0

Version:

$Revision: 16236 $ $Date: 2014-03-27 16:15:46 -0300 (Thu, 27 Mar 2014) $

Constructor Summary

Constructors

Constructor and Description
BusinessContextRegisterHelper(IComponent component)
BusinessContextRegisterHelper(IModule module)

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	findComponentItemDefinitionIds(IComponent component, File componentArchive) Returns the list of definitions ids in a component.
List<String>	findModuleItemDefinitionIds(File moduleArchive) Returns the list of definitions ids in a module.
protected boolean	isAvailable(SessionConfig sessionConfig, String definitionId, ITransaction transaction) Indicates whether a definition item is still available.
void	registerComponentDefinitions(IComponent component) Register the definitions in a component.
void	registerModuleDefinitions() Register the definitions in a module.
void	unregisterComponentDefinitions(IComponent component) Unregister the definitions in a component.
void	unregisterModuleDefinitions() Unregister the definitions in a module.

Methods inherited from class java.lang.Object

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

Constructor Detail

BusinessContextRegisterHelper

public BusinessContextRegisterHelper(IModule module)

BusinessContextRegisterHelper

public BusinessContextRegisterHelper(IComponent component)

Method Detail

isAvailable

protected boolean isAvailable(SessionConfig sessionConfig,
                  String definitionId,
                  ITransaction transaction)
                       throws PortalException

Indicates whether a definition item is still available. This method is called before calling unregister(SessionConfig, String, ITransaction) so only items no longer available will be unregistered.

Parameters:

sessionConfig - user session information.

definitionId - the definition identifier, as returned by findComponentItemDefinitionIds(IComponent, File) or findModuleItemDefinitionIds(File).

transaction - transaction for persistence access.

Returns:

true if the item is still available and must not be unregistered, false otherwise.

Throws:

PortalException

findModuleItemDefinitionIds

public List<String> findModuleItemDefinitionIds(File moduleArchive)
                                         throws PortalException

Returns the list of definitions ids in a module.

Parameters:

moduleArchive - the module archive.

Returns:

a list containing the definitions ids of the given module.

Throws:

PortalException - if any error occurs during the process.

findComponentItemDefinitionIds

public List<String> findComponentItemDefinitionIds(IComponent component,
                                          File componentArchive)
                                            throws PortalException

Returns the list of definitions ids in a component.

Parameters:

component - the component.

Returns:

a list containing the definitions ids of the given component.

Throws:

PortalException - if any error occurs during the process.

registerModuleDefinitions

public void registerModuleDefinitions()
                               throws PortalException

Register the definitions in a module.

Parameters:

module - the module.

Throws:

PortalException - if any error occurs during the process.

Since:

7.1.0

registerComponentDefinitions

public void registerComponentDefinitions(IComponent component)
                                  throws PortalException

Register the definitions in a component.

Parameters:

component - the component.

Throws:

PortalException - if any error occurs during the process.

Since:

7.1.0

unregisterModuleDefinitions

public void unregisterModuleDefinitions()
                                 throws PortalException

Unregister the definitions in a module.

Parameters:

module - the module.

Throws:

PortalException - if any error occurs during the process.

Since:

7.1.0

unregisterComponentDefinitions

public void unregisterComponentDefinitions(IComponent component)
                                    throws PortalException

Unregister the definitions in a component.

Parameters:

component - the component.

Throws:

PortalException - if any error occurs during the process.

Since:

7.1.0