com.silverpeas.admin.components
Interface ComponentsInstanciatorIntf

All Known Implementing Classes:

CommentInstanciator, MyLinksInstanciator, TagCloudInstanciator, ThumbnailInstanciator

public interface ComponentsInstanciatorIntf

Interface for the instanciator component class. An instanciator creates and deletes components on a space for a user.

Author:

Joaquim Vieira

Field Summary

static String

PROCESS_XML_FILE_NAME The name of the component descriptor parameter holding the process file name

Method Summary

void	create(Connection connection, String spaceId, String componentId, String userId) Create a new instance of the component for a requested user and space.
void	delete(Connection connection, String spaceId, String componentId, String userId) Delete the component instance created for the user on the requested space.

Field Detail

PROCESS_XML_FILE_NAME

static final String PROCESS_XML_FILE_NAME

The name of the component descriptor parameter holding the process file name

See Also:

Constant Field Values

Method Detail

create

void create(Connection connection,
            String spaceId,
            String componentId,
            String userId)
            throws InstanciationException

Create a new instance of the component for a requested user and space.

Parameters:

connection - - Connection to the database used to save the create information.

spaceId - - Identity of the space where the component will be instancied.

componentId - - Identity of the component to instanciate.

userId - - Identity of the user who want the component

Throws:

InstanciationException

delete

void delete(Connection connection,
            String spaceId,
            String componentId,
            String userId)
            throws InstanciationException

Delete the component instance created for the user on the requested space.

Parameters:

connection - - Connection to the database where the create information will be destroyed.

spaceId - - Identity of the space where the instanced component will be deleted.

componentId - - Identity of the instanced component

userId - - Identity of the user who have instantiate the component.

Throws:

InstanciationException