Class NewsWorkspaceModule
java.lang.Object
org.ametys.runtime.plugin.component.AbstractLogEnabled
org.ametys.plugins.workspaces.AbstractWorkspaceModule
org.ametys.plugins.workspaces.news.NewsWorkspaceModule
- All Implemented Interfaces:
Comparable<WorkspaceModule>
,WorkspaceModule
,LogEnabled
,PluginAware
,Contextualizable
,Serviceable
Workspaces module for news
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The id of calendar modulestatic final String
Name of news's templatestatic final String
The id of news serviceprotected static final String
Search service content viewprotected static final String[]
Search service content typesprotected static final String[]
Search service contextsprotected static final String[]
Search service returnablesprotected static final String[]
Search service sortsprotected static final String
Search service xsltFields 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_FORUMS, ORDER_MEMBERS, ORDER_MINISITE, ORDER_NEWS, ORDER_TASKS, ORDER_WALLCONTENT
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected ModifiablePage
_createModulePage
(Project project, Sitemap sitemap, String name, I18nizableText pageTitle, String skinTemplate) Create a new page if not already existsGet the headers of statistics_getInternalStatistics
(Project project, boolean isActive) Get the internal statistics of the moduleprotected long
_getModuleSize
(Project project) Get the size of module in bytesprotected boolean
Check if activated status should be shown or notprotected boolean
Check if module size should be shown or notGet the set of allowed event type for the modulegetId()
Get the module IdGet the module titleGet the module nameprotected String
Returns the module page's nameprotected String
Returns the template to use for module's page.protected I18nizableText
Returns the module page's title as i18nGet the module titleint
getOrder()
Get the module orderprotected void
initializeModulePage
(ModifiablePage modulePage) Initialize the module pagevoid
service
(ServiceManager smanager) Methods inherited from class org.ametys.plugins.workspaces.AbstractWorkspaceModule
_deleteActivities, _deletePages, _getAmetysObject, _getDefaultXslt, _getModuleLastActivity, _getModulePages, _internalActivateModule, _internalDeactivateModule, _internalDeleteData, _setPagesVisibility, _showLastActivity, activateModule, contextualize, deactivateModule, deleteData, getAllEventTypes, getModuleRoot, 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
-
NEWS_MODULE_ID
The id of calendar module -
NEWS_SERVICE_ID
The id of news service- See Also:
-
NEWS_PAGE_TEMPLATE
Name of news's template- See Also:
-
SEARCH_SERVICE_CONTENT_TYPES
Search service content types -
SEARCH_SERVICE_RETURNABLES
Search service returnables -
SEARCH_SERVICE_SORTS
Search service sorts -
SEARCH_SERVICE_CONTEXTS
Search service contexts -
SEARCH_SEARCH_CONTENT_VIEW
Search service content view- See Also:
-
SEARCH_SERVICE_XSLT
Search service xslt- See Also:
-
-
Constructor Details
-
NewsWorkspaceModule
public NewsWorkspaceModule()
-
-
Method Details
-
service
- Specified by:
service
in interfaceServiceable
- Overrides:
service
in classAbstractWorkspaceModule
- Throws:
ServiceException
-
getId
Description copied from interface:WorkspaceModule
Get the module Id- Returns:
- The module ID
-
getOrder
Description copied from interface:WorkspaceModule
Get the module order- Returns:
- the priority in menus
-
getModuleName
Description copied from interface:WorkspaceModule
Get the module name- Returns:
- the module name
-
getAllowedEventTypes
Description copied from interface:WorkspaceModule
Get the set of allowed event type for the module- Returns:
- The set of allowed event types
-
getModulePageName
Description copied from class:AbstractWorkspaceModule
Returns the module page's name- Specified by:
getModulePageName
in classAbstractWorkspaceModule
- Returns:
- The module page's name
-
getModuleTitle
Description copied from interface:WorkspaceModule
Get the module title- Returns:
- The title
-
getModuleDescription
Description copied from interface:WorkspaceModule
Get the module title- Returns:
- The title
-
getModulePageTitle
Description copied from class:AbstractWorkspaceModule
Returns the module page's title as i18n- Specified by:
getModulePageTitle
in classAbstractWorkspaceModule
- Returns:
- The module page's title
-
_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 classAbstractWorkspaceModule
- Parameters:
project
- The module projectsitemap
- The sitemap where the page will be createdname
- The page's namepageTitle
- The page's title as i18nizable textskinTemplate
- The template from the skin to apply on the page- Returns:
- the created page or
null
if page already exists
-
initializeModulePage
Description copied from class:AbstractWorkspaceModule
Initialize the module page- Specified by:
initializeModulePage
in classAbstractWorkspaceModule
- Parameters:
modulePage
- The module page
-
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 classAbstractWorkspaceModule
- Returns:
- The template
-
_getInternalStatistics
Description copied from class:AbstractWorkspaceModule
Get the internal statistics of the module- Overrides:
_getInternalStatistics
in classAbstractWorkspaceModule
- Parameters:
project
- The projectisActive
- true if module is active- Returns:
- a map of internal statistics
-
_getInternalStatisticModel
Description copied from class:AbstractWorkspaceModule
Get the headers of statistics- Overrides:
_getInternalStatisticModel
in classAbstractWorkspaceModule
- Returns:
- a list of statistics headers
-
_getModuleSize
Description copied from class:AbstractWorkspaceModule
Get the size of module in bytes- Overrides:
_getModuleSize
in classAbstractWorkspaceModule
- Parameters:
project
- The project- Returns:
- the size of module in bytes
-
_showModuleSize
Description copied from class:AbstractWorkspaceModule
Check if module size should be shown or not- Overrides:
_showModuleSize
in classAbstractWorkspaceModule
- Returns:
- true if module size should be shown
-
_showActivatedStatus
Description copied from class:AbstractWorkspaceModule
Check if activated status should be shown or not- Overrides:
_showActivatedStatus
in classAbstractWorkspaceModule
- Returns:
- true if activated status should be shown
-