EGF Engine
Release 0.1.0

org.eclipse.egf.pde.plugin.extension
Interface IContextExtensionFactory

All Known Implementing Classes:
ContextExtensionFactory

public interface IContextExtensionFactory

This factory creates commands to deal with "context" extension-point.


Method Summary
 IPluginChangesCommand setContextElementBasedOnContractElementRef(String contextId_p, String contextElementId_p, String contractElementReferenceId_p, String value_p)
          Set a context element based on a contract element reference in a context extension for given parameters.
 IPluginChangesCommand setContextElementBasedOnKey(String contextId_p, String contextElementId_p, String keyValue_p, String keyType_p, String value_p)
          Set a context element based on a key in a context extension for given parameters.
 IPluginChangesCommand setContextExtension(String contextId_p)
          Set an extension matching "context" extension-point for given parameters.
 IPluginChangesCommand unsetContextElement(String contextId_p, String contextElementId_p)
          Unset a context element from a context extension for given parameters.
 IPluginChangesCommand unsetContextExtension(String contextId_p)
          Unset an extension matching "context" extension-point for given parameters.
 

Method Detail

setContextExtension

IPluginChangesCommand setContextExtension(String contextId_p)
Set an extension matching "context" extension-point for given parameters.

Parameters:
contextId_p -
Returns:
an IPluginChangesCommand instance that performs this change.

unsetContextExtension

IPluginChangesCommand unsetContextExtension(String contextId_p)
Unset an extension matching "context" extension-point for given parameters.

Parameters:
contextId_p -
Returns:
an IPluginChangesCommand instance that performs this change.

setContextElementBasedOnContractElementRef

IPluginChangesCommand setContextElementBasedOnContractElementRef(String contextId_p,
                                                                 String contextElementId_p,
                                                                 String contractElementReferenceId_p,
                                                                 String value_p)
Set a context element based on a contract element reference in a context extension for given parameters.

Parameters:
contextId_p - context that the context element is added in.
contextElementId_p - id of the created context element.
contractElementReferenceId_p - reference to a contract element defined in a ContractReferences extension-point.
value_p - string value.
Returns:
an IPluginChangesCommand instance that performs this change.

setContextElementBasedOnKey

IPluginChangesCommand setContextElementBasedOnKey(String contextId_p,
                                                  String contextElementId_p,
                                                  String keyValue_p,
                                                  String keyType_p,
                                                  String value_p)
Set a context element based on a key in a context extension for given parameters.

Parameters:
contextId_p - context that the context element is added in.
contextElementId_p - id of the created context element.
keyValue_p - key value.
keyType_p - key type.
value_p - the value to set.
Returns:
an IPluginChangesCommand instance that performs this change.

unsetContextElement

IPluginChangesCommand unsetContextElement(String contextId_p,
                                          String contextElementId_p)
Unset a context element from a context extension for given parameters.

Parameters:
contextId_p -
contextElementId_p -
Returns:

EGF Engine
Release 0.1.0

Copyright (c) Thales Corporate Services S.A.S, 2009.

This page is made available under license. For full details see the LEGAL in the documentation book that contains this page.