com.j_phone.phonedata
インタフェース PhoneData

既知のサブインタフェースの一覧:
AddressBook, ReceivedMailBox, SentMailBox

public interface PhoneData

ネイティブシステムに保持される電話関連情報リストを扱うためのインタフェースです。

導入されたバージョン:
JSCL 1.2

フィールドの概要
static int SORT_ASCENDING
          ソート種別で、昇順を示します。
static int SORT_DESCENDING
          ソート種別で、降順を示します。
 
メソッドの概要
 void close()
          電話関連情報リスト(受信メールボックス、送信メールボックス、またはアドレス帳)を閉じます。
 void createElement(DataElement element)
          電話関連情報リスト内に新しい要素を登録します。
 void delete(DataElement element)
          電話関連情報リスト内の要素を削除します。
 DataEnumeration elements(int position, int max, int sortType)
          リストの要素を列挙するオブジェクトを返します。
 byte[] exportElementRawData(DataElement exportElement)
          電話関連情報リスト内の要素を規定の形式でエクスポートします。
 int getListMaxCount()
          要素の列挙オブジェクト取得時に一度に取得できる要素数の最大値を取得します。
 java.lang.String getListType()
          このインスタンスが操作する電話関連情報リストの種別を取得します。
 void importElementRawData(byte[] data)
          規定の形式のデータをリスト内にインポートします。
 

フィールドの詳細

SORT_ASCENDING

public static final int SORT_ASCENDING
ソート種別で、昇順を示します。

SORT_DESCENDING

public static final int SORT_DESCENDING
ソート種別で、降順を示します。
メソッドの詳細

close

public void close()
電話関連情報リスト(受信メールボックス、送信メールボックス、またはアドレス帳)を閉じます。

getListType

public java.lang.String getListType()
このインスタンスが操作する電話関連情報リストの種別を取得します。
戻り値:
電話関連情報リストの種別

elements

public DataEnumeration elements(int position,
                                int max,
                                int sortType)
                         throws java.io.IOException
リストの要素を列挙するオブジェクトを返します。

受信メールボックスまたは送信メールボックスに対して実行された時は、 受信(送信)日時によるsortType指定順に要素の列挙を取得します。 アドレス帳に対して実行された時は、sortType指定にかかわらずメモリダイヤル番号の昇順に要素の列挙を取得します。

パラメータ:
position - 検索結果より取得する要素の開始位置(先頭は 0 )
max - 検索結果より取得可能とする要素の数。最大値はgetListMaxCount()で取得する値。
sortType - 取得するリストのソート種別(アドレス帳指定時には無効)
戻り値:
要素の列挙オブジェクト
例外:
java.lang.IllegalArgumentException - 引数が不正な場合に発生する
java.io.IOException - 一覧取得に失敗した場合に発生する

createElement

public void createElement(DataElement element)
                   throws java.io.IOException
電話関連情報リスト内に新しい要素を登録します。

新規作成したアドレスデータに設定したメモリダイヤル番号が、アドレス帳に存在する場合は登録できません。

パラメータ:
element - 追加する要素
例外:
NullPointerException - 引数elementが null の場合に発生する
java.io.IOException - アドレス帳以外に対して実行した場合、または登録に失敗した場合に発生する
SecurityException - 指定されたメモリダイヤル番号にシークレット状態の要素が存在した、またはユーザーキャンセルの場合に発生する

delete

public void delete(DataElement element)
            throws java.io.IOException
電話関連情報リスト内の要素を削除します。

アドレス帳には使用できません。

パラメータ:
element - 削除する要素
例外:
NullPointerException - 引数elementが null の場合に発生する
java.io.IOException - アドレス帳に対して実行した場合、または削除に失敗した場合に発生する
SecurityException - 削除する要素がシークレット状態、またはユーザーキャンセルの場合に発生する

importElementRawData

public void importElementRawData(byte[] data)
                          throws java.io.IOException
規定の形式のデータをリスト内にインポートします。

現在、サポートしているのは vCard 形式データのアドレス帳リストへのインポートです。

パラメータ:
data - インポートする要素
例外:
NullPointerException - 引数dataが null の場合に発生する
java.io.IOException - アドレス帳リスト以外に対して実行した場合、またはインポートに失敗した場合に発生する
SecurityException - インポート先に指定したメモリダイヤル番号にシークレット状態の要素が存在した場合に発生する

exportElementRawData

public byte[] exportElementRawData(DataElement exportElement)
                            throws java.io.IOException
電話関連情報リスト内の要素を規定の形式でエクスポートします。

現在、サポートしているのはアドレス帳リストデータの vCard 形式データへのエクスポートです。

パラメータ:
exportElement - エクスポートする要素
戻り値:
エクスポートされたバイト配列
例外:
NullPointerException - 引数exportElementが null の場合に発生する
java.io.IOException - アドレス帳リスト以外に対して実行した場合、またはエクスポートに失敗した場合に発生する
SecurityException - エクスポートする要素がシークレット状態の場合に発生する

getListMaxCount

public int getListMaxCount()
                    throws java.io.IOException
要素の列挙オブジェクト取得時に一度に取得できる要素数の最大値を取得します。 elements()メソッドの引数に指定する、取得する要素の最大数として使用します。

この値は機種に依存します。

戻り値:
最大要素数
例外:
java.io.IOException - 入出力エラーの場合発生する