Package org.ametys.cms.trash.model

Class TrashElementModel

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.cms.trash.model.TrashElementModel

All Implemented Interfaces:

Model, ModelItemAccessor, ModelItemContainer, LogEnabled, Component, Contextualizable, Serviceable

Direct Known Subclasses:

WebTrashElementModel

public class TrashElementModel
extends AbstractLogEnabled
implements Model, Component, Serviceable, Contextualizable

The model for trash elements.

Field Summary

Fields

Modifier and Type	Field	Description
protected ModelItemTypeExtensionPoint	_modelAwareItemTypeEP	The model item type
protected TrashElementTypeEnumerator	_trashElementTypeEnum	The trash element type enumerator
protected TrashElementTypeExtensionPoint	_trashElementTypeEP	The trash element type extension point
static final String	AUTHOR	Item name for the author of the deletion
static final String	DATE	Item name for the deletion date
static final String	DELETED_OBJECT	Item name for the reference to the deleted object
static final String	HIDDEN	Item name for the reference to the deleted object
static final String	LINKED_OBJECTS	Item name for the reference to the linked objects
static final String	PARENT_PATH	Item name for the parent path of the object
static final String	ROLE	The avalon role
static final String	TITLE	Item name for the title of the element
static final String	TRASH_TYPE	Item name for the type of the element

Constructor Summary

Constructors

Constructor	Description
TrashElementModel()

Method Summary

Modifier and Type	Method	Description
void	contextualize(Context context)
protected List<ElementDefinition>	createModelItems()	Create the model items present in the trash element model
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>	getModelItems()	Retrieves all the model items of this accessor
void	service(ServiceManager manager)

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

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 Details

ROLE

public static final String ROLE

The avalon role

TITLE

public static final String TITLE

Item name for the title of the element

See Also:

• Constant Field Values

TRASH_TYPE

public static final String TRASH_TYPE

Item name for the type of the element

See Also:

• Constant Field Values

AUTHOR

public static final String AUTHOR

Item name for the author of the deletion

See Also:

• Constant Field Values

DATE

public static final String DATE

Item name for the deletion date

See Also:

• Constant Field Values

PARENT_PATH

public static final String PARENT_PATH

Item name for the parent path of the object

See Also:

• Constant Field Values

DELETED_OBJECT

public static final String DELETED_OBJECT

Item name for the reference to the deleted object

See Also:

• Constant Field Values

HIDDEN

public static final String HIDDEN

Item name for the reference to the deleted object

See Also:

• Constant Field Values

LINKED_OBJECTS

public static final String LINKED_OBJECTS

Item name for the reference to the linked objects

See Also:

• Constant Field Values

_trashElementTypeEnum

protected TrashElementTypeEnumerator _trashElementTypeEnum

The trash element type enumerator

_trashElementTypeEP

protected TrashElementTypeExtensionPoint _trashElementTypeEP

The trash element type extension point

_modelAwareItemTypeEP

protected ModelItemTypeExtensionPoint _modelAwareItemTypeEP

The model item type

Constructor Details

TrashElementModel

public TrashElementModel()

Method Details

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

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)

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

createModelItems

protected List<ElementDefinition> createModelItems()
                                            throws Exception

Create the model items present in the trash element model

Returns:

the model items

Throws:

Exception - if an occurs when creating the model items