Eclipse Platform
Release 3.1

org.eclipse.ui.activities
Interface ITriggerPointAdvisor

All Known Implementing Classes:
WorkbenchTriggerPointAdvisor

public interface ITriggerPointAdvisor

The trigger point advisor is a mechanism provided by the workbench that is consulted whenever code that is considered a trigger point is hit. It is the role of the advisor to determine what, if any, activities should be enabled as a consequence of this action. The advisor also has the option of vetoing the operation.

This interface is not intended to be extended or implemented by clients.

Since:
3.1
See Also:
ITriggerPoint

Method Summary
 Set allow(ITriggerPoint triggerPoint, IIdentifier identifier)
          Answer whether the activities bound to the identifier should be enabled when triggered by the provided trigger point.
 

Method Detail

allow

public Set allow(ITriggerPoint triggerPoint,
                 IIdentifier identifier)
Answer whether the activities bound to the identifier should be enabled when triggered by the provided trigger point.

Parameters:
triggerPoint - the trigger point to test
identifier - the identifier to test against the trigger point
Returns:
the set of activities to enable. If the set is not null the caller may proceed with their usage of the object represented by the identifier. If null the caller should abort the action.

Eclipse Platform
Release 3.1

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.