Package org.ametys.plugins.repository.trash

Interface TrashableAmetysObject

All Superinterfaces:

AmetysObject, JCRAmetysObject, MetadataAwareAmetysObject, ModifiableAmetysObject, 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.

Method Summary

Modifier and Type	Method	Description
TrashElement	moveToTrash()	Move this AmetysObject to the trash.
TrashableAmetysObject	restoreFromTrash()	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.jcr.JCRAmetysObject

getNode

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

needsSave, rename, revertChanges, saveChanges

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()
                                throws UnknownParentException

Restore this AmetysObject from the trash.

Returns:

the restored ametys object

Throws:

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