com.docomo_um.module.net
クラス MessageBox

java.lang.Object
  com.docomo_um.module.net.MessageBox

直系の既知のサブクラス:

AreaMailBox, ShortMessageBox, SMSStatusReportBox

public abstract class MessageBox
extends java.lang.Object

ショートメッセージ（SMS・CBS・ETWS）のメッセージボックスを表す抽象クラスです。

関連項目:

ShortMessageBox, AreaMailBox, SMSStatusReportBox

フィールドの概要

static java.lang.String	BOX_TYPE_AREA_MAIL メッセージボックス種別の一つで、エリアメール（CBS・ETWS）のメッセージボックスを表します。
static java.lang.String	BOX_TYPE_SHORT_MESSAGE メッセージボックス種別の一つで、SMSメッセージのメッセージボックスを表します。
static java.lang.String	BOX_TYPE_SMS_STATUS_REPORT メッセージボックス種別の一つで、SMSステータスレポートのメッセージボックスを表します。

メソッドの概要

abstract void	delete(int messageNumber) メッセージ番号を指定して、メッセージボックスに保存されているメッセージを削除します。
abstract void	delete(java.lang.String type) メッセージ状態を指定して、メッセージボックスに保存されているメッセージを削除します。
abstract ShortMessage	get(int messageNumber) メッセージ番号を指定して、メッセージボックスに保存されているメッセージを取得します。
abstract java.util.List<ShortMessage>	get(java.lang.String type) メッセージ状態を指定して、メッセージボックスに保存されているメッセージを取得します。
java.lang.String	getType() メッセージボックス種別を取得します。

クラス java.lang.Object から継承されたメソッド

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait

フィールドの詳細

BOX_TYPE_SHORT_MESSAGE

public static final java.lang.String BOX_TYPE_SHORT_MESSAGE

メッセージボックス種別の一つで、SMSメッセージのメッセージボックスを表します。

関連項目:

getType(), 定数フィールド値

BOX_TYPE_AREA_MAIL

public static final java.lang.String BOX_TYPE_AREA_MAIL

メッセージボックス種別の一つで、エリアメール（CBS・ETWS）のメッセージボックスを表します。

関連項目:

getType(), 定数フィールド値

BOX_TYPE_SMS_STATUS_REPORT

public static final java.lang.String BOX_TYPE_SMS_STATUS_REPORT

メッセージボックス種別の一つで、SMSステータスレポートのメッセージボックスを表します。

関連項目:

getType(), 定数フィールド値

メソッドの詳細

getType

public java.lang.String getType()

メッセージボックス種別を取得します。

戻り値:

メッセージボックス種別を返します。

関連項目:

BOX_TYPE_SHORT_MESSAGE, BOX_TYPE_AREA_MAIL, BOX_TYPE_SMS_STATUS_REPORT

get

public abstract ShortMessage get(int messageNumber)
                          throws DeviceException,
                                 ExternalStatusException,
                                 ShortMessageException

メッセージ番号を指定して、メッセージボックスに保存されているメッセージを取得します。

本メソッドにて受信メッセージを取得すると、取得したメッセージは ShortMessage.STAT_READ 状態となります。
本メソッドにて送信メッセージを取得しても、取得したメッセージの状態は変化しません。

パラメータ:

messageNumber - 取得するメッセージのメッセージ番号を指定します。

戻り値:

メッセージを返します。

例外:

java.lang.IllegalArgumentException - 指定したmessageNumberに対応するメッセージが保存されていない場合や、 messageNumberに別の保存領域のメッセージ番号を指定した場合に発生します。

ExternalStatusException - UIMが挿入されていない場合など、正常にメッセージを読み出せなかった場合に発生します。

DeviceException - デバイスの故障により、正常にメッセージを読み出せなかった場合に発生します。

ShortMessageException - 内部エラーにより処理が中断した場合に発生します。

get

public abstract java.util.List<ShortMessage> get(java.lang.String type)
                                          throws DeviceException,
                                                 ExternalStatusException,
                                                 ShortMessageException

メッセージ状態を指定して、メッセージボックスに保存されているメッセージを取得します。

本メソッドにて受信メッセージを取得すると、取得したメッセージは ShortMessage.STAT_READ 状態となります。
本メソッドにて送信メッセージを取得しても、取得したメッセージの状態は変化しません。

パラメータ:

type - 取得するメッセージのメッセージ状態を指定します。

戻り値:

メッセージをリストで返します。メッセージが無い場合は要素数0のリストを返します。

例外:

java.lang.NullPointerException - typeにnullを指定した場合に発生します。

java.lang.IllegalArgumentException - 不正なtypeを指定した場合に発生します。

ExternalStatusException - UIMが挿入されていない場合など、正常にメッセージを読み出せなかった場合に発生します。

DeviceException - デバイスの故障により、正常にメッセージを読み出せなかった場合に発生します。

ShortMessageException - 内部エラーにより処理が中断した場合に発生します。

delete

public abstract void delete(int messageNumber)
                     throws DeviceException,
                            ExternalStatusException,
                            ShortMessageException

メッセージ番号を指定して、メッセージボックスに保存されているメッセージを削除します。

メッセージの削除により、他のメッセージのメッセージ番号が変更されることはありません。

パラメータ:

messageNumber - 削除するメッセージのメッセージ番号を指定します。

例外:

java.lang.IllegalArgumentException - 指定したmessageNumberに対応するメッセージが保存されていない場合や、 messageNumberに別の保存領域のメッセージ番号を指定した場合に発生します。

ExternalStatusException - UIMが挿入されていない場合など、メッセージが削除できなかった場合に発生します。

DeviceException - デバイスの故障により、削除に失敗した場合に発生します。

ShortMessageException - 内部エラーにより処理が中断した場合に発生します。

delete

public abstract void delete(java.lang.String type)
                     throws DeviceException,
                            ExternalStatusException,
                            ShortMessageException

メッセージ状態を指定して、メッセージボックスに保存されているメッセージを削除します。 指定した状態のすべてのメッセージが削除されます。

メッセージの削除により、他のメッセージのメッセージ番号が変更されることはありません。

パラメータ:

type - 削除するメッセージのメッセージ状態を指定します。

例外:

java.lang.NullPointerException - typeにnullを指定した場合に発生します。

java.lang.IllegalArgumentException - 不正なtypeを指定した場合に発生します。

ExternalStatusException - UIMが挿入されていない場合など、メッセージが削除できなかった場合に発生します。

DeviceException - デバイスの故障により、削除に失敗した場合に発生します。

ShortMessageException - 内部エラーにより処理が中断した場合に発生します。