Package org.ametys.odf.helper

Class DeleteODFContentHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.odf.helper.DeleteODFContentHelper

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class DeleteODFContentHelper
extends AbstractLogEnabled
implements Component, Serviceable

Helper to delete an ODF content.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DeleteODFContentHelper.DeleteMode	Enumeration for the mode of deletion

Field Summary

Fields

Modifier and Type	Field	Description
static String	ROLE	Avalon role.

Constructor Summary

Constructors

Constructor	Description
DeleteODFContentHelper()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	deleteContents(List<String> contentsId, String modeParam)	Delete ODF contents
Map<String,Object>	deleteContents(List<String> contentsId, String modeParam, boolean ignoreRights)	Delete ODF contents
Map<String,Object>	deleteContentsWithLog(List<String> contentsId, String modeParam)	Delete ODF contents
Map<String,Object>	deleteContentsWithLog(List<String> contentsId, String modeParam, boolean ignoreRights)	Delete ODF contents
boolean	hasRight(Content content)	Determines if the user has sufficient right for the given content
boolean	isContentReferenced(Content content)	Test if content is still referenced before removing it
void	service(ServiceManager manager)

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

Field Detail

ROLE

public static final String ROLE

Avalon role.

Constructor Detail

DeleteODFContentHelper

public DeleteODFContentHelper()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

deleteContents

public Map<String,Object> deleteContents(List<String> contentsId,
                                               String modeParam)

Delete ODF contents

Parameters:

contentsId - The ids of contents to delete

modeParam - The mode of deletion

Returns:

the deleted and undeleted contents

deleteContents

public Map<String,Object> deleteContents(List<String> contentsId,
                                               String modeParam,
                                               boolean ignoreRights)

Delete ODF contents

Parameters:

contentsId - The ids of contents to delete

modeParam - The mode of deletion

ignoreRights - If true, bypass the rights check during the deletion

Returns:

the deleted and undeleted contents

deleteContentsWithLog

public Map<String,Object> deleteContentsWithLog(List<String> contentsId,
                                                      String modeParam)

Delete ODF contents

Parameters:

contentsId - The ids of contents to delete

modeParam - The mode of deletion

Returns:

the deleted and undeleted contents

deleteContentsWithLog

public Map<String,Object> deleteContentsWithLog(List<String> contentsId,
                                                      String modeParam,
                                                      boolean ignoreRights)

Delete ODF contents

Parameters:

contentsId - The ids of contents to delete

modeParam - The mode of deletion

ignoreRights - If true, bypass the rights check during the deletion

Returns:

the deleted and undeleted contents

isContentReferenced

public boolean isContentReferenced(Content content)

Test if content is still referenced before removing it

Parameters:

content - The content to remove

Returns:

true if content is still referenced

hasRight

public boolean hasRight(Content content)

Determines if the user has sufficient right for the given content

Parameters:

content - the content

Returns:

true if user has sufficient right