com.sas.commands.remotefileselector
Class OpenFolderCommand

com.sas.commands.remotefileselector.OpenFolderCommand
All Implemented Interfaces:
CommandSupportedInterface, ContentsChangedInterface, 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 OpenFolderCommand
implements ContentsChangedInterface, CommandSupportedInterface

This class provides the calls to the RemoteServerModel to open (i.e. drilldown) on a selected folder to show any files it may contain.

Since:
1.0

Field Summary
static java.lang.String RB_KEY
          the resource key
 
Fields inherited from interface com.sas.commands.DynamicAttributeCommandInterface
COMMAND_NAME_PREFIX
 
Constructor Summary
OpenFolderCommand()
          Constructor
OpenFolderCommand(java.lang.String name)
          Constructor that accepts a command name
OpenFolderCommand(java.lang.String name, java.lang.String actionClass)
          Constructor that accepts a command name and an action class type
 
Method Summary
 void execute(java.lang.Object o)
          Opens the selected folder and displays the folder contents.
 java.util.HashMap getEventInfo()
          Returns information about the command.
 java.lang.Object getEventSource()
          Returns the event source item "path".
 java.lang.String getFolderName()
          Returns the name of the folder to be opened.
 RemoteFileServerModelInterface getModel()
          Returns the model attribute value.
 java.lang.String getPath()
          Returns the currently viewed file path attribute.
 boolean isContentsChanged()
          Tests whether the contents are changed.
 boolean isSupported(ActionSupportFilter actionFilter)
          Returns a boolean indicating whether the command is supported for the area specified on the ActionSupportFilter argument.
 void setEventSource(java.lang.Object eventSource)
          Allows setting of the event source.
 void setFolderName(java.lang.String folder)
          Sets the name of the folder to be opened.
 void setModel(RemoteFileServerModelInterface model)
          Sets the model attribute value.
 void setPath(java.lang.String path)
          Sets the currently viewed file path attribute.
 
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
 

Field Detail

RB_KEY

public static final java.lang.String RB_KEY
the resource key

See Also:
Constant Field Values
Constructor Detail

OpenFolderCommand

public OpenFolderCommand()
Constructor


OpenFolderCommand

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

Parameters:
name - the command name

OpenFolderCommand

public OpenFolderCommand(java.lang.String name,
                         java.lang.String actionClass)
Constructor that accepts a command name and an action class type

Parameters:
name - the command name
actionClass - the action class type
Method Detail

execute

public void execute(java.lang.Object o)
             throws java.lang.IllegalArgumentException
Opens the selected folder and displays the folder contents.

Specified by:
execute in interface com.sas.util.SimpleCommand
Specified by:
execute in class BaseCommand
Parameters:
o - the object where the command is executed.
Throws:
java.lang.IllegalArgumentException

setPath

public void setPath(java.lang.String path)
Sets the currently viewed file path attribute.

Parameters:
path - the current file path
See Also:
getPath()

getPath

public java.lang.String getPath()
Returns the currently viewed file path attribute.

Returns:
the current file path
See Also:
setPath(String)

setFolderName

public void setFolderName(java.lang.String folder)
Sets the name of the folder to be opened.

Parameters:
folder - the name of the folder
See Also:
getFolderName()

getFolderName

public java.lang.String getFolderName()
Returns the name of the folder to be opened.

Returns:
the folder name
See Also:
setFolderName(String)

setModel

public void setModel(RemoteFileServerModelInterface model)
Sets the model attribute value.

Parameters:
model - the model used by the command
See Also:
getModel()

getModel

public RemoteFileServerModelInterface getModel()
Returns the model attribute value.

Returns:
the model used by the command
See Also:
setModel(RemoteFileServerModelInterface)

isContentsChanged

public boolean isContentsChanged()
Tests whether the contents are changed.

Specified by:
isContentsChanged in interface ContentsChangedInterface
Returns:
true = contents are changed

getEventInfo

public java.util.HashMap getEventInfo()
Returns information about the command.

Specified by:
getEventInfo in interface ContentsChangedInterface
Returns:
a HashMaP containing the path where the copy took place

getEventSource

public java.lang.Object getEventSource()
Returns the event source item "path".

Specified by:
getEventSource in interface ContentsChangedInterface
Returns:
the event source
See Also:
setEventSource(Object)

setEventSource

public void setEventSource(java.lang.Object eventSource)
Allows setting of the event source.

Parameters:
eventSource - the item to set as the event source
See Also:
getEventSource()

isSupported

public boolean isSupported(ActionSupportFilter actionFilter)
Returns a boolean indicating whether the command is supported for the area specified on the ActionSupportFilter argument. The implementation on this class always return true. Extensions of this class should override this method if there are conditions where the command may not be available or supported.

Specified by:
isSupported in interface CommandSupportedInterface
Parameters:
actionFilter - The object that describes the current area.
Returns:
a boolean indicating whether the command is supported.
See Also:
BaseAction.setReturnStatus(int)



Copyright © 2009 SAS Institute Inc. All Rights Reserved.