org.ametys.plugins.repository.data.ametysobject

Interface DataAwareAmetysObject

All Superinterfaces:

AmetysObject, DataHolder

All Known Subinterfaces:

CommentableContent, Content, MetadataAwarePagesContainer, ModelAwareDataAwareAmetysObject, ModelLessDataAwareAmetysObject, ModifiableContent, ModifiableModelAwareDataAwareAmetysObject, ModifiableModelLessDataAwareAmetysObject, ModifiablePage, ModifiableWebContent, ModifiableWorkflowAwareContent, ModifiableZone, ModifiableZoneItem, Page, SharedContent, WebContent, WorkflowAwareContent, Zone, ZoneItem

All Known Implementing Classes:

AbstractBlogPage, AbstractLevelPage, AbstractOdfPage, AbstractProgram, AbstractProgramPart, AbstractTraversableProgramPart, Container, Course, CourseList, CoursePage, CoursePart, CourseZone, CourseZoneItem, DefaultContent, DefaultPage, DefaultSharedContent, DefaultWebContent, DefaultWorkflowAwareContent, DefaultZone, DefaultZoneItem, FirstLevelPage, FirstLevelZone, FirstLevelZoneItem, JCRProjectMember, ModifiableDefaultContent, ModifiableDefaultWebContent, OrgUnit, OrgUnitPage, OrgUnitZone, OrgUnitZoneItem, Person, PostListZone, PostListZoneItem, PostZone, PostZoneItem, Program, ProgramPage, ProgramZone, ProgramZoneItem, Project, ProjectCategory, RedirectPage, SecondLevelPage, SecondLevelZone, SecondLevelZoneItem, Site, Sitemap, StaticZone, StaticZoneItem, SubProgram, TransitionalPage, TransitionalZone, TransitionalZoneItem, UGCPage, UGCTransitionalPage, UGCTransitionalZone, UGCTransitionalZoneItem, UGCZone, UGCZoneItem, UserPage, UserZone, UserZoneItem, VirtualMonthPage, VirtualPostPage, VirtualPostsPage, VirtualTagPage, VirtualTagsPage, VirtualYearPage, VirtualYearsPage

public interface DataAwareAmetysObject
extends AmetysObject, DataHolder

AmetysObject that can handle data.

Method Summary

Modifier and Type	Method and Description
default void	copyTo(ModifiableDataHolder dataHolder) Copies the current DataHolder to the given ModifiableModelAwareDataHolder.
DataHolder	getDataHolder() Returns the DataHolder of this AmetysObject.
default Collection<String>	getDataNames() Retrieves the names of data contained by this data holder
default boolean	hasValue(String dataPath) Checks if there is a value for the data at the given path

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

dataToSAX, dataToSAX, dataToSAX, dataToSAX, getComposite, getRepeater, toSAX, toSAX

Method Detail

getDataHolder

DataHolder getDataHolder()

Returns the DataHolder of this AmetysObject.

Returns:

the DataHolder of this AmetysObject

hasValue

default boolean hasValue(String dataPath)
                  throws IllegalArgumentException

Description copied from interface: DataHolder

Checks if there is a value for the data at the given path

Specified by:

hasValue in interface DataHolder

Parameters:

dataPath - path of the data

Returns:

true if there is value for the data, false otherwise

Throws:

IllegalArgumentException - if the given data path is null or empty

getDataNames

default Collection<String> getDataNames()

Description copied from interface: DataHolder

Retrieves the names of data contained by this data holder

Specified by:

getDataNames in interface DataHolder

Returns:

the paths of all data contained by this data holder

copyTo

default void copyTo(ModifiableDataHolder dataHolder)
             throws UndefinedItemPathException,
                    BadItemTypeException,
                    UnknownTypeException,
                    NotUniqueTypeException

Description copied from interface: DataHolder

Copies the current DataHolder to the given ModifiableModelAwareDataHolder.

Specified by:

copyTo in interface DataHolder

Parameters:

dataHolder - The destination dataHolder. Can not be null.

Throws:

UndefinedItemPathException - if one of the copied data is not defined by the model of the destination ModifiableModelAwareDataHolder

BadItemTypeException - if the type defined by the model of the destination ModifiableModelAwareDataHolder doesn't match the copied value

UnknownTypeException - if there is no available type compatible with the copied value for the type extension point of the destination ModifiableModelLessDataHolder

NotUniqueTypeException - if there is more than one available types compatibles with the copied value for the type extension point of the destination ModifiableModelLessDataHolder