hec.environment
Interface StdPathnames

All Superinterfaces:
StdPathnameConstants
All Known Subinterfaces:
Environment, RmiEnvironment
All Known Implementing Classes:
CwmsEnvironmentImpl, EnvironmentImpl, RmiCwmsEnvironmentImpl, RmiEnvironmentImpl

public interface StdPathnames
extends StdPathnameConstants

Interface for retrieving local-computer pathnames based on symbolic constants.


Field Summary
 
Fields inherited from interface hec.environment.StdPathnameConstants
COMMON_APPDATA, COMMON_DOCS, PROGRAM_INSTALL, USER_APPDATA, USER_DOCS, USER_HOME
 
Method Summary
 java.lang.String getCommonAppData()
          Get the operating-system dependent shared application data pathname.
 java.lang.String getCommonDocs()
          Get the operating-system dependent shared docuements pathname.
 java.lang.String getProgramInstall()
          Get the operating-system dependent program installation pathname.
 java.lang.String getStdPathname(int pathname_id)
          Get the operating-system dependent pathname represented by the pathname_id.
 java.lang.String getUserAppData()
          Get the operating-system dependent user application data pathname.
 java.lang.String getUserDocs()
          Get the operating-system dependent user docuements pathname.
 java.lang.String getUserHome()
          Get the operating-system dependent user home pathname.
 

Method Detail

getStdPathname

public java.lang.String getStdPathname(int pathname_id)
                                throws java.lang.Exception
Get the operating-system dependent pathname represented by the pathname_id.

Parameters:
pathname_id - The constant representing the desired pathname.
Returns:
The desired pathname.
Throws:
java.lang.Exception

getUserHome

public java.lang.String getUserHome()
                             throws java.lang.Exception
Get the operating-system dependent user home pathname.

Returns:
The user home pathname.
Throws:
java.lang.Exception

getUserAppData

public java.lang.String getUserAppData()
                                throws java.lang.Exception
Get the operating-system dependent user application data pathname.

Returns:
The user application data pathname.
Throws:
java.lang.Exception

getUserDocs

public java.lang.String getUserDocs()
                             throws java.lang.Exception
Get the operating-system dependent user docuements pathname.

Returns:
The user documents pathname.
Throws:
java.lang.Exception

getCommonAppData

public java.lang.String getCommonAppData()
                                  throws java.lang.Exception
Get the operating-system dependent shared application data pathname.

Returns:
The shared application data pathname.
Throws:
java.lang.Exception

getCommonDocs

public java.lang.String getCommonDocs()
                               throws java.lang.Exception
Get the operating-system dependent shared docuements pathname.

Returns:
The shared documents pathname.
Throws:
java.lang.Exception

getProgramInstall

public java.lang.String getProgramInstall()
                                   throws java.lang.Exception
Get the operating-system dependent program installation pathname.

Returns:
The program installation pathname.
Throws:
java.lang.Exception