Package org.ametys.plugins.repository.trash

Interface TrashableAmetysObject

All Superinterfaces:

AmetysObject, DataHolder, JCRAmetysObject, MetadataAwareAmetysObject, ModifiableAmetysObject, ModifiableDataHolder, ModifiableMetadataAwareAmetysObject, RemovableAmetysObject

All Known Implementing Classes:

AbstractProgram, AbstractProgramPart, AbstractTraversableProgramPart, Container, Course, CourseList, CoursePart, DefaultPage, File, Folder, JCRResource, JCRResourcesCollection, ModifiableDefaultContent, ModifiableDefaultWebContent, OrgUnit, Person, Program, SubProgram

public interface TrashableAmetysObject
extends JCRAmetysObject

AmetysObject which can be moved to trash or restored.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	TrashableAmetysObject.MergeComputationMode	Mode of computation for the name if it already exists in JCR.

Method Summary

Modifier and Type	Method	Description
TrashElement	moveToTrash()	Move this AmetysObject to the trash.
TrashableAmetysObject	restoreFromTrash(TrashableAmetysObject.MergeComputationMode mergeComputationMode)	Restore this AmetysObject from the trash.

Methods inherited from interface org.ametys.plugins.repository.AmetysObject

equals, getId, getName, getParent, getParentPath, getPath, hashCode

Methods inherited from interface org.ametys.plugins.repository.data.holder.DataHolder

copyTo, copyTo, dataToJSON, dataToJSON, dataToJSON, dataToJSON, dataToSAX, dataToSAX, dataToSAX, dataToSAX, getDataNames, getModelItemTypeExtensionPoint, getType, getValue, getValueOfType, getValueOfTypeOrDefault, getValueOrDefault, hasDifferences, hasValue, hasValue, hasValueOrEmpty, isMultiple, isMultiple

Methods inherited from interface org.ametys.plugins.repository.jcr.JCRAmetysObject

getNode

Methods inherited from interface org.ametys.plugins.repository.ModifiableAmetysObject

needsSave, rename, revertChanges, saveChanges

Methods inherited from interface org.ametys.plugins.repository.data.holder.ModifiableDataHolder

getComposite, getComposite, getParentDataHolder, getRepositoryData, getRootDataHolder, removeValue, setValue, setValue, synchronizeValues

Methods inherited from interface org.ametys.plugins.repository.metadata.ModifiableMetadataAwareAmetysObject

getMetadataHolder

Methods inherited from interface org.ametys.plugins.repository.RemovableAmetysObject

remove

Method Details

moveToTrash

TrashElement moveToTrash()

Move this AmetysObject to the trash.

Returns:

the created trash element that represents the object in the trash

restoreFromTrash

TrashableAmetysObject restoreFromTrash(TrashableAmetysObject.MergeComputationMode mergeComputationMode)
                                throws UnknownParentException,
ConflictingNameException

Restore this AmetysObject from the trash.

Parameters:

mergeComputationMode - the merge computation mode, used to know how to behave when restoring an existing element. May be null, as all implementations may not use it.

Returns:

the restored ametys object

Throws:

UnknownParentException - if it's not possible to determine a location to restore the object

ConflictingNameException - if there is a conflict between restored element or on of child element with existing element