org.ametys.runtime.model

Interface ModelItemContainer

All Known Subinterfaces:

ContentType, Model, ModifiableUserDirectory, Service

All Known Implementing Classes:

AttachmentsService, AutomaticContentType, CompositeDefinition, ConfigManager, ContentAttributeDefinition, ContentRestrictedCompositeDefinition, ContentRestrictedRepeaterDefinition, DefaultContentType, ExplorerFolderService, FilteredContentsService, FilteredPagesService, HTMLContentType, JdbcUserDirectory, LinkDirectoryService, ModelItemGroup, ODFContentType, PostContentType, RepeaterDefinition, SearchPagesService, SearchService, SiteConfigurationExtensionPoint, SitemapService, SkinParametersModel, StaticService, SyndicationService, WebContentType

public interface ModelItemContainer

Interface for model item containers

Method Summary

Modifier and Type	Method and Description
default ModelItem	getChild(String childName) Retrieves the child model item with the given name
default ModelItem	getModelItem(String itemPath) Retrieves the model item at given path
Collection<? extends ModelItem>	getModelItems() Retrieves all the model items of this container
default boolean	hasModelItem(String itemPath) Checks if there is an item defined with the given path

Method Detail

getChild

default ModelItem getChild(String childName)

Retrieves the child model item with the given name

Parameters:

childName - name of the model item child to retrieve

Returns:

the child with the given name, or null if no child is found

getModelItem

default ModelItem getModelItem(String itemPath)
                        throws UndefinedItemPathException

Retrieves the model item at given path

Parameters:

itemPath - the item path

Returns:

the model item.

Throws:

UndefinedItemPathException - if there is no item defined at the given path

hasModelItem

default boolean hasModelItem(String itemPath)

Checks if there is an item defined with the given path

Parameters:

itemPath - path of the item

Returns:

true if there is an item, false otherwise

getModelItems

Collection<? extends ModelItem> getModelItems()

Retrieves all the model items of this container

Returns:

the model items