com.sas.actionprovider.support
Interface DynamicActionCountInterface

All Known Implementing Classes:

BaseOLAPDrillStateSupport, HttpOLAPDrillStateSupport, HttpOLAPTableViewSupport, SwingOLAPDrillStateSupport, SwingTableViewSupport

public interface DynamicActionCountInterface

This interface is implemented by support classes that may need to return multiple instances of Actions having the same actionType during a single getActions(} call.

For a given actionType, the BaseActionProviderSupport class asks the subclass, via this interface's getActionCount() method, how many instances of the Action it needs to return for the current getActions() call.

The BaseActionProviderSupport class then sets either the 'actionIndex' or the 'listIndex' of the ActionSupportFilter prior to acquiring the dynamic values of each version of the Action so that certain methods ( e.g. getActionScopeAttributeMap ) may know which version is being loaded.

A basic understanding of the ActionProvider Framework, of which this class is a part, is recommended before attempting to use this class.

• For general information on the ActionProvider Framework, including an overview of how the primary classes of the framework work together, refer to the com.sas.actionprovider package documentation.

• For examples demonstrating how to use the ActionProvider Framework, including how to override default Actions or add new custom Actions, refer to the Samples Site.

Visit the AppDev Studio Developer's Site to access step-by-step examples, white papers and additional usage information at http://support.sas.com/rnd/appdev/.

Note: A snapshot of the AppDev Studio Developers Site is installed on your local Web server when you install AppDev Studio. To access the site from webAF, select Help -> Developer Site .

Since:

3.0

See Also:

BaseActionProviderSupport, BaseActionProviderSupport.getActions(com.sas.actionprovider.ActionSupportFilter), ActionSupportFilter.setActionIndex(int), ActionSupportFilter.setListIndex(int)

Method Summary

int	getActionCount(ActionSupportFilter filter, java.lang.String actionType) Returns the number of Actions of a particular actionType that are needed for the area.

Method Detail

getActionCount

int getActionCount(ActionSupportFilter filter,
                   java.lang.String actionType)

Returns the number of Actions of a particular actionType that are needed for the area.

Parameters:

filter - TThe ActionSupportFilter that encapsulates all information describing the specific area.

actionType - The key associated with a particular type of Action.

Returns:

the number of Actions of a particular actionType that are needed for the area.