Package org.ametys.plugins.repository.data.ametysobject

Interface ModelAwareDataAwareAmetysObject

All Superinterfaces:

AmetysObject, DataAwareAmetysObject, DataHolder, ModelAwareDataHolder

All Known Subinterfaces:

CalendarResource, CommentableContent, Content, ModelAwareJCRAmetysObject, ModifiableCalendar, ModifiableCalendarEvent, ModifiableContent, ModifiableModelAwareDataAwareAmetysObject, ModifiableWebContent, ModifiableWorkflowAwareContent, ProgramPart, SharedContent, Task, TasksList, TraversableProgramPart, WebContent, WorkflowAwareContent

All Known Implementing Classes:

AbstractProgram, AbstractProgramPart, AbstractTraversableProgramPart, Cart, Catalog, Container, ContentBackupAmetysObject, Course, CourseList, CoursePart, DefaultContent, DefaultSharedContent, DefaultWebContent, DefaultWorkflowAwareContent, JCRCalendar, JCRCalendarEvent, JCRCalendarResource, JCRTask, JCRTasksList, ModifiableDefaultContent, ModifiableDefaultWebContent, OrgUnit, Person, Program, Query, Site, SubProgram

public interface ModelAwareDataAwareAmetysObject
extends DataAwareAmetysObject, ModelAwareDataHolder

Model aware AmetysObject that can handle data.

Field Summary

Fields inherited from interface org.ametys.plugins.repository.data.holder.ModelAwareDataHolder

ALTERNATIVE_SUFFIX, COMMENTS_SUFFIX, STATUS_SUFFIX

Method Summary

Modifier and Type	Method	Description
default List<DataComment>	getComments(String dataName)	Retrieve the comments of the data with the given name
default ModelAwareComposite	getComposite(String compositePath)	Retrieves the composite at the given path
ModelAwareDataHolder	getDataHolder()	Returns the DataHolder of this AmetysObject.
default Collection<String>	getDataNames()	Retrieves the names of data contained by this data holder Retrieves only the data at first level, does not check composite data
default ModelItem	getDefinition(String path)	Retrieves the definition of the data at the given path
default ModelAwareComposite	getExternalComposite(String compositePath)	Retrieves the external composite at the given path
default ModelAwareRepeater	getExternalRepeater(String repeaterPath)	Retrieves the external repeater at the given path
default <T> T	getExternalValue(String dataPath)	Retrieves the external value of the data at the given path
default ModelAwareComposite	getLocalComposite(String compositePath)	Retrieves the local composite at the given path
default ModelAwareRepeater	getLocalRepeater(String repeaterPath)	Retrieves the local repeater at the given path
default <T> T	getLocalValue(String dataPath)	Retrieves the local value of the data at the given path
default Collection<? extends Model>	getModel()	Retrieves the data holder's model
default Optional<? extends ModelAwareDataHolder>	getParentDataHolder()	Retrieves the optional parent of the current DataHolder There can be no parent if the current DataHolder is the root
default ModelAwareRepeater	getRepeater(String repeaterPath)	Retrieves the repeater at the given path
default ModelAwareDataHolder	getRootDataHolder()	Retrieves the DataHolder that is the root of the current one
default ExternalizableDataProvider.ExternalizableDataStatus	getStatus(String dataPath)	Retrieves the status of the externalizable data at the given path Warning: This method won't check that your data is externalizable.
default <T> T	getValue(String dataPath, boolean allowMultiValuedPathSegments)	Retrieves the value of the data at the given path
default <T> T	getValue(String dataPath, boolean useDefaultFromModel, T defaultValue)	Retrieves the value of the data at the given path, or the default value The returned value is one of those ones, in the order: The value of the data if exists and is not empty The default value from the model if useDefaultFromModel is true and there is a default value defined by the model The given default value
default boolean	hasComments(String dataName)	Checks if there is are comments on the data with the given name
default boolean	hasDefinition(String path)	Checks if there is a definition at the given path
default boolean	hasExternalValue(String dataPath)	Checks if there is a non empty external value for the data at the given path
default boolean	hasExternalValueOrEmpty(String dataPath)	Checks if there is an external value for the data at the given path
default boolean	hasLocalValue(String dataPath)	Checks if there is a non empty local value for the data at the given path
default boolean	hasLocalValueOrEmpty(String dataPath)	Checks if there is a local value for the data at the given path
default boolean	hasValue(String dataPath)	Checks if there is a non empty value for the data at the given path
default boolean	hasValueOrEmpty(String dataPath)	Checks if there is a value, even empty, 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.ametysobject.DataAwareAmetysObject

copyTo, dataToSAX, dataToSAX, getRepositoryData

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

commentsToSAX, dataToMap, dataToMap, dataToMap, dataToMap, dataToSAX, dataToSAX, dataToSAX, dataToSAX, dataToSAXForEdition, getType, getValue, isMultiple

Method Detail

getDataHolder

ModelAwareDataHolder getDataHolder()

Description copied from interface: DataAwareAmetysObject

Returns the DataHolder of this AmetysObject.

Specified by:

getDataHolder in interface DataAwareAmetysObject

Returns:

the DataHolder of this AmetysObject

getComposite

default ModelAwareComposite getComposite(String compositePath)
                                  throws IllegalArgumentException,
                                         UndefinedItemPathException,
                                         BadItemTypeException,
                                         BadDataPathCardinalityException

Description copied from interface: DataHolder

Retrieves the composite at the given path

Specified by:

getComposite in interface DataAwareAmetysObject

Specified by:

getComposite in interface DataHolder

Specified by:

getComposite in interface ModelAwareDataHolder

Parameters:

compositePath - path of the composite to retrieve

Returns:

the composite or null if not exists or is empty

Throws:

IllegalArgumentException - if the given composite path is null or empty

UndefinedItemPathException - if the given composite path is not defined by the model

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

BadDataPathCardinalityException - if the definition of a part of the data path is multiple. Only the last part can be multiple

getLocalComposite

default ModelAwareComposite getLocalComposite(String compositePath)
                                       throws IllegalArgumentException,
                                              UndefinedItemPathException,
                                              BadItemTypeException,
                                              BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the local composite at the given path

Specified by:

getLocalComposite in interface ModelAwareDataHolder

Parameters:

compositePath - path of the externalizable composite to retrieve

Returns:

the composite or null if not exists or is empty

Throws:

IllegalArgumentException - if the given composite path is null or empty

UndefinedItemPathException - if the given composite path is not defined by the model

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

BadDataPathCardinalityException - if the definition of a part of the data path is multiple. Only the last part can be multiple

getExternalComposite

default ModelAwareComposite getExternalComposite(String compositePath)
                                          throws IllegalArgumentException,
                                                 UndefinedItemPathException,
                                                 BadItemTypeException,
                                                 BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the external composite at the given path

Specified by:

getExternalComposite in interface ModelAwareDataHolder

Parameters:

compositePath - path of the externalizable composite to retrieve

Returns:

the composite or null if not exists or is empty

Throws:

IllegalArgumentException - if the given composite path is null or empty

UndefinedItemPathException - if the given composite path is not defined by the model

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

BadDataPathCardinalityException - if the definition of a part of the data path is multiple. Only the last part can be multiple

getRepeater

default ModelAwareRepeater getRepeater(String repeaterPath)
                                throws IllegalArgumentException,
                                       UndefinedItemPathException,
                                       BadItemTypeException,
                                       BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the repeater at the given path

Specified by:

getRepeater in interface ModelAwareDataHolder

Parameters:

repeaterPath - path of the repeater to retrieve

Returns:

the repeater or null if not exists or is empty

Throws:

IllegalArgumentException - if the given repeater path is null or empty

UndefinedItemPathException - if the given repeater path is not defined by the model

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

BadDataPathCardinalityException - if the definition of a part of the data path is multiple. Only the last part can be multiple

getLocalRepeater

default ModelAwareRepeater getLocalRepeater(String repeaterPath)
                                     throws IllegalArgumentException,
                                            UndefinedItemPathException,
                                            BadItemTypeException,
                                            BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the local repeater at the given path

Specified by:

getLocalRepeater in interface ModelAwareDataHolder

Parameters:

repeaterPath - path of the externalizable repeater to retrieve

Returns:

the repeater or null if not exists or is empty

Throws:

IllegalArgumentException - if the given repeater path is null or empty

UndefinedItemPathException - if the given repeater path is not defined by the model

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

BadDataPathCardinalityException - if the definition of a part of the data path is multiple. Only the last part can be multiple

getExternalRepeater

default ModelAwareRepeater getExternalRepeater(String repeaterPath)
                                        throws IllegalArgumentException,
                                               UndefinedItemPathException,
                                               BadItemTypeException,
                                               BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the external repeater at the given path

Specified by:

getExternalRepeater in interface ModelAwareDataHolder

Parameters:

repeaterPath - path of the externalizable repeater to retrieve

Returns:

the repeater or null if not exists or is empty

Throws:

IllegalArgumentException - if the given repeater path is null or empty

UndefinedItemPathException - if the given repeater path is not defined by the model

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

BadDataPathCardinalityException - if the definition of a part of the data path is multiple. Only the last part can be multiple

hasValue

default boolean hasValue(String dataPath)
                  throws IllegalArgumentException,
                         BadDataPathCardinalityException

Description copied from interface: DataHolder

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

Specified by:

hasValue in interface DataAwareAmetysObject

Specified by:

hasValue in interface DataHolder

Specified by:

hasValue in interface ModelAwareDataHolder

Parameters:

dataPath - path of the data

Returns:

true if there is a non empty value for the data, false otherwise

Throws:

IllegalArgumentException - if the given data path is null or empty

BadDataPathCardinalityException - if the definition of a part of the data path is multiple. Only the last part can be multiple

hasLocalValue

default boolean hasLocalValue(String dataPath)
                       throws IllegalArgumentException,
                              BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

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

Specified by:

hasLocalValue in interface ModelAwareDataHolder

Parameters:

dataPath - path of the externalizable data

Returns:

true if the data at the given path is defined by the model, if there is a non empty local value for the data and if the type of this value matches the type of the definition. false otherwise

Throws:

IllegalArgumentException - if the given data path is null or empty

BadDataPathCardinalityException - if the definition of a part of the data path is multiple. Only the last part can be multiple

hasExternalValue

default boolean hasExternalValue(String dataPath)
                          throws IllegalArgumentException,
                                 BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

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

Specified by:

hasExternalValue in interface ModelAwareDataHolder

Parameters:

dataPath - path of the externalizable data

Returns:

true if the data at the given path is defined by the model, if there is a non empty external value for the data and if the type of this value matches the type of the definition. false otherwise

Throws:

IllegalArgumentException - if the given data path is null or empty

BadDataPathCardinalityException - if the definition of a part of the data path is multiple. Only the last part can be multiple

hasValueOrEmpty

default boolean hasValueOrEmpty(String dataPath)
                         throws IllegalArgumentException,
                                BadDataPathCardinalityException

Description copied from interface: DataHolder

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

Specified by:

hasValueOrEmpty in interface DataAwareAmetysObject

Specified by:

hasValueOrEmpty in interface DataHolder

Specified by:

hasValueOrEmpty in interface ModelAwareDataHolder

Parameters:

dataPath - path of the data

Returns:

true if there is value, even empty, for the data, false otherwise

Throws:

IllegalArgumentException - if the given data path is null or empty

BadDataPathCardinalityException - if the definition of a part of the data path is multiple. Only the last part can be multiple

hasLocalValueOrEmpty

default boolean hasLocalValueOrEmpty(String dataPath)
                              throws IllegalArgumentException,
                                     BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

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

Specified by:

hasLocalValueOrEmpty in interface ModelAwareDataHolder

Parameters:

dataPath - path of the externalizable data

Returns:

true if the data at the given path is defined by the model, if there is a local value for the data, even empty, and if the type of this value matches the type of the definition. false otherwise

Throws:

IllegalArgumentException - if the given data path is null or empty

BadDataPathCardinalityException - if the definition of a part of the data path is multiple. Only the last part can be multiple

hasExternalValueOrEmpty

default boolean hasExternalValueOrEmpty(String dataPath)
                                 throws IllegalArgumentException,
                                        BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Checks if there is an external value for the data at the given path

Specified by:

hasExternalValueOrEmpty in interface ModelAwareDataHolder

Parameters:

dataPath - path of the externalizable data

Returns:

true if the data at the given path is defined by the model, if there is an external value for the data, even empty, and if the type of this value matches the type of the definition. false otherwise

Throws:

IllegalArgumentException - if the given data path is null or empty

BadDataPathCardinalityException - if the definition of a part of the data path is multiple. Only the last part can be multiple

hasComments

default boolean hasComments(String dataName)
                     throws IllegalArgumentException,
                            UndefinedItemPathException

Description copied from interface: ModelAwareDataHolder

Checks if there is are comments on the data with the given name

Specified by:

hasComments in interface ModelAwareDataHolder

Parameters:

dataName - name of the data

Returns:

true if there are comments on the data, false otherwise

Throws:

IllegalArgumentException - if the given data name is null or empty

UndefinedItemPathException - if the given data name is not defined by the model

getValue

default <T> T getValue(String dataPath,
                       boolean allowMultiValuedPathSegments)
                throws IllegalArgumentException,
                       UndefinedItemPathException,
                       BadItemTypeException,
                       BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the value of the data at the given path

Specified by:

getValue in interface ModelAwareDataHolder

Type Parameters:

T - type of the value to retrieve

Parameters:

dataPath - path of the data

allowMultiValuedPathSegments - true to allow multi-valued segments in the path (not necessarily at the last segment), false otherwise. If true, if there is no indicated entry for a repeater, the values of all the entries are retrieved If true and if there are multiple values, all data are retrieved in one array

Returns:

the value of the data or null if allowMultiValuedPathSegments is false and there is no non empty value. The object returned may be of a generic class defined by the storage (if the model is unknown). For example, an url may be returned as a String.

Throws:

IllegalArgumentException - if the given data path is null or empty

UndefinedItemPathException - if the given data path is not defined by the model

BadItemTypeException - if the type defined by the model doesn't match the type of the stored value

BadDataPathCardinalityException - if the managesMultiples boolean is false and the definition of a part of the data path is multiple. Only the last part can be multiple

getValue

default <T> T getValue(String dataPath,
                       boolean useDefaultFromModel,
                       T defaultValue)
                throws IllegalArgumentException,
                       UndefinedItemPathException,
                       BadItemTypeException,
                       BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the value of the data at the given path, or the default value The returned value is one of those ones, in the order:

1. The value of the data if exists and is not empty
2. The default value from the model if useDefaultFromModel is true and there is a default value defined by the model
3. The given default value

Specified by:

getValue in interface ModelAwareDataHolder

Type Parameters:

T - type of the value to retrieve

Parameters:

dataPath - path of the data

useDefaultFromModel - true to use the default value from the model, false to use the given default value

defaultValue - default value used if value is null and useDefaultFromModel is false, or if there is no default value on model

Returns:

the value of the data at the given path

Throws:

IllegalArgumentException - if the given data path is null or empty

UndefinedItemPathException - if the given data path is not defined by the model

BadItemTypeException - if the type defined by the model doesn't match the type of the stored value

BadDataPathCardinalityException - if the definition of a part of the data path is multiple. Only the last part can be multiple

getLocalValue

default <T> T getLocalValue(String dataPath)
                     throws IllegalArgumentException,
                            UndefinedItemPathException,
                            BadItemTypeException,
                            BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the local value of the data at the given path

Specified by:

getLocalValue in interface ModelAwareDataHolder

Type Parameters:

T - type of the value to retrieve

Parameters:

dataPath - path of the externalizable data

Returns:

the local value of the data or null if not exists or is empty. The object returned may be of a generic class defined by the storage (if the model is unknown). For example, an url may be returned as a String.

Throws:

IllegalArgumentException - if the given data path is null or empty

UndefinedItemPathException - if the given data path is not defined by the model

BadItemTypeException - if the type defined by the model doesn't match the type of the stored value

BadDataPathCardinalityException - if the definition of a part of the data path is multiple. Only the last part can be multiple

getExternalValue

default <T> T getExternalValue(String dataPath)
                        throws IllegalArgumentException,
                               UndefinedItemPathException,
                               BadItemTypeException,
                               BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the external value of the data at the given path

Specified by:

getExternalValue in interface ModelAwareDataHolder

Type Parameters:

T - type of the value to retrieve

Parameters:

dataPath - path of the externalizable data

Returns:

the external value of the data or null if not exists or is empty. The object returned may be of a generic class defined by the storage (if the model is unknown). For example, an url may be returned as a String.

Throws:

IllegalArgumentException - if the given data path is null or empty

UndefinedItemPathException - if the given data path is not defined by the model

BadItemTypeException - if the type defined by the model doesn't match the type of the stored value

BadDataPathCardinalityException - if the definition of a part of the data path is multiple. Only the last part can be multiple

getStatus

default ExternalizableDataProvider.ExternalizableDataStatus getStatus(String dataPath)
                                                               throws IllegalArgumentException,
                                                                      UndefinedItemPathException,
                                                                      BadDataPathCardinalityException

Description copied from interface: ModelAwareDataHolder

Retrieves the status of the externalizable data at the given path Warning: This method won't check that your data is externalizable. But there is no sense to call it with a non externalizable data

Specified by:

getStatus in interface ModelAwareDataHolder

Parameters:

dataPath - path of the externalizable data

Returns:

the status of the externalizable data at the given path

Throws:

IllegalArgumentException - if the given data path is null or empty

UndefinedItemPathException - if the given data path is not defined by the model

BadDataPathCardinalityException - if the definition of a part of the data path is multiple. Only the last part can be multiple

getComments

default List<DataComment> getComments(String dataName)
                               throws IllegalArgumentException,
                                      UndefinedItemPathException

Description copied from interface: ModelAwareDataHolder

Retrieve the comments of the data with the given name

Specified by:

getComments in interface ModelAwareDataHolder

Parameters:

dataName - name of the data

Returns:

the comments of the data

Throws:

IllegalArgumentException - if the given data name is null or empty

UndefinedItemPathException - if the given data name is not defined by the model

getModel

default Collection<? extends Model> getModel()

Description copied from interface: ModelAwareDataHolder

Retrieves the data holder's model

Specified by:

getModel in interface ModelAwareDataHolder

Returns:

the data holder's model

getDefinition

default ModelItem getDefinition(String path)
                         throws IllegalArgumentException,
                                UndefinedItemPathException

Description copied from interface: ModelAwareDataHolder

Retrieves the definition of the data at the given path

Specified by:

getDefinition in interface ModelAwareDataHolder

Parameters:

path - path of the data. No matter if it is a definition or data path (with repeater entry positions)

Returns:

the definition of the data

Throws:

IllegalArgumentException - if the given path is null or empty

UndefinedItemPathException - if the given path is not defined by the model

hasDefinition

default boolean hasDefinition(String path)
                       throws IllegalArgumentException

Description copied from interface: ModelAwareDataHolder

Checks if there is a definition at the given path

Specified by:

hasDefinition in interface ModelAwareDataHolder

Parameters:

path - path of the data. No matter if it is a definition or data path (with repeater entry positions)

Returns:

true if there is definition at the given path, false otherwise

Throws:

IllegalArgumentException - if the given 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 Retrieves only the data at first level, does not check composite data

Specified by:

getDataNames in interface DataAwareAmetysObject

Specified by:

getDataNames in interface DataHolder

Specified by:

getDataNames in interface ModelAwareDataHolder

Returns:

the names of all data contained by this data holder

getParentDataHolder

default Optional<? extends ModelAwareDataHolder> getParentDataHolder()

Description copied from interface: DataHolder

Retrieves the optional parent of the current DataHolder There can be no parent if the current DataHolder is the root

Specified by:

getParentDataHolder in interface DataAwareAmetysObject

Specified by:

getParentDataHolder in interface DataHolder

Specified by:

getParentDataHolder in interface ModelAwareDataHolder

Returns:

the parent of the current DataHolder

getRootDataHolder

default ModelAwareDataHolder getRootDataHolder()

Description copied from interface: DataHolder

Retrieves the DataHolder that is the root of the current one

Specified by:

getRootDataHolder in interface DataAwareAmetysObject

Specified by:

getRootDataHolder in interface DataHolder

Specified by:

getRootDataHolder in interface ModelAwareDataHolder

Returns:

the root DataHolder