Package org.ametys.plugins.workspaces.minisite

Class MiniSiteWorkspaceModule

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.workspaces.AbstractWorkspaceModule

org.ametys.plugins.workspaces.minisite.MiniSiteWorkspaceModule

All Implemented Interfaces:

Comparable<WorkspaceModule>, WorkspaceModule, LogEnabled, PluginAware, Contextualizable, Serviceable

public class MiniSiteWorkspaceModule
extends AbstractWorkspaceModule

Workspaces module for editorial pages

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentSearcherFactory	_contentSearcherFactory	The content searcher factory
protected WorkflowProvider	_workflowProvider	The workflow provider
static final String	MINISITE_MODULE_ID	Avalon ROLE

Fields inherited from class org.ametys.plugins.workspaces.AbstractWorkspaceModule

__SIZE_ERROR, __SIZE_INACTIVE, _activityStream, _context, _currentUserProvider, _i18nUtils, _modulesEP, _observationManager, _pageDAO, _pluginName, _projectManager, _projectRightHelper, _resolver, _rightManager, _serviceEP, _skinsManager, _userHelper, _userManager

Fields inherited from interface org.ametys.plugins.workspaces.project.modules.WorkspaceModule

GROUP_HEADER_ACTIVATED_ID, GROUP_HEADER_ELEMENTS_ID, GROUP_HEADER_LAST_ACTIVITY_ID, GROUP_HEADER_SIZE_ID, ORDER_ABOUT, ORDER_ALERTS, ORDER_CALENDAR, ORDER_DOCUMENTS, ORDER_MEMBERS, ORDER_MINISITE, ORDER_NEWS, ORDER_TASKS, ORDER_THREADS, ORDER_WALLCONTENT

Constructor Summary

Constructors

Constructor	Description
MiniSiteWorkspaceModule()

Method Summary

Modifier and Type	Method	Description
protected ModifiablePage	_createAndInitializeFirstSectionPage(ModifiablePage modulePage, String name, I18nizableText pageTitle)	Create the first section of minisite if does not exist
protected ModifiableWorkflowAwareContent	_createDefaultContent(Site site, String sitemapName, String title)	Create a new content for a minisite page of the minisite module
List<StatisticColumn>	_getInternalStatisticModel()	Get the headers of statistics
Map<String,Object>	_getInternalStatistics(Project project, boolean isActive)	Get the internal statistics of the module
protected long	_getModuleSize(Project project)	Get the size of module in bytes
protected void	_initializeFirstSectionDefaultZone(ModifiablePage page)	Initialize the default zone for the first section of mini site
protected boolean	_showModuleSize()	Check if module size should be shown or not
Set<String>	getAllowedEventTypes()	Get the set of allowed event type for the module
protected String	getFirstSectionName()	Get the name of the first section of minisite
protected I18nizableText	getFirstSectionTitle()	Get the title of the first section of minisite
String	getId()	Get the module Id
I18nizableText	getModuleDescription()	Get the module title
String	getModuleName()	Get the module name
protected String	getModulePageName()	Returns the module page's name
protected String	getModulePageTemplate()	Returns the template to use for module's page.
protected I18nizableText	getModulePageTitle()	Returns the module page's title as i18n
ModifiableResourceCollection	getModuleRoot(Project project, boolean create)	Get the module root node for the given project
I18nizableText	getModuleTitle()	Get the module title
int	getOrder()	Get the module order
protected void	initializeModulePage(ModifiablePage modulePage)	Initialize the module page
boolean	isUnactivatedByDefault()	Determines if the module is unactivated by default
void	service(ServiceManager manager)

Methods inherited from class org.ametys.plugins.workspaces.AbstractWorkspaceModule

_createModulePage, _deleteActivities, _deletePages, _getAmetysObject, _getDefaultXslt, _getModuleLastActivity, _getModulePages, _internalActivateModule, _internalDeactivateModule, _internalDeleteData, _setPagesVisibility, _showActivatedStatus, _showLastActivity, activateModule, contextualize, deactivateModule, deleteData, getAllEventTypes, getModuleSizeKey, getModuleUrl, getStatisticModel, getStatistics, initializeSitemap, setPluginInfo

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.plugins.workspaces.project.modules.WorkspaceModule

compareTo

Field Details

MINISITE_MODULE_ID

public static final String MINISITE_MODULE_ID

Avalon ROLE

_workflowProvider

protected WorkflowProvider _workflowProvider

The workflow provider

_contentSearcherFactory

protected ContentSearcherFactory _contentSearcherFactory

The content searcher factory

Constructor Details

MiniSiteWorkspaceModule

public MiniSiteWorkspaceModule()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractWorkspaceModule

Throws:

ServiceException

getId

public String getId()

Description copied from interface: WorkspaceModule

Get the module Id

Returns:

The module ID

isUnactivatedByDefault

public boolean isUnactivatedByDefault()

Description copied from interface: WorkspaceModule

Determines if the module is unactivated by default

Returns:

true if the module is not proposed by default

getModuleName

public String getModuleName()

Description copied from interface: WorkspaceModule

Get the module name

Returns:

the module name

getOrder

public int getOrder()

Description copied from interface: WorkspaceModule

Get the module order

Returns:

the priority in menus

getModulePageName

protected String getModulePageName()

Description copied from class: AbstractWorkspaceModule

Returns the module page's name

Specified by:

getModulePageName in class AbstractWorkspaceModule

Returns:

The module page's name

getModuleTitle

public I18nizableText getModuleTitle()

Description copied from interface: WorkspaceModule

Get the module title

Returns:

The title

getModuleDescription

public I18nizableText getModuleDescription()

Description copied from interface: WorkspaceModule

Get the module title

Returns:

The title

getModulePageTitle

protected I18nizableText getModulePageTitle()

Description copied from class: AbstractWorkspaceModule

Returns the module page's title as i18n

Specified by:

getModulePageTitle in class AbstractWorkspaceModule

Returns:

The module page's title

getFirstSectionName

protected String getFirstSectionName()

Get the name of the first section of minisite

Returns:

the section's name

getFirstSectionTitle

protected I18nizableText getFirstSectionTitle()

Get the title of the first section of minisite

Returns:

the section's title

getModulePageTemplate

protected String getModulePageTemplate()

Description copied from class: AbstractWorkspaceModule

Returns the template to use for module's page. Can be null if the page should be a node page

Overrides:

getModulePageTemplate in class AbstractWorkspaceModule

Returns:

The template

initializeModulePage

protected void initializeModulePage(ModifiablePage modulePage)

Description copied from class: AbstractWorkspaceModule

Initialize the module page

Specified by:

initializeModulePage in class AbstractWorkspaceModule

Parameters:

modulePage - The module page

_createAndInitializeFirstSectionPage

protected ModifiablePage _createAndInitializeFirstSectionPage(ModifiablePage modulePage,
 String name,
 I18nizableText pageTitle)

Create the first section of minisite if does not exist

Parameters:

modulePage - the module page

name - the name of section to create

pageTitle - the page title

Returns:

the created page or null if already exist

_initializeFirstSectionDefaultZone

protected void _initializeFirstSectionDefaultZone(ModifiablePage page)

Initialize the default zone for the first section of mini site

Parameters:

page - The first page of minisite

_createDefaultContent

protected ModifiableWorkflowAwareContent _createDefaultContent(Site site,
 String sitemapName,
 String title)
                                                        throws com.opensymphony.workflow.WorkflowException

Create a new content for a minisite page of the minisite module

Parameters:

site - The site

sitemapName - the name of the sitemap

title - The content title

Returns:

The content

Throws:

com.opensymphony.workflow.WorkflowException - if an error occurred

getModuleRoot

public ModifiableResourceCollection getModuleRoot(Project project,
 boolean create)

Description copied from interface: WorkspaceModule

Get the module root node for the given project

Parameters:

project - The project containing the module

create - True to create the node if it does not exists

Returns:

The root node, or null if it does not exists and was not created

getAllowedEventTypes

public Set<String> getAllowedEventTypes()

Description copied from interface: WorkspaceModule

Get the set of allowed event type for the module

Returns:

The set of allowed event types

_getInternalStatistics

public Map<String,Object> _getInternalStatistics(Project project,
 boolean isActive)

Description copied from class: AbstractWorkspaceModule

Get the internal statistics of the module

Overrides:

_getInternalStatistics in class AbstractWorkspaceModule

Parameters:

project - The project

isActive - true if module is active

Returns:

a map of internal statistics

_getInternalStatisticModel

public List<StatisticColumn> _getInternalStatisticModel()

Description copied from class: AbstractWorkspaceModule

Get the headers of statistics

Overrides:

_getInternalStatisticModel in class AbstractWorkspaceModule

Returns:

a list of statistics headers

_getModuleSize

protected long _getModuleSize(Project project)

Description copied from class: AbstractWorkspaceModule

Get the size of module in bytes

Overrides:

_getModuleSize in class AbstractWorkspaceModule

Parameters:

project - The project

Returns:

the size of module in bytes

_showModuleSize

protected boolean _showModuleSize()

Description copied from class: AbstractWorkspaceModule

Check if module size should be shown or not

Overrides:

_showModuleSize in class AbstractWorkspaceModule

Returns:

true if module size should be shown