Package org.ametys.cms.trash

Class TrashManager

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.cms.trash.TrashManager

All Implemented Interfaces:

LogEnabled, Component, Contextualizable, Serviceable

public class TrashManager
extends AbstractLogEnabled
implements Component, Serviceable, Contextualizable

Trash manager to search in the trash, empty the trash, restore or delete objects from the trash.

Field Summary

Fields

Modifier and Type	Field	Description
protected Context	_context	The avalon context
protected TrashElementTypeExtensionPoint	_trashElementTypeEP	The trash element type extension point
static final String	ROLE	The avalon role

Constructor Summary

Constructors

Constructor	Description
TrashManager()

Method Summary

Modifier and Type	Method	Description
void	contextualize(Context context)
void	delete(String trashElementId)	Delete definitively an object from the trash.
void	empty()	Empty the trash.
Map<String,Object>	getSearchModel()	Get the search model for trash tool.
Map<String,Object>	restore(String trashElementId)	Restore an AmetysObject from the trash
Map<String,Object>	search(Map<String,Object> jsonParams)	Search trash elements from criteria and facets, and taking account of sorting, grouping and pagination.
void	service(ServiceManager serviceManager)

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 Details

ROLE

public static final String ROLE

The avalon role

_context

protected Context _context

The avalon context

_trashElementTypeEP

protected TrashElementTypeExtensionPoint _trashElementTypeEP

The trash element type extension point

Constructor Details

TrashManager

public TrashManager()

Method Details

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

getSearchModel

public Map<String,Object> getSearchModel()

Get the search model for trash tool.

Returns:

The search model as JSON

search

public Map<String,Object> search(Map<String,Object> jsonParams)
                          throws Exception

Search trash elements from criteria and facets, and taking account of sorting, grouping and pagination.

Parameters:

jsonParams - The JSON parameters of the search

Returns:

The search results as JSON

Throws:

Exception - if an exception occurs

empty

public void empty()
           throws javax.jcr.RepositoryException

Empty the trash.

Throws:

javax.jcr.RepositoryException - if an error occurs

restore

public Map<String,Object> restore(String trashElementId)

Restore an AmetysObject from the trash

Parameters:

trashElementId - The trash element identifier

Returns:

true if it has been restored

delete

public void delete(String trashElementId)
            throws Exception

Delete definitively an object from the trash.

Parameters:

trashElementId - The trash element identifier

Throws:

Exception - if an error occurs