net.rim.device.api.smartcard
Class SmartCardID

java.lang.Object
  extended by net.rim.device.api.smartcard.SmartCardID
All Implemented Interfaces:
Persistable

public final class SmartCardID
extends Object
implements Persistable

A class to represent a specific smart card within a family of smart cards.

See Also:
SmartCard
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.1.0

Constructor Summary
Category: Signed SmartCardID(long id, String label, SmartCard smartCard)
          Constructs a SmartCardID object.
Category: Signed SmartCardID(long id, String label, SmartCard smartCard, String readerName)
          Constructs a SmartCardID object.
 
Method Summary
Category: Signed  boolean equals(Object obj)
          Indicates whether some other object is "equal to" this one.
Category: Signed  long getID()
          Returns the unique identifier.
Category: Signed  String getLabel()
          Returns a human readable String that identifies this specific smart card to the user.
Category: Signed  SmartCard getSmartCard()
          Returns the family of smart cards that this specific card is a member of.
Category: Signed  String getSmartCardReaderName()
          Returns the name of the smart card reader used to read this specific card.
Category: Signed  int hashCode()
          Returns a hash code value for the object.
Category: Signed  void setSmartCardReaderName(String readerName)
          Sets the name of the smart card reader used to read this specific card.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 



Constructor Detail

SmartCardID

public SmartCardID(long id,
                   String label,
                   SmartCard smartCard)
Constructs a SmartCardID object.

Parameters:
id - A unique number identifying a particular smart card. For example a personel number.
label - A human readable String that identifies this specific smart card to the user. For example, the type of card and name of the card holder, "Visa: Michael Adams".
smartCard - The class of smart cards that this specific card is a instance of.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.1.0

SmartCardID

public SmartCardID(long id,
                   String label,
                   SmartCard smartCard,
                   String readerName)
Constructs a SmartCardID object.

Parameters:
id - A unique number identifying a particular smart card. For example a personel number.
label - A human readable String that identifies this specific smart card to the user. For example, the type of card and name of the card holder, "Visa: Michael Adams".
smartCard - The class of smart cards that this specific card is a instance of.
reader - The name of the reader used to read this specific card.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 5.0.0


Method Detail

getID

public long getID()
Returns the unique identifier.

Returns:
A long representing the ID.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.1.0

getLabel

public String getLabel()
Returns a human readable String that identifies this specific smart card to the user.

Returns:
A String representing the label.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.1.0

getSmartCard

public SmartCard getSmartCard()
Returns the family of smart cards that this specific card is a member of.

Returns:
A SmartCard.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.1.0

getSmartCardReaderName

public String getSmartCardReaderName()
Returns the name of the smart card reader used to read this specific card.

Returns:
A SmartCardReader.
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 5.0.0

setSmartCardReaderName

public void setSmartCardReaderName(String readerName)
Sets the name of the smart card reader used to read this specific card.

Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 5.0.0

equals

public boolean equals(Object obj)
Description copied from class: Object
Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation:

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any reference values x and y, this method returns true if and only if x and y refer to the same object (x==y has the value true).

Overrides:
equals in class Object
Parameters:
obj - the reference object with which to compare.
Returns:
true if this object is the same as the obj argument; false otherwise.
See Also:
Boolean.hashCode(), Hashtable
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.1.0

hashCode

public int hashCode()
Description copied from class: Object
Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

The general contract of hashCode is:

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)

Overrides:
hashCode in class Object
Returns:
a hash code value for this object.
See Also:
Object.equals(java.lang.Object), Hashtable
Category:
Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:
BlackBerry API 4.1.0





Copyright 1999-2010 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.