be.fedict.commons.eid.client.spi

Interface BeIDCardsUI

All Known Implementing Classes:

BeIDCardsIUAdapter

public interface BeIDCardsUI

implement a BeIDCardsUI to interact with the user with an instance of BeIDCards.

Author:

Frank Marien

Method Summary

Modifier and Type	Method and Description
void	adviseBeIDCardRemovalRequired() The user needs to remove a BeID Card for security reasons.
void	adviseBeIDCardRequired() The user needs to insert a BeID Card.
void	adviseCardTerminalRequired() The user needs to connect a Card Terminal, since there are none
void	adviseEnd() No more user actions are required, at this point.
void	eIDCardInsertedDuringSelection(BeIDCard card) user added a BeID card while selectBeIDCard() was blocking.
void	eIDCardRemovedDuringSelection(BeIDCard card) user removed a BeID card while selectBeIDCard() was blocking.
Locale	getLocale() get the Locale currently set.
BeIDCard	selectBeIDCard(Collection<BeIDCard> availableCards) user has multiple eID Cards inserted and needs to choose exactly one. throws CancelledException if user cancels throws OutOfCardsException if all cards removed before selection could be made.
void	setLocale(Locale newLocale) set Locale for subsequent operations.

Method Detail

setLocale

void setLocale(Locale newLocale)

set Locale for subsequent operations. Implementations MUST ensure that after this call, any of the obtainXXX and adviseXXX methods for the same instance respect the locale set here. Implementations MAY choose to update any interface elements already facing the user at time of call, but this is not required.

Parameters:

newLocale -

getLocale

Locale getLocale()

get the Locale currently set.

Returns:

the current Locale for this UI

adviseCardTerminalRequired

void adviseCardTerminalRequired()

The user needs to connect a Card Terminal, since there are none

adviseBeIDCardRequired

void adviseBeIDCardRequired()
                     throws CancelledException

The user needs to insert a BeID Card. There are card terminals, but none currently holds a BeID card.

Throws:

CancelledException

adviseBeIDCardRemovalRequired

void adviseBeIDCardRemovalRequired()

The user needs to remove a BeID Card for security reasons.

adviseEnd

void adviseEnd()

No more user actions are required, at this point.

selectBeIDCard

BeIDCard selectBeIDCard(Collection<BeIDCard> availableCards)
                 throws CancelledException,
                        OutOfCardsException

user has multiple eID Cards inserted and needs to choose exactly one. throws CancelledException if user cancels throws OutOfCardsException if all cards removed before selection could be made.

Parameters:

availableCards -

Returns:

Throws:

CancelledException

OutOfCardsException

eIDCardInsertedDuringSelection

void eIDCardInsertedDuringSelection(BeIDCard card)

user added a BeID card while selectBeIDCard() was blocking. An implementation should update the list of cards, if possible.

Parameters:

card - the card just inserted.

eIDCardRemovedDuringSelection

void eIDCardRemovedDuringSelection(BeIDCard card)

user removed a BeID card while selectBeIDCard() was blocking. An implementation should update the list of cards, if possible.

Parameters:

card - the card just removed.