com.sas.actionprovider.commands
Class MapReportLinkingCommand

com.sas.actionprovider.commands.MapReportLinkingCommand
All Implemented Interfaces:
DynamicAttributeCommandInterface, BaseEntityInterface, BaseEntityValueInterface, EntityKeyInterface, com.sas.lang.StringDataInterface, com.sas.PublicClonable, com.sas.util.Command, com.sas.util.SimpleCommand, java.lang.Cloneable, java.rmi.Remote

public class MapReportLinkingCommand

This class implements the map's report linking command.


Nested Class Summary
protected  class MapReportLinkingCommand.LevelValuePair
          This is the container class that holds all the needed information to handle the ReportLink action.
protected  class MapReportLinkingCommand.ReportLinkElement
           
 
Field Summary
 
Fields inherited from interface com.sas.commands.DynamicAttributeCommandInterface
COMMAND_NAME_PREFIX
 
Constructor Summary
MapReportLinkingCommand(java.lang.String name)
          Constructor that accepts a command name
 
Method Summary
 void execute(java.lang.Object o)
          This method implements the execute method on the CommandInterface, which is not implemented by the abstract Base classes.
 int getCommandStatus(ActionSupportFilter filter)
          Returns a int value indicating whether the command is enabled for the given area as specified by the current area information encapsulate in the ActionSupportFilter.
 java.lang.Object getMapViewer()
           
 java.util.ArrayList getParmValues()
           
 boolean isSupported(ActionSupportFilter actionFilter)
          Deprecated. Use getCommandStatus().
 void setMapViewer(java.lang.Object mapViewer)
           
 
Methods inherited from class com.sas.commands.BaseCommand
getLocale, getName, getNextCommandName, getText, isExecutable, isUndoable, setLocale, setName, setText, undo
 
Methods inherited from class com.sas.entities.BaseEntity
clone, containsAttributeNamed, equals, equals, getAttribute, getAttribute, getAttributeCount, getAttributes, getEntityKey, getPropertyDescriptors, getStringAttribute, listAttributeNames, removeAllAttributes, removeAttribute, reset, sameEntity, setAttribute, setAttributes, setEntityKey, toString
 
Methods inherited from interface com.sas.entities.BaseEntityValueInterface
getAttribute, setAttribute
 
Methods inherited from interface com.sas.util.Command
clone
 

Constructor Detail

MapReportLinkingCommand

public MapReportLinkingCommand(java.lang.String name)
Constructor that accepts a command name

Parameters:
name - command name
Method Detail

execute

public void execute(java.lang.Object o)
This method implements the execute method on the CommandInterface, which is not implemented by the abstract Base classes. This method fills out a map that contains the needed information to perform the ReportLinking action. The parmValues map will contain an entry with a key of a ReportLinkElement with the information about which DataItem was clicked, and a value of the String where the user clicked, like "NC"

Specified by:
execute in interface com.sas.util.SimpleCommand
Specified by:
execute in class BaseCommand
Parameters:
o - currently ignored

isSupported

public boolean isSupported(ActionSupportFilter actionFilter)
Deprecated. Use getCommandStatus().

Returns a boolean indicating whether the command is supported for the area specified on the ActionSupportFilter argument.

Parameters:
actionFilter - The object that describes the current area.
Returns:
a boolean indicating whether the command is supported.

getCommandStatus

public int getCommandStatus(ActionSupportFilter filter)
Returns a int value indicating whether the command is enabled for the given area as specified by the current area information encapsulate in the ActionSupportFilter. If not enabled, the key indicates a reason why the command is not enabled.

Parameters:
filter - The ActionSupportFilter that encapsulates all the necessary information to describe the current area.
Returns:
an int value indicating whether the command is enabled and, if not, why.

getMapViewer

public java.lang.Object getMapViewer()
Returns:
Returns the mapViewer.

setMapViewer

public void setMapViewer(java.lang.Object mapViewer)
Parameters:
mapViewer - The mapViewer to set.

getParmValues

public java.util.ArrayList getParmValues()



Copyright © 2009 SAS Institute Inc. All Rights Reserved.