Package org.ametys.runtime.model

Interface Model

All Superinterfaces:

ModelItemAccessor, ModelItemContainer

All Known Subinterfaces:

ContentType, ModifiableUserDirectory, Service, SiteType, SynchronizableContentsCollectionModel

All Known Implementing Classes:

AttachmentsService, AutomaticContentType, CalendarSearchService, CatalogModel, CatalogSiteType, ConfigManager, ContentConsistencyModel, DefaultContentType, DefaultSiteType, DefaultSynchronizableContentsCollectionModel, ExplorerFolderService, FilteredContentsService, FilteredPagesService, FormService, HTMLContentType, JdbcUserDirectory, LinkDirectoryService, ODFContentType, ProjectWorkspaceSiteType, SearchPagesService, SearchService, ServerDirectoryService, SitemapService, SkinParametersModel, StaticService, SurveyService, SyndicationService, ViewParametersModel

public interface Model
extends ModelItemContainer

Interface of model classes for parameters or attributes

Method Summary

Modifier and Type	Method	Description
String	getFamilyId()	Retrieves the Family Id (for example the extension point) Each model Id have to be unique in it's family Id
String	getId()	Retrieves the model id (an id must be unique in the family getFamilyId()
static Model	of(String id, String familyId, ModelItem... modelItems)	Creates a Model with the given ModelItems

Methods inherited from interface org.ametys.runtime.model.ModelItemAccessor

getChild, getModelItem, getModelItems, hasModelItem

Method Details

of

static Model of(String id,
 String familyId,
 ModelItem... modelItems)

Creates a Model with the given ModelItems

Parameters:

id - the model identifier

familyId - the model family identifier

modelItems - the model items

Returns:

the created Model

getId

String getId()

Retrieves the model id (an id must be unique in the family getFamilyId()

Returns:

model id (for example the content type id for a content)

getFamilyId

String getFamilyId()

Retrieves the Family Id (for example the extension point) Each model Id have to be unique in it's family Id

Returns:

content point (for example "org.ametys.cms.contenttype.ContentTypeExtensionPoint" for a content)