org.eclipse.emfforms.core.services.datatemplate

Interface TemplateProvider

All Known Implementing Classes:

BlankTemplateProvider, XmiTemplateProvider

public interface TemplateProvider

Template provider interface.

Since:

1.17

Author:

Mat Hansen

Method Summary

Modifier and Type	Method and Description
boolean	canProvideTemplates(org.eclipse.emf.ecore.EObject owner, org.eclipse.emf.ecore.EReference reference) Queries whether the provider can provide templates that may be assigned to the given reference of the given owner object.
Set<Template>	provideTemplates(org.eclipse.emf.ecore.EObject owner, org.eclipse.emf.ecore.EReference reference) Obtains templates wrapping objects that can be assigned to the given reference of the given owner object.

Method Detail

canProvideTemplates

boolean canProvideTemplates(org.eclipse.emf.ecore.EObject owner,
                            org.eclipse.emf.ecore.EReference reference)

Queries whether the provider can provide templates that may be assigned to the given reference of the given owner object.

Parameters:

owner - the object owning a reference to be assigned from a template

reference - a reference feature of the owner that is to be assigned from a template. If the reference is a containment then the owner would be the container of the template

Returns:

whether I have any templates to offer

provideTemplates

Set<Template> provideTemplates(org.eclipse.emf.ecore.EObject owner,
                               org.eclipse.emf.ecore.EReference reference)

Obtains templates wrapping objects that can be assigned to the given reference of the given owner object. This will only be called for an owner and reference for which the receiver previously answered true to an invocation of the canProvideTemplates(EObject, EReference) query.

Parameters:

owner - the object owning a reference to be assigned from a template

reference - a reference feature of the owner that is to be assigned from a template. If the reference is a containment then the owner would be the container of the template

Returns:

my available templates, or an empty set if none (never null)