org.eclipse.higgins.idas.api
Interface IExtension

public interface IExtension

Represents an extended argument. Some methods within the IdAS api support the ability to pass extra information when calling them. Typically this is done by passing an array of IExtension objects. Standard extensions defined by the Higgins project are listed at

Method Summary

boolean	failIfUnsupported() Returns true if this extension should cause the operation to fail when the context provider does not support it.
URI	getID() Returns the extension identifier for this extension.

Method Detail

getID

public URI getID()

Returns the extension identifier for this extension. All extensions have an identifier. Preferably one which is resolvable to documentation concerning the extension

Returns:

URI which identifies this extension

failIfUnsupported

public boolean failIfUnsupported()

Returns true if this extension should cause the operation to fail when the context provider does not support it. When true, the context provider will throw UnhandledExtensionException if it does not support the extension. When false, the context provider silently ignores the extension when it does not support it for the operation. When false and the context provider supports the extension for the operation, it makes use of the extension.

Returns:

boolean indicating if the extension is unsupported by the context that the operation should fail.