| java.lang.Object | |
| ↳ | com.neomades.contact.ContactResult |
Class Overview
Represents object return by ContactResultListener listener when
operations of ContactManager or ContactDatabase are launched.
This object contains all informations form the operation as :
- The data resulting of the operation with
getData()(it may be aContactobject, a vector ofContactor null, depending on the operation type). - The operation type which has been reached with
getResultType()(for example foraddContact(ContactResultListener)method the result type of theContactResultListenerwill beTYPE_ADD). - The associated operation message which can be SUCCESS, CANCELLED or ERROR
with
getMessage(). - The result state of the operation:
isSuccess()andisCancelled().
Summary
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| int | TYPE_ADD | addContact(ContactResultListener),
addContact(Contact, ContactResultListener) or
save(Contact, ContactResultListener) operation type
|
|||||||||
| int | TYPE_DELETE | delete(Contact, ContactResultListener) operation type
|
|||||||||
| int | TYPE_EDIT | editContact(Contact, ContactResultListener) or
save(Contact, ContactResultListener) operation type
|
|||||||||
| int | TYPE_GET_ALL | getAllContacts(ContactResultListener) operation type
|
|||||||||
| int | TYPE_PICK_SINGLE | pickSingleContact(ContactResultListener) operation
type
|
|||||||||
| int | TYPE_SHOW | showContact(Contact, ContactResultListener) operation
type
|
|||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Object |
getData()
Returns operation's associated data.
| ||||||||||
| String |
getMessage()
Returns the associated message.
| ||||||||||
| int |
getResultType()
Returns the associated result type.
| ||||||||||
| boolean |
isCancelled()
Returns true if the operation has been cancelled by the user, false if the
operation is a success or has failed.
| ||||||||||
| boolean |
isSuccess()
Returns true if the operation is a success, false if there is an error or has
been cancelled.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Constants
public static final int TYPE_ADD
addContact(ContactResultListener),
addContact(Contact, ContactResultListener) or
save(Contact, ContactResultListener) operation type
public static final int TYPE_DELETE
delete(Contact, ContactResultListener) operation type
public static final int TYPE_EDIT
public static final int TYPE_GET_ALL
getAllContacts(ContactResultListener) operation type
public static final int TYPE_PICK_SINGLE
pickSingleContact(ContactResultListener) operation
type
public static final int TYPE_SHOW
showContact(Contact, ContactResultListener) operation
type
Public Methods
public Object getData ()
Returns operation's associated data.
If getResultType()'s return is TYPE_SHOW, it returns
null.
Otherwise it returns a single Contact object.
Returns
- an
Object(aContactor aVector). If the user doesn't select any contact, it returnsnull.
public String getMessage ()
Returns the associated message.
If isSuccess() returns true or getResultType()
returns TYPE_SHOW, the message is "SUCCESS".
If isCancelled() returns true, the message is
"CANCELLED".
Otherwise, returns the error message details.
Returns
- a message
public int getResultType ()
Returns the associated result type.
TYPE_ADD, TYPE_PICK_SINGLE, TYPE_EDIT or
TYPE_SHOW.
Returns
- the result type constant
public boolean isCancelled ()
Returns true if the operation has been cancelled by the user, false if the operation is a success or has failed.
Returns
- true if
ContactManager's orContactDatabase's operation is cancelled by the user.
public boolean isSuccess ()
Returns true if the operation is a success, false if there is an error or has
been cancelled.
Note: If getResultType() returns TYPE_SHOW, the
method returns always true.
Returns
- true if
ContactManager's orContactDatabase's operation is a success.