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

すべてのスーパーインタフェース:
PhoneData

public interface AddressBook
extends PhoneData

アドレス帳を扱うためのインタフェースです。

アドレス帳はPhoneDataConnectorクラスを使用して以下のように取得してください。

   AddressBook addressBook = (AddressBook)PhoneDataConnector.openPhoneData("AddressBook", 0);
 
インタフェース com.j_phone.phonedata.PhoneData から継承したメソッド delete は使用できません。使用した場合 java.io.IOException が発生します。

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

フィールドの概要
static int GROUP_SEARCH
          elements()に指定する検索方法で、グループ検索を表します。
static int KANA_SEARCH
          elements()に指定する検索方法で、行(50音)検索を表します。
static int MAIL_ADDRESS_SEARCH
          elements()に指定する検索方法で、メールアドレス検索を表します。
static int NUMBER_SEARCH
          elements()に指定する検索方法で、電話番号検索を表します。
 
インタフェース com.j_phone.phonedata.PhoneData から継承したフィールド
SORT_ASCENDING, SORT_DESCENDING
 
メソッドの概要
 DataEnumeration elements(int type, java.lang.String searchString, int from, int max)
          検索条件に該当する要素を列挙するオブジェクトを返します。
 java.lang.String getGroupName(int groupNo)
          グループ名を取得します。
 int[] getGroupNoList()
          すべてのグループ番号を取得します。
 int getMailAddressMaxCount()
          1件のアドレスデータに登録できるメールアドレスの件数を取得します。
 int getPhoneNumberMaxCount()
          1件のアドレスデータに登録できる電話番号の件数を取得します。
 
インタフェース com.j_phone.phonedata.PhoneData から継承したメソッド
close, createElement, delete, elements, exportElementRawData, getListMaxCount, getListType, importElementRawData
 

フィールドの詳細

GROUP_SEARCH

public static final int GROUP_SEARCH
elements()に指定する検索方法で、グループ検索を表します。

KANA_SEARCH

public static final int KANA_SEARCH
elements()に指定する検索方法で、行(50音)検索を表します。

NUMBER_SEARCH

public static final int NUMBER_SEARCH
elements()に指定する検索方法で、電話番号検索を表します。

MAIL_ADDRESS_SEARCH

public static final int MAIL_ADDRESS_SEARCH
elements()に指定する検索方法で、メールアドレス検索を表します。
メソッドの詳細

getGroupNoList

public int[] getGroupNoList()
                     throws java.io.IOException
すべてのグループ番号を取得します。

アドレス帳に存在するすべてのグループのグループ番号を取得します。

戻り値:
グループ番号を収めた配列
例外:
java.io.IOException - 入出力エラーの場合発生する

getGroupName

public java.lang.String getGroupName(int groupNo)
                              throws java.io.IOException
グループ名を取得します。

引数groupNoに指定されたグループ番号に対応するグループ名を返します。 存在しないグループ番号が指定された場合は null を返します。

パラメータ:
groupNo - グループ番号
戻り値:
グループ名
例外:
java.io.IOException - 入出力エラーの場合発生する

getPhoneNumberMaxCount

public int getPhoneNumberMaxCount()
                           throws java.io.IOException
1件のアドレスデータに登録できる電話番号の件数を取得します。 この値は機種に依存します。
戻り値:
登録可能件数
例外:
java.io.IOException - 入出力エラーの場合発生する

getMailAddressMaxCount

public int getMailAddressMaxCount()
                           throws java.io.IOException
1件のアドレスデータに登録できるメールアドレスの件数を取得します。 この値は機種に依存します。
戻り値:
登録可能件数
例外:
java.io.IOException - 入出力エラーの場合発生する

elements

public DataEnumeration elements(int type,
                                java.lang.String searchString,
                                int from,
                                int max)
                         throws java.io.IOException
検索条件に該当する要素を列挙するオブジェクトを返します。

引数typeに指定された検索条件に該当する要素を列挙するDataEnumerationオブジェクトを戻り値として返します。 検索は引数fromに指定された位置から開始します。検索結果の要素を列挙する数は最大で引数maxに指定された数です。

検索方法と引数typeとsearchStringに指定する内容を以下に示します。

検索方法 typeに指定する値 searchStringに指定する内容 内容
グループ検索 GROUP_SEARCH グループ番号 グループに属しているアドレスデータを検索
行(50音)検索 KANA_SEARCH 50音の各行の先頭1文字(ア行、カ行、サ行等)、英数("A")、その他("*")のどれかを半角で指定 フリガナの先頭1文字が指定された行に属しているアドレスデータを検索
機器が英数検索に対応していない場合は、その他として検索
電話番号検索 NUMBER_SEARCH 電話番号 該当するアドレスデータを検索
該当データが複数存在した場合は最初に見つけた1件だけを返す
メールアドレス検索 MAIL_ADDRESS_SEARCH メールアドレス 該当するアドレスデータを検索
該当データが複数存在した場合は最初に見つけた1件だけを返す

ネイティブシステムのシークレットモードがOFFになっている場合、 シークレット属性がtrueに設定されたアドレスデータはJavaアプリケーションからは取得できません。

パラメータ:
type - 検索方法
searchString - 検索キーワード
from - 検索結果より取得する要素の開始位置(先頭は 0 )
max - 検索結果より取得可能とする要素の数。最大値はPhoneData.getListMaxCount()メソッドが返す値。
戻り値:
要素の列挙オブジェクト
例外:
NullPointerException - 引数searchStringがnullの場合に発生する
java.lang.IllegalArgumentException - 引数が不正な場合に発生する
java.io.IOException - 検索に失敗した場合に発生する