au.org.ala.names.search
Class ExcludedNameException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          au.org.ala.names.search.SearchResultException
              au.org.ala.names.search.ExcludedNameException

All Implemented Interfaces:

java.io.Serializable

public class ExcludedNameException
extends SearchResultException

An exception that is thrown when the match is to a name that has been excluded. A name is typically excluded in the National Species List when it is know not to be included in Australia.

In the BIE we would want to use the match anyway because all excluded names will have a species page.

In the biocache we would want to flag the record and match to the associated record?? OR maybe

Author:

Natasha Carter

See Also:

Serialized Form

Field Summary

Fields inherited from class au.org.ala.names.search.SearchResultException

errorType, results

Constructor Summary

ExcludedNameException(java.lang.String message, NameSearchResult excludedName)

ExcludedNameException(java.lang.String message, NameSearchResult nonExcludedName, NameSearchResult excludedName)
Constructs an ExcludedNameException that represents that we have a match that is excluded and one that is not.

Method Summary

NameSearchResult	getExcludedName()
NameSearchResult	getNonExcludedName()
void	setExcludedName(NameSearchResult excludedName)
void	setNonExcludedName(NameSearchResult nonExcludedName)

Methods inherited from class au.org.ala.names.search.SearchResultException

getErrorType, getResults

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ExcludedNameException

public ExcludedNameException(java.lang.String message,
                             NameSearchResult excludedName)

ExcludedNameException

public ExcludedNameException(java.lang.String message,
                             NameSearchResult nonExcludedName,
                             NameSearchResult excludedName)

Constructs an ExcludedNameException that represents that we have a match that is excluded and one that is not.

Parameters:

message -

nonExcludedName -

excludedName -

Method Detail

getExcludedName

public NameSearchResult getExcludedName()

setExcludedName

public void setExcludedName(NameSearchResult excludedName)

getNonExcludedName

public NameSearchResult getNonExcludedName()

setNonExcludedName

public void setNonExcludedName(NameSearchResult nonExcludedName)