Package hec.appInterface

Interface Application

public interface Application

  • Method Details

    • getWorkspace

      Workspace getWorkspace()
      Returns the currently opened workspace
      Returns:
      the currently opened workspace or null if now workspace is opened

    • getFrame

      ApplicationFrame getFrame()
      Return the main application frame
      Returns:
      The main application frame

    • getUser

      String getUser()
      get the userId. If the application has no userId concept then returning System.getProperty("user.name") is sufficent.
      Returns:
      The userId

    • getAppType

      String getAppType()
      Get the type of application, which in the CWMS client/server framework is also the name of the child RMI workspace. Example: ResSim returns "rss"
      Returns:
      The application type

    • getClientUnitSystem

      int getClientUnitSystem()
      get the unit system for the current watershed
      Returns:
      The current watershed's unit system
      See Also:

    • downLoadParameterFile

      Identifier downLoadParameterFile()
      download the Parameter file
      Returns:
      the Identifier of where the Parameter file resides.

    • downLoadUnitsFile

      Identifier downLoadUnitsFile()
      download the Units file
      Returns:
      the Identifier of where the Units file resides.

    • postError

      void postError(String msg, String title)
      display an Error type message to the user
      Parameters:
      msg - the message to display
      title - the title of the dialog

    • isNetworked

      boolean isNetworked()
      return whether this Application is networked or not

    • getWorkingDir

      String getWorkingDir()
      get the working directory for the application
      Returns:
      the applications working directory.

    • getApplicationProperty

      String getApplicationProperty(String key)
      Searches for the property with the specified key in the Applications property list. If the key is not found in the Applications property list then the method returns null.
      Parameters:
      key - the property key
      Returns:
      the value in the Application's property list with the specified key value.