All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.calypsonet.terminal.reader.selection.CardSelectionResult Maven / Gradle / Ivy

/* **************************************************************************************
 * Copyright (c) 2021 Calypso Networks Association https://calypsonet.org/
 *
 * See the NOTICE file(s) distributed with this work for additional information
 * regarding copyright ownership.
 *
 * This program and the accompanying materials are made available under the terms of the
 * Eclipse Public License 2.0 which is available at http://www.eclipse.org/legal/epl-2.0
 *
 * SPDX-License-Identifier: EPL-2.0
 ************************************************************************************** */
package org.calypsonet.terminal.reader.selection;

import java.util.Map;
import org.calypsonet.terminal.reader.selection.spi.CardSelection;
import org.calypsonet.terminal.reader.selection.spi.SmartCard;

/**
 * Result of a selection process.
 *
 * 

Each selection case prepared with the card selection manager is associated with an index * corresponding to its rank in the order of preparation.
* The same index is used here to find out which selection cases were successful.
* However, only one case will correspond to the selected card state. The getters of this interface * allow to make use of these results according to the configurations and the needs of the * application. * * @since 1.0 */ public interface CardSelectionResult { /** * Gets all {@link SmartCard} corresponding to all successful selection cases in a map for which * the key is the selection index provided by the {@link * CardSelectionManager#prepareSelection(CardSelection)} method. * * @return A not null but possibly empty map. * @since 1.0 */ Map getSmartCards(); /** * Gets the active matching card. I.e. the card that has been selected. * * @return Null if there is no active card. * @since 1.0 */ SmartCard getActiveSmartCard(); /** * Gets the index of the active selection if any. * * @return A positive value if there is an active selection, -1 if there is no active selection. * @since 1.0 */ int getActiveSelectionIndex(); }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy