Package org.ametys.plugins.repository.virtual

Interface VirtualAmetysObjectFactory<A extends AmetysObject>

Type Parameters:

A - the actual type of AmetysObjects

All Superinterfaces:

AmetysObjectFactory<A>, Component

All Known Implementing Classes:

FirstLevelPageFactory, VirtualOrganisationChartPageFactory, VirtualUGCPageFactory, VirtualUserDirectoryPageFactory

public interface VirtualAmetysObjectFactory<A extends AmetysObject>
extends AmetysObjectFactory<A>

AmetysObjectFactory for handling "virtual" objects, in that they did not rely directly to the JCR storage.
Such factory is bounded to an object through a particular property in the JCR tree.
Virtual AmetysObject handled by a VirtualAmetysObjectFactory are considered as children of the JCRAmetysObject corresponding to the JCR Node holding that property.

Method Summary

Modifier and Type	Method	Description
A	getChild(JCRAmetysObject parent, String childName)	Returns a named AmetysObject.
AmetysObjectIterable<A>	getChildren(JCRAmetysObject parent)	Returns the "root" objects of this virtual factory, hosted in the Ametys hierarchy under a TraversableAmetysObject, which is backed by a concrete JCR Node.
boolean	hasChild(JCRAmetysObject parent, String childName)	Returns true if the named AmetysObject exists.

Methods inherited from interface org.ametys.plugins.repository.AmetysObjectFactory

getAmetysObjectById, getScheme, hasAmetysObjectForId

Method Details

getChildren

AmetysObjectIterable<A> getChildren(JCRAmetysObject parent)

Returns the "root" objects of this virtual factory, hosted in the Ametys hierarchy under a TraversableAmetysObject, which is backed by a concrete JCR Node.

Parameters:

parent - the JCRAmetysObject "hosting" this factory.

Returns:

the root objects of this virtual factory.

getChild

A getChild(JCRAmetysObject parent,
 String childName)

Returns a named AmetysObject.

Parameters:

parent - the JCRAmetysObject "hosting" this factory.

childName - the name of the virtual child.

Returns:

the corresponding AmetysObject.

hasChild

boolean hasChild(JCRAmetysObject parent,
 String childName)

Returns true if the named AmetysObject exists.

Parameters:

parent - the JCRAmetysObject "hosting" this factory.

childName - the name of the virtual child.

Returns:

true if the named AmetysObject exists.