org.ametys.plugins.repository.data.holder

Interface ModifiableDataHolder

All Superinterfaces:

DataHolder

All Known Subinterfaces:

CommentableContent, ModifiableComposite, ModifiableContent, ModifiableModelAwareDataAwareAmetysObject, ModifiableModelAwareDataHolder, ModifiableModelLessDataAwareAmetysObject, ModifiableModelLessDataHolder, ModifiablePage, ModifiableRepeaterEntry, ModifiableWebContent, ModifiableWorkflowAwareContent, ModifiableZone, ModifiableZoneItem

All Known Implementing Classes:

AbstractProgram, AbstractProgramPart, AbstractTraversableProgramPart, Container, ContentValue, Course, CourseList, CoursePart, DefaultModifiableModelAwareDataHolder, DefaultModifiableModelLessDataHolder, DefaultPage, DefaultZone, DefaultZoneItem, JCRProjectMember, ModifiableDefaultContent, ModifiableDefaultWebContent, ModifiableModelAwareComposite, ModifiableModelAwareRepeaterEntry, ModifiableModelLessComposite, ModifiableModelLessRepeaterEntry, OrgUnit, Person, Program, Project, ProjectCategory, Site, SubProgram

public interface ModifiableDataHolder
extends DataHolder

Interface for modifiable data containers

Method Summary

Modifier and Type	Method and Description
ModifiableComposite	getComposite(String compositePath) Retrieves the composite at the given path
ModifiableComposite	getComposite(String compositePath, boolean createNew) Retrieves the composite at the given path
ModifiableRepeater	getRepeater(String repeaterPath) Retrieves the repeater at the given path
ModifiableRepeater	getRepeater(String repeaterPath, boolean createNew) Retrieves the repeater at the given path
void	removeValue(String dataPath) Removes the value of the data stored in the repository at the given path

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

copyTo, dataToSAX, dataToSAX, dataToSAX, dataToSAX, getDataNames, hasValue, toSAX, toSAX

Method Detail

getComposite

ModifiableComposite getComposite(String compositePath)
                          throws IllegalArgumentException,
                                 BadItemTypeException

Description copied from interface: DataHolder

Retrieves the composite at the given path

Specified by:

getComposite in interface DataHolder

Parameters:

compositePath - path of the composite to retrieve

Returns:

the composite or null if not exists

Throws:

IllegalArgumentException - if the given composite path is null or empty

BadItemTypeException - if the value stored in the repository at the given path is not a composite

getRepeater

ModifiableRepeater getRepeater(String repeaterPath)
                        throws IllegalArgumentException,
                               BadItemTypeException

Description copied from interface: DataHolder

Retrieves the repeater at the given path

Specified by:

getRepeater in interface DataHolder

Parameters:

repeaterPath - path of the repeater to retrieve

Returns:

the repeater or null if not exists

Throws:

IllegalArgumentException - if the given repeater path is null or empty

BadItemTypeException - if the value stored in the repository at the given path is not a repeater

getComposite

ModifiableComposite getComposite(String compositePath,
                                 boolean createNew)
                          throws IllegalArgumentException,
                                 BadItemTypeException

Retrieves the composite at the given path

Parameters:

compositePath - path of the composite to retrieve

createNew - true to create the composite if it does not exist, false otherwise

Returns:

the composite

Throws:

IllegalArgumentException - if the given composite path is null or empty

BadItemTypeException - if the value stored in the repository at the given path is not a composite

getRepeater

ModifiableRepeater getRepeater(String repeaterPath,
                               boolean createNew)
                        throws IllegalArgumentException,
                               BadItemTypeException

Retrieves the repeater at the given path

Parameters:

repeaterPath - path of the repeater to retrieve

createNew - true to create the repeater if it does not exist, false otherwise

Returns:

the repeater

Throws:

IllegalArgumentException - if the given repeater path is null or empty

BadItemTypeException - if the value stored in the repository at the given path is not a repeater

removeValue

void removeValue(String dataPath)
          throws IllegalArgumentException,
                 UnknownDataException

Removes the value of the data stored in the repository at the given path

Parameters:

dataPath - path of the data

Throws:

IllegalArgumentException - if the given data path is null or empty

UnknownDataException - if the value at the given data path does not exist