Package org.ametys.plugins.ugc.clientsideelement

Class UGCContentModerationClientSideElement

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.ui.StaticFileImportsClientSideElement

org.ametys.core.ui.StaticClientSideElement

org.ametys.plugins.ugc.clientsideelement.UGCContentModerationClientSideElement

All Implemented Interfaces:

ClientSideElement, LogEnabled, PluginAware, Configurable, Serviceable

public class UGCContentModerationClientSideElement
extends StaticClientSideElement

Client side element for UGC content moderation

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.core.ui.ClientSideElement

ClientSideElement.Script, ClientSideElement.ScriptFile

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentWorkflowHelper	_contentWorkflowHelper	The content workflow helper
protected ObservationManager	_observationManager	The observation manager
protected PageDAO	_pageDAO	The page DAO
protected AmetysObjectResolver	_resolver	The Ametys resolver
protected SiteManager	_siteManager	The site manager
protected SkinsManager	_skinsManager	The skins manager

Fields inherited from class org.ametys.core.ui.StaticFileImportsClientSideElement

_currentUserProvider, _dependencies, _featureName, _id, _pluginName, _rightManager, _rights, _rightsMode, _script

Constructor Summary

Constructors

Constructor	Description
UGCContentModerationClientSideElement()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	acceptUGCContent(List<String> contentIds, String targetContentType, String targetWorkflowName, int initActionId, String mode, String pageId)	Accept a UGC content
protected Content	createContent(Content initialContent, String workflowName, int actionId, String cTypeId)	Create the content from the proposed content
protected ModifiablePage	createPage(String parentId, DefaultWebContent content)	Create page under a parent page
protected void	deleteContent(Content content)	Delete the content
protected String	getZoneName(Page page)	Get the name of zone where to insert content
Map<String,Object>	refuseUGCContent(List<String> contentIds, String comment, boolean withNotification)	Refuse UGC content
void	service(ServiceManager smanager)

Methods inherited from class org.ametys.core.ui.StaticClientSideElement

_configureClass, _configureParameters, _configureScript, configureInitialParameters

Methods inherited from class org.ametys.core.ui.StaticFileImportsClientSideElement

_configureDependencies, _configureImports, _configureRights, _configureRightsMode, configure, getDependencies, getId, getPluginName, getRights, getScripts, getScripts, hasRight, setPluginInfo, toString

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, wait, wait, wait

Field Details

_resolver

protected AmetysObjectResolver _resolver

The Ametys resolver

_pageDAO

protected PageDAO _pageDAO

The page DAO

_siteManager

protected SiteManager _siteManager

The site manager

_skinsManager

protected SkinsManager _skinsManager

The skins manager

_observationManager

protected ObservationManager _observationManager

The observation manager

_contentWorkflowHelper

protected ContentWorkflowHelper _contentWorkflowHelper

The content workflow helper

Constructor Details

UGCContentModerationClientSideElement

public UGCContentModerationClientSideElement()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class StaticFileImportsClientSideElement

Throws:

ServiceException

acceptUGCContent

public Map<String,Object> acceptUGCContent(List<String> contentIds,
 String targetContentType,
 String targetWorkflowName,
 int initActionId,
 String mode,
 String pageId)
                                    throws ProcessingException

Accept a UGC content

Parameters:

contentIds - The id of UGC contents

targetContentType - The id of target content type. Can be null or empty to not change content type

targetWorkflowName - The workflow name for contents to create

initActionId - The id of workflow init action

mode - The insertion mode ('new' to insert contents in a new page, 'affect' to insert contents on a existing page or 'none' to keep content as orphan).

pageId - The page id. Can be null for mode 'none'

Returns:

the result

Throws:

ProcessingException - if failed to transform UGC contents

refuseUGCContent

public Map<String,Object> refuseUGCContent(List<String> contentIds,
 String comment,
 boolean withNotification)
                                    throws ProcessingException

Refuse UGC content

Parameters:

contentIds - The id of UGC contents to refuse

comment - The reject's comment

withNotification - True to notify UGC author of the refuse

Returns:

the result

Throws:

ProcessingException - if failed to transform UGC contents

createPage

protected ModifiablePage createPage(String parentId,
 DefaultWebContent content)

Create page under a parent page

Parameters:

parentId - the parent page id or empty for the sitemap root

content - the UGC content

Returns:

the new created page

getZoneName

protected String getZoneName(Page page)

Get the name of zone where to insert content

Parameters:

page - The page

Returns:

the zone's name

createContent

protected Content createContent(Content initialContent,
 String workflowName,
 int actionId,
 String cTypeId)
                         throws com.opensymphony.workflow.WorkflowException

Create the content from the proposed content

Parameters:

initialContent - The initial content

workflowName - the workflow name

actionId - The init action id

cTypeId - the content type

Returns:

the created content

Throws:

com.opensymphony.workflow.WorkflowException - if failed to create content

deleteContent

protected void deleteContent(Content content)

Delete the content

Parameters:

content - the content to delete