Package org.ametys.web.parameters.view

Class ViewParametersModel

java.lang.Object

org.ametys.web.parameters.view.ViewParametersModel

All Implemented Interfaces:

Model, ModelItemAccessor, ModelItemContainer

public class ViewParametersModel
extends Object
implements Model

Object representing the view parameters as a model

Field Summary

Fields

Modifier and Type	Field	Description
protected String	_id	The unique identifier

Constructor Summary

Constructors

Constructor	Description
ViewParametersModel(String id, View view, Map<String,ModelItem> modelItems)	The view parameters constructor

Method Summary

Modifier and Type	Method	Description
void	addModelItem(ModelItem modelItem)	Add a model item
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 Model.getFamilyId()
Collection<? extends ModelItem>	getInheritedModelItems(Page page)	Get model item with inheritance from the page
Collection<? extends ModelItem>	getModelItems()	Retrieves all the model items of this accessor
View	getView()	Get the view
boolean	isNotEmpty()	Returns true if there are model items
void	setModelItems(Map<String,ModelItem> modelItems)	Set the model items
void	setView(View view)	Set the view

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getChild, getModelItem, hasModelItem

Field Detail

_id

protected String _id

The unique identifier

Constructor Detail

ViewParametersModel

public ViewParametersModel(String id,
                           View view,
                           Map<String,ModelItem> modelItems)

The view parameters constructor

Parameters:

id - the id

view - the view

modelItems - the model items

Method Detail

getView

public View getView()

Get the view

Returns:

the view

setView

public void setView(View view)

Set the view

Parameters:

view - the view

getModelItems

public Collection<? extends ModelItem> getModelItems()

Description copied from interface: ModelItemAccessor

Retrieves all the model items of this accessor

Specified by:

getModelItems in interface ModelItemAccessor

Returns:

the model items

setModelItems

public void setModelItems(Map<String,ModelItem> modelItems)

Set the model items

Parameters:

modelItems - the model items

getId

public String getId()

Description copied from interface: Model

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

Specified by:

getId in interface Model

Returns:

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

getFamilyId

public String getFamilyId()

Description copied from interface: Model

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

Specified by:

getFamilyId in interface Model

Returns:

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

isNotEmpty

public boolean isNotEmpty()

Returns true if there are model items

Returns:

true if there are model items

addModelItem

public void addModelItem(ModelItem modelItem)

Add a model item

Parameters:

modelItem - the model item

getInheritedModelItems

public Collection<? extends ModelItem> getInheritedModelItems(Page page)

Get model item with inheritance from the page

Parameters:

page - the page

Returns:

the list of model item with inheritance