Package org.ametys.plugins.workspaces.about

Class AboutWorkspaceModule

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.workspaces.AbstractWorkspaceModule

org.ametys.plugins.workspaces.about.AboutWorkspaceModule

All Implemented Interfaces:

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

public class AboutWorkspaceModule
extends AbstractWorkspaceModule

Manager for the About module

Field Summary

Fields

Modifier and Type	Field	Description
protected WorkflowProvider	_workflowProvider	The workflow provider
static final String	ABOUT_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
AboutWorkspaceModule()

Method Summary

Modifier and Type	Method	Description
protected void	_initializeAboutDefaultZone(ModifiablePage aboutPage, Site site, String sitemapName, String title)	Initialize the default zone for the about page
protected void	_initializeAboutPage(ModifiablePage aboutPage, Site site, String sitemapName, String title, Page parentPage)	Initialize the new about page
protected boolean	_showActivatedStatus()	Check if activated status should be shown or not
ModifiableWorkflowAwareContent	createAboutContent(Site site, String sitemapName, String title)	Create the about content
Set<String>	getAllowedEventTypes()	Get the set of allowed event type for the module
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 page)	Initialize the module page
void	service(ServiceManager manager)

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

_createModulePage, _deleteActivities, _deletePages, _getAmetysObject, _getDefaultXslt, _getInternalStatisticModel, _getInternalStatistics, _getModuleLastActivity, _getModulePages, _getModuleSize, _internalActivateModule, _internalDeactivateModule, _internalDeleteData, _setPagesVisibility, _showLastActivity, _showModuleSize, 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, isUnactivatedByDefault

Field Details

ABOUT_MODULE_ID

public static final String ABOUT_MODULE_ID

Avalon ROLE

_workflowProvider

protected WorkflowProvider _workflowProvider

The workflow provider

Constructor Details

AboutWorkspaceModule

public AboutWorkspaceModule()

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

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

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 page)

Description copied from class: AbstractWorkspaceModule

Initialize the module page

Specified by:

initializeModulePage in class AbstractWorkspaceModule

Parameters:

page - The module page

_initializeAboutDefaultZone

protected void _initializeAboutDefaultZone(ModifiablePage aboutPage,
 Site site,
 String sitemapName,
 String title)

Initialize the default zone for the about page

Parameters:

aboutPage - The about page

site - The site

sitemapName - The sitemap name

title - The content title

createAboutContent

public ModifiableWorkflowAwareContent createAboutContent(Site site,
 String sitemapName,
 String title)
                                                  throws com.opensymphony.workflow.WorkflowException

Create the about content

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

_initializeAboutPage

protected void _initializeAboutPage(ModifiablePage aboutPage,
 Site site,
 String sitemapName,
 String title,
 Page parentPage)

Initialize the new about page

Parameters:

aboutPage - The page

site - The site

sitemapName - The sitemap name

title - The page title

parentPage - The parent page

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

_showActivatedStatus

protected boolean _showActivatedStatus()

Description copied from class: AbstractWorkspaceModule

Check if activated status should be shown or not

Overrides:

_showActivatedStatus in class AbstractWorkspaceModule

Returns:

true if activated status should be shown