Package org.ametys.plugins.workspaces.wall

Class WallContentModule

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.workspaces.AbstractWorkspaceModule

org.ametys.plugins.workspaces.wall.WallContentModule

All Implemented Interfaces:

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

public class WallContentModule
extends AbstractWorkspaceModule

Workspace module for wall content

Field Summary

Fields

Modifier and Type	Field	Description
protected WebContentDAO	_contentDAO	The content DAO
protected ContentSearcherFactory	_contentSearcherFactory	The content searcher factory
protected ZoneDAO	_zoneDAO	The zone DAO
protected static final String[]	SEARCH_SERVICE_CONTENT_TYPES	Search service content types
protected static final String[]	SEARCH_SERVICE_CONTEXTS	Search service contexts
protected static final String[]	SEARCH_SERVICE_RETURNABLES	Search service returnables
protected static final String[]	SEARCH_SERVICE_SORTS	Search service sorts
protected static final String	SEARCH_SERVICE_XSLT	Search service xslt
static final String	WALLCONTENT_MODULE_ID	The id of calendar module
static final String	WALLCONTENT_SERVICE_ID	The id of wall content service

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
WallContentModule()

Method Summary

Modifier and Type	Method	Description
protected ModifiablePage	_createModulePage(Project project, Sitemap sitemap, String name, I18nizableText pageTitle, String skinTemplate)	Create a new page if not already exists
protected void	_deletePages(Project project)	Delete the module pages and their related contents
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	_internalDeactivateModule(Project project)	Internal process when module is deactivated
protected void	_internalDeleteData(Project project)	Internal process to delete data
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
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 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
void	service(ServiceManager manager)

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

_deleteActivities, _getAmetysObject, _getDefaultXslt, _getModuleLastActivity, _getModulePages, _internalActivateModule, _setPagesVisibility, _showActivatedStatus, _showLastActivity, activateModule, contextualize, deactivateModule, deleteData, getAllEventTypes, getModulePageTemplate, 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

WALLCONTENT_MODULE_ID

public static final String WALLCONTENT_MODULE_ID

The id of calendar module

WALLCONTENT_SERVICE_ID

public static final String WALLCONTENT_SERVICE_ID

The id of wall content service

See Also:

• Constant Field Values

SEARCH_SERVICE_CONTENT_TYPES

protected static final String[] SEARCH_SERVICE_CONTENT_TYPES

Search service content types

SEARCH_SERVICE_RETURNABLES

protected static final String[] SEARCH_SERVICE_RETURNABLES

Search service returnables

SEARCH_SERVICE_SORTS

protected static final String[] SEARCH_SERVICE_SORTS

Search service sorts

SEARCH_SERVICE_CONTEXTS

protected static final String[] SEARCH_SERVICE_CONTEXTS

Search service contexts

SEARCH_SERVICE_XSLT

protected static final String SEARCH_SERVICE_XSLT

Search service xslt

See Also:

• Constant Field Values

_zoneDAO

protected ZoneDAO _zoneDAO

The zone DAO

_contentDAO

protected WebContentDAO _contentDAO

The content DAO

_contentSearcherFactory

protected ContentSearcherFactory _contentSearcherFactory

The content searcher factory

Constructor Details

WallContentModule

public WallContentModule()

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

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

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

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

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

_createModulePage

protected ModifiablePage _createModulePage(Project project,
 Sitemap sitemap,
 String name,
 I18nizableText pageTitle,
 String skinTemplate)

Description copied from class: AbstractWorkspaceModule

Create a new page if not already exists

Overrides:

_createModulePage in class AbstractWorkspaceModule

Parameters:

project - The module project

sitemap - The sitemap where the page will be created

name - The page's name

pageTitle - The page's title as i18nizable text

skinTemplate - The template from the skin to apply on the page

Returns:

the created page or null if page already exists

_deletePages

protected void _deletePages(Project project)

Description copied from class: AbstractWorkspaceModule

Delete the module pages and their related contents

Overrides:

_deletePages in class AbstractWorkspaceModule

Parameters:

project - The project

_internalDeactivateModule

protected void _internalDeactivateModule(Project project)

Description copied from class: AbstractWorkspaceModule

Internal process when module is deactivated

Overrides:

_internalDeactivateModule in class AbstractWorkspaceModule

Parameters:

project - The project

_internalDeleteData

protected void _internalDeleteData(Project project)

Description copied from class: AbstractWorkspaceModule

Internal process to delete data

Overrides:

_internalDeleteData in class AbstractWorkspaceModule

Parameters:

project - The project

_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