com.starbase.starteam
Class ForeignPasswordException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--java.lang.RuntimeException
                    |
                    +--com.starbase.starteam.ServerException
                          |
                          +--com.starbase.starteam.ForeignPasswordException

All Implemented Interfaces:

java.io.Serializable

public class ForeignPasswordException

extends ServerException

An exception that is raised when a server operation on a foreign archive fails because the foreign password has not been provided.

See Also:

Server.setForeignPassword(com.starbase.starteam.Project), Server.setForeignPasswordExplicit(java.lang.String, int, java.lang.String), Serialized Form

Method Summary

boolean	equals(java.lang.Object source) returns true if this object instance is equal to the source
java.lang.String	getConfigPath() Gets the path to the foreign archive.
java.lang.String	getMessage() Returns the detail message string of this throwable.
int	getProjectType() Gets the foreign project type.
int	hashCode() returns a unique hash for all instances of this type
boolean	isPVCS() Determines whether or not the foreign archive is PVCS.
boolean	isVSS() Determines whether or not the foreign archive is Visual Source Safe.

Methods inherited from class com.starbase.starteam.ServerException

forError, getAuxData, getAuxKeys, getClassName, getErrorCode, getErrorMessage, getErrorSource, getLogEntry, getNonLocalizedMessage, getTimeLogged, isLogged, setErrorMessage, toString

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getConfigPath

public java.lang.String getConfigPath()

Gets the path to the foreign archive.

Returns:

The path to the foreign archive.

getProjectType

public int getProjectType()

Gets the foreign project type.

Returns:

The foreign project type.

See Also:

PropertyEnums.PROJECT_TYPE_PVCS, PropertyEnums.PROJECT_TYPE_VISUAL_SOURCESAFE

isPVCS

public boolean isPVCS()

Determines whether or not the foreign archive is PVCS.

Returns:

true if the foreign archive is PVCS; false otherwise.

See Also:

ForeignPasswordException.isVSS()

isVSS

public boolean isVSS()

Determines whether or not the foreign archive is Visual Source Safe.

Returns:

true if the foreign archive is Visual Source Safe; false otherwise.

See Also:

ForeignPasswordException.isPVCS()

equals

public boolean equals(java.lang.Object source)

returns true if this object instance is equal to the source

Overrides:

equals in class ServerException

Parameters:

source - Object the source to comapre with

Returns:

boolean true if this object is equal to the source

hashCode

public int hashCode()

returns a unique hash for all instances of this type

Overrides:

hashCode in class ServerException

Returns:

int a unique hash for all instances of this type

getMessage

public java.lang.String getMessage()

Returns the detail message string of this throwable.

Overrides:

getMessage in class ServerException

Returns:

the detail message string of this Throwable instance (which may be null).