CMSReceiptData (BlackBerry JDE 5.0.0 API Reference)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

net.rim.device.api.crypto.cms
Class CMSReceiptData

java.lang.Object
  net.rim.device.api.crypto.cms.CMSReceiptData

All Implemented Interfaces:: Persistable, Persistable

public final class CMSReceiptData
extends Object
implements Persistable
extends Object
implements Persistable

A class containing information required to verify a signed receipt. This class would be passed to a CMSSignedDataInputStream, if it contained a Signed Receipt, in order to verify the receipt.

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.0.0

Method Summary
	`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
	`Persistable`	`getUserData()` Gets the additional user data previously stored about the signed receipt.
	`void`	`setUserData(Persistable userData)` Sets some user data to allow the developer to store additional information about the signed receipt.

Methods inherited from class java.lang.Object
`getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Method Detail

setUserData

public void setUserData(Persistable userData)

Sets some user data to allow the developer to store additional information about the signed receipt. For example, the user may choose to store the date of the secure receipt, or the subject of the message.

Parameters:: userData - the additional data to store
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.0.0

getUserData

public Persistable getUserData()

Gets the additional user data previously stored about the signed receipt.

Returns:: the additional user data. May return null.
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.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:

It is reflexive: for any reference value x, x.equals(x) should return true.
It is symmetric: for any reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the object is modified.
For any non-null reference value x, x.equals(null) should return false.

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.0.0