org.ametys.plugins.userdirectory

Class DeleteOrgUnitComponent

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.userdirectory.DeleteOrgUnitComponent

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class DeleteOrgUnitComponent
extends AbstractLogEnabled
implements Component, Serviceable

Delete orgunit component

Field Summary

Fields

Modifier and Type	Field and Description
protected ContentWorkflowHelper	_contentWorkflowHelper The Content workflow helper
protected CurrentUserProvider	_currentUserProvider The current user provider
protected ObservationManager	_observationManager The observation manager
protected OrganisationChartPageHandler	_oCPageHandler The organisation chart page handler
private static int	_REMOVE_REFERENCE_DEFAULT_ACTION_ID
protected AmetysObjectResolver	_resolver The Ametys object resolver
protected SmartContentClientSideElementHelper	_smartHelper Helper for smart content client elements
protected SolrIndexer	_solrIndexer The Solr indexer.
static String	ROLE The avalon role.

Constructor Summary

Constructors

Constructor and Description
DeleteOrgUnitComponent()

Method Summary

Modifier and Type	Method and Description
private void	_applyChanges(WorkflowAwareContent content, int actionId)
protected boolean	_canDeleteContent(Content content, Map<String,Object> results, Map<String,String> rights) True if we can delete the content (check if removable, rights and if locked)
private boolean	_checkChildrenBeforeDeletion(Content contentToCheck, Map<String,Object> results, Map<String,String> rights) Browse children to check if deletion could succeed
protected boolean	_checkParentBeforeDeletion(Content content, Map<String,Object> results) True if the parent content is not locked
protected void	_commitAllChanges() Commit all changes in solr
private void	_finalizeDeleteContents(Set<String> contentIdsToDelete, ModifiableAmetysObject parent, Map<String,Object> results) Finalize the deletion of contents.
protected Set<String>	_getChildrenIdToDelete(Content orgUnit, Map<String,Object> results, Map<String,String> rights) Get the id of children to be deleted.
protected Map<String,Object>	_getEventParametersForDeletion(Content content) Get parameters for content deleted Event
protected boolean	_hasRight(Content content, Map<String,String> rights) Determines if the user has sufficient right for the given content
protected boolean	_isLocked(Content content) Determines if the content is locked
protected boolean	_removeRelation(WorkflowAwareContent contentToEdit, Content refContentToRemove, String metadataName, int actionId, Map<String,Object> results) Remove the relation parent-child relation on content.
protected boolean	checkBeforeDeletion(Content content, Map<String,Object> results, Map<String,String> rights) Check that deletion can be performed without blocking errors
protected void	deleteContent(Content content, Map<String,Object> results, Map<String,Object> parameters, Map<String,String> rights) Delete one content
Map<String,Object>	deleteContents(List<String> contentsId, Map<String,Object> parameters, Map<String,String> rights) Delete orgUnits contents
protected void	deleteOrgUnit(Content orgUnit, Map<String,Object> results, Map<String,String> rights) Delete one orgUnit
void	service(ServiceManager smanager)

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

The avalon role.

_REMOVE_REFERENCE_DEFAULT_ACTION_ID

private static final int _REMOVE_REFERENCE_DEFAULT_ACTION_ID

See Also:

Constant Field Values

_oCPageHandler

protected OrganisationChartPageHandler _oCPageHandler

The organisation chart page handler

_contentWorkflowHelper

protected ContentWorkflowHelper _contentWorkflowHelper

The Content workflow helper

_solrIndexer

protected SolrIndexer _solrIndexer

The Solr indexer.

_resolver

protected AmetysObjectResolver _resolver

The Ametys object resolver

_observationManager

protected ObservationManager _observationManager

The observation manager

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

_smartHelper

protected SmartContentClientSideElementHelper _smartHelper

Helper for smart content client elements

Constructor Detail

DeleteOrgUnitComponent

public DeleteOrgUnitComponent()

Method Detail

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

deleteContents

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

Delete orgUnits contents

Parameters:

contentsId - The ids of contents to delete

parameters - the additional parameters

rights - the map of rights id with its prefix

Returns:

the deleted and undeleted contents

deleteContent

protected void deleteContent(Content content,
                             Map<String,Object> results,
                             Map<String,Object> parameters,
                             Map<String,String> rights)

Delete one content

Parameters:

content - the content to delete

results - the results map

rights - the map of rights id with its prefix

parameters - the additional parameters

deleteOrgUnit

protected void deleteOrgUnit(Content orgUnit,
                             Map<String,Object> results,
                             Map<String,String> rights)

Delete one orgUnit

Parameters:

orgUnit - the orgUnit to delete

rights - the map of rights id with its prefix

results - the results map

_getChildrenIdToDelete

protected Set<String> _getChildrenIdToDelete(Content orgUnit,
                                             Map<String,Object> results,
                                             Map<String,String> rights)

Get the id of children to be deleted. All children shared with other contents which are not part of deletion, will be not deleted.

Parameters:

orgUnit - The orgunit to delete

results - The results

rights - the map of rights id with its prefix

Returns:

The id of contents to be deleted

_finalizeDeleteContents

private void _finalizeDeleteContents(Set<String> contentIdsToDelete,
                                     ModifiableAmetysObject parent,
                                     Map<String,Object> results)

Finalize the deletion of contents. Call observers and remove contents

Parameters:

contentIdsToDelete - the list of content id to delete

parent - the jcr parent for saving changes

results - the results map

checkBeforeDeletion

protected boolean checkBeforeDeletion(Content content,
                                      Map<String,Object> results,
                                      Map<String,String> rights)

Check that deletion can be performed without blocking errors

Parameters:

content - The initial content to delete

results - The results

rights - the map of rights id with its prefix

Returns:

true if the deletion can be performed

_canDeleteContent

protected boolean _canDeleteContent(Content content,
                                    Map<String,Object> results,
                                    Map<String,String> rights)

True if we can delete the content (check if removable, rights and if locked)

Parameters:

content - the content

results - the results map

rights - the map of rights id with its prefix

Returns:

true if we can delete the content

_checkParentBeforeDeletion

protected boolean _checkParentBeforeDeletion(Content content,
                                             Map<String,Object> results)

True if the parent content is not locked

Parameters:

content - the content

results - the results map

Returns:

true if the parent content is not locked

_checkChildrenBeforeDeletion

private boolean _checkChildrenBeforeDeletion(Content contentToCheck,
                                             Map<String,Object> results,
                                             Map<String,String> rights)

Browse children to check if deletion could succeed

Parameters:

contentToCheck - The current content to check

results - The result

rights - the map of rights id with its prefix

Returns:

true if the deletion can be processed

_removeRelation

protected boolean _removeRelation(WorkflowAwareContent contentToEdit,
                                  Content refContentToRemove,
                                  String metadataName,
                                  int actionId,
                                  Map<String,Object> results)

Remove the relation parent-child relation on content.

Parameters:

contentToEdit - The content to modified

refContentToRemove - The referenced content to be removed from content

metadataName - The name of metadata holding the child or parent relationship

actionId - The id of workflow action to edit the relation

results - the results map

Returns:

boolean true if remove relation successfully

_applyChanges

private void _applyChanges(WorkflowAwareContent content,
                           int actionId)
                    throws com.opensymphony.workflow.WorkflowException

Throws:

com.opensymphony.workflow.WorkflowException

_getEventParametersForDeletion

protected Map<String,Object> _getEventParametersForDeletion(Content content)

Get parameters for content deleted Event

Parameters:

content - the removed content

Returns:

the event's parameters

_commitAllChanges

protected void _commitAllChanges()

Commit all changes in solr

_isLocked

protected boolean _isLocked(Content content)

Determines if the content is locked

Parameters:

content - the content

Returns:

true if the content is locked

_hasRight

protected boolean _hasRight(Content content,
                            Map<String,String> rights)

Determines if the user has sufficient right for the given content

Parameters:

content - the content

rights - the map of rights id with its prefix

Returns:

true if user has sufficient right