com.togethersoft.openapi.model.extension
Interface ChildrenProvider

All Known Subinterfaces:

ChildLinksProvider, ChildNodesProvider, ChildReferenceCollectionProvider

All Known Implementing Classes:

ChildrenProviderAdapter

public interface ChildrenProvider

extends Provider

Provider implementing this interface is responsible for generation of the
unique names of child elements of the given entity. Provider should not care
if child elements are instantiated or not (because it is not his business).

Note that elements with unique names returned by the provider
will not necessarily be instantiated. They will be instantiated only
if unique name providers accept existance of the element with such unique
name in the universe.

Author:

TogetherSoft

public StringEnumeration children(Entity parent)

Provider should return enumeration of unique names of the child elements
of the given parent entity. Model guarantees that this method
will be invoked only if isApplicable() for the same parent
entity has returned true.

The result of collaborative execution of this method for multiple
children providers registered in the model is a concatenation of the
enumerations returned by providers.

Returns: Enumeration of child elements unique names

public boolean isApplicable(Entity parent)

Provider should return true from this method if it knows
the given parent and there is a possibility that provider
will return enumeration of child elements unique names