com.docomo_um.module.net
クラス AreaMailBox

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

public class AreaMailBox
extends MessageBox

エリアメール（CBS・ETWS）のメッセージボックスを表すクラスです。

フィールドの概要

static java.lang.String	DELETE_TYPE_ALL エリアメールの削除種別の一つで、すべてのメッセージ削除を表します。
static java.lang.String	DELETE_TYPE_READ エリアメールの削除種別の一つで、既読メッセージの削除を表します。

クラス com.docomo_um.module.net.MessageBox から継承されたフィールド

BOX_TYPE_AREA_MAIL, BOX_TYPE_SHORT_MESSAGE, BOX_TYPE_SMS_STATUS_REPORT

メソッドの概要

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

クラス com.docomo_um.module.net.MessageBox から継承されたメソッド

getType

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

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

フィールドの詳細

DELETE_TYPE_READ

public static final java.lang.String DELETE_TYPE_READ

エリアメールの削除種別の一つで、既読メッセージの削除を表します。

関連項目:

delete(String), 定数フィールド値

DELETE_TYPE_ALL

public static final java.lang.String DELETE_TYPE_ALL

エリアメールの削除種別の一つで、すべてのメッセージ削除を表します。

関連項目:

delete(String), 定数フィールド値

メソッドの詳細

get

public ShortMessage get(int messageNumber)
                 throws DeviceException,
                        ShortMessageException

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

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

定義:

クラス MessageBox 内の get

パラメータ:

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

戻り値:

メッセージを返します。

例外:

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

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

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

get

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

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

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

定義:

クラス MessageBox 内の get

パラメータ:

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

戻り値:

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

例外:

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

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

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

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

関連項目:

ShortMessage.STAT_READ, ShortMessage.STAT_UNREAD

delete

public void delete(int messageNumber)
            throws DeviceException,
                   ShortMessageException

クラス MessageBox の記述:

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

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

定義:

クラス MessageBox 内の delete

パラメータ:

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

例外:

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

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

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

delete

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

クラス MessageBox の記述:

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

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

定義:

クラス MessageBox 内の delete

パラメータ:

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

例外:

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

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

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

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

関連項目:

DELETE_TYPE_READ, DELETE_TYPE_ALL

getTotalMessageNumber

public int getTotalMessageNumber()
                          throws DeviceException,
                                 ShortMessageException

メッセージボックスに保存可能なメッセージの総数を取得します。

戻り値:

メッセージボックスに保存可能なメッセージの総数を返します。

例外:

DeviceException - デバイスの故障により、保存可能なメッセージ総数を取得できなかった場合に発生します。

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

getSavedMessageNumber

public int getSavedMessageNumber()
                          throws DeviceException,
                                 ShortMessageException

メッセージボックスに保存されているメッセージの数を取得します。

戻り値:

メッセージボックスに保存されているメッセージの数を返します。

例外:

DeviceException - デバイスの故障により、保存されているメッセージの数を取得できなかった場合に発生します。

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