org.ametys.plugins.repository

Interface CopiableAmetysObject

All Superinterfaces:

AmetysObject

All Known Implementing Classes:

AbstractProgram, AbstractProgramPart, AbstractSurveyElement, AbstractTraversableProgramPart, Container, Course, CourseList, CoursePart, DefaultContent, DefaultPage, DefaultSharedContent, DefaultWebContent, DefaultWorkflowAwareContent, DefaultZone, DefaultZoneItem, JCRResource, JCRResourcesCollection, ModifiableDefaultContent, ModifiableDefaultWebContent, OrgUnit, Person, Program, Site, SubProgram, Survey, SurveyPage, SurveyQuestion

public interface CopiableAmetysObject
extends AmetysObject

Copiable AmetysObject.

Method Summary

Modifier and Type	Method and Description
AmetysObject	copyTo(ModifiableTraversableAmetysObject parent, String name) Copy the current AmetysObject to the given object.
AmetysObject	copyTo(ModifiableTraversableAmetysObject parent, String name, List<String> restrictTo) Copy the current AmetysObject to the given object if it is not in the restriction list.

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

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

Method Detail

copyTo

AmetysObject copyTo(ModifiableTraversableAmetysObject parent,
                    String name)
             throws AmetysRepositoryException

Copy the current AmetysObject to the given object. Be careful, this method save changes.

Parameters:

parent - The parent of the new object. Can not be null.

name - Name of the new object. Can be null. If null, the new name will be get from the copied object

Returns:

the created object

Throws:

AmetysRepositoryException - if an error occurs.

copyTo

AmetysObject copyTo(ModifiableTraversableAmetysObject parent,
                    String name,
                    List<String> restrictTo)
             throws AmetysRepositoryException

Copy the current AmetysObject to the given object if it is not in the restriction list. Be careful, this method save changes.

Parameters:

parent - The parent of the new object. Can not be null.

name - Name of the new object. Can be null. If null, the new name will be get from the copied object

restrictTo - A restrict list of CopiableAmetysObject authorized to be copied

Returns:

the created object

Throws:

AmetysRepositoryException - if an error occurs.