PhoneBookParam (DoJa 3.5 (APIリファレンス))

概要

パッケージ

クラス

階層ツリー

非推奨 API

索引

ヘルプ

前のクラス 次のクラス

フレームあり フレームなし

概要: 入れ子 | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

com.nttdocomo.system
クラス PhoneBookParam

Object
  |
  +--com.nttdocomo.system.PhoneBookParam

すべての実装インタフェース:: PhoneBookConstants

public final class PhoneBookParam
extends Object
implements PhoneBookConstants

電話帳データの新規登録用のパラメータを定義します。

電話帳データを新規に登録するためには、コンストラクタによりPhoneBookParamオブジェクトを生成します。生成したオブジェクトに対して名前等を通常の文字列で設定することができます。グループについてはグループエントリのIDまたは名前を設定することができますが、それらは排他的に設定されます。すなわち、グループIDを指定した場合には既に設定されていたグループ名は破棄されます。グループID -1 とグループ名 null はそれぞれグループを指定しないことを表し、ネイティブの標準のグループが指定されたことになります。

登録は PhoneBook.addEntry(PhoneBookParam) メソッドで行います。登録はネイティブのユーザインタフェースを介して行われ、 addEntryメソッドは登録された電話帳データのエントリID等を返します。

グループ名を指定して電話帳データの登録を行ったときにそのグループ名のグループが存在しない場合、グループ作成画面に移行し、グループ作成が終了してから電話帳データの登録が行われます。グループIDを指定して電話帳データの登録を行ったときにそのグループIDのグループが存在しない場合、例外が発生します。

名前や読み仮名は、姓と名を区別して登録する方法 (setName(int, String) および setKana(int, String))と、区別しないで登録する方法 (setName(String) および setKana(String))があります。これらは(名前と読み仮名に対して独立に)排他的に使用され、一方の方法で指定した内容は、他方の方法で指定すると破棄されます。

導入されたバージョン:: DoJa-3.0
関連項目:: PhoneBook

フィールドの概要

インタフェース com.nttdocomo.system.PhoneBookConstants から継承したフィールド

FAMILY_NAME, GIVEN_NAME

コンストラクタの概要

PhoneBookParam()
          新規登録用に電話帳パラメータを生成します。

PhoneBookParam(String name, String kana, String[] phoneNumbers, String[] mailAddresses, int groupId)
          新規登録用に電話帳パラメータを生成します。

PhoneBookParam(String name, String kana, String[] phoneNumbers, String[] mailAddresses, String groupName)
          新規登録用に電話帳パラメータを生成します。

メソッドの概要

void addMailAddress(String mailAddress)
          電話帳パラメータにメールアドレス(通常文字列)を追加します。

void addPhoneNumber(String phoneNumber)
          電話帳パラメータに電話番号(通常文字列)を追加します。

int getGroupId()
          グループIDを取得します。

String getGroupName()
          グループ名を取得します。

String getKana()
          読み仮名(通常文字列)を取得します。

String getKana(int part)
          姓または名の読み仮名(通常文字列)を取得します。

String getMailAddress(int index)
          メールアドレス(通常文字列)の1つを取得します。

String[] getMailAddresses()
          メールアドレス(通常文字列)を取得します。

String getName()
          名前(通常文字列)を取得します。

String getName(int part)
          姓または名(通常文字列)を取得します。

String getPhoneNumber(int index)
          電話番号(通常文字列)の1つを取得します。

String[] getPhoneNumbers()
          電話番号(通常文字列)を取得します。

void setGroupId(int id)
          グループIDを設定します。

void setGroupName(String name)
          グループ名を設定します。

void setKana(int part, String name)
          姓または名の読み仮名(通常文字列)を設定します。

void setKana(String kana)
          読み仮名(通常文字列)を設定します。

void setMailAddresses(String[] mailAddresses)
          メールアドレス(通常文字列)を設定します。

void setName(int part, String name)
          姓または名(通常文字列)を設定します。

void setName(String name)
          名前(通常文字列)を設定します。

void setPhoneNumbers(String[] phoneNumbers)
          電話番号(通常文字列)を設定します。

クラス Object から継承したメソッド

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

コンストラクタの詳細

PhoneBookParam

public PhoneBookParam()

新規登録用に電話帳パラメータを生成します。
PhoneBookParam(null, null, null, null, -1)と同じです。

PhoneBookParam

public PhoneBookParam(String name,
                      String kana,
                      String[] phoneNumbers,
                      String[] mailAddresses,
                      String groupName)

新規登録用に電話帳パラメータを生成します。パラメータは引数で指定される内容で初期化されます。各引数はnullや長さ0の配列でもかまいません。
パラメータ:: name - 名前(通常文字列)を指定します。姓と名が区別可能な場合、 setName(String) メソッドを呼び出した場合と同じように動作します。; kana - 読み仮名(通常文字列)を指定します。姓と名が区別可能な場合、 setKana(String) メソッドを呼び出した場合と同じように動作します。; phoneNumbers - 電話番号(通常文字列)を配列で指定します。; mailAddresses - メールアドレス(通常文字列)を配列で指定します。; groupName - グループ名を指定します。グループを指定しない場合には、 null を指定します。
例外:: NullPointerException - phoneNumbers、mailAddressesがそれぞれnullで無い場合に、配列の要素にnullが含まれている場合に発生します。; IllegalArgumentException - 電話番号として登録できない文字列が指定された場合、端末がサポートしている長さ以上の電話番号が指定された場合、端末がサポートしている数以上の電話番号が指定された場合に発生します。; IllegalArgumentException - メールアドレスとして登録できない文字列が指定された場合、端末がサポートしている長さ以上のメールアドレスが指定された場合、端末がサポートしている数以上のメールアドレスが指定された場合に発生します。

PhoneBookParam

public PhoneBookParam(String name,
                      String kana,
                      String[] phoneNumbers,
                      String[] mailAddresses,
                      int groupId)

新規登録用に電話帳パラメータを生成します。パラメータは引数で指定される内容で初期化されます。各引数はnullや長さ0の配列でもかまいません。
パラメータ:: name - 名前(通常文字列)を指定します。姓と名が区別可能な場合、 setName(String) メソッドを呼び出した場合と同じように動作します。; kana - 読み仮名(通常文字列)を指定します。姓と名が区別可能な場合、 setKana(String) メソッドを呼び出した場合と同じように動作します。; phoneNumbers - 電話番号(通常文字列)を配列で指定します。; mailAddresses - メールアドレス(通常文字列)を配列で指定します。; groupId - グループIDを指定します。グループを指定しない場合には、 -1 を指定します。
例外:: NullPointerException - phoneNumbers、mailAddressesがそれぞれnullで無い場合に、配列の要素にnullが含まれている場合に発生します。; IllegalArgumentException - 電話番号として登録できない文字列が指定された場合、端末がサポートしている長さ以上の電話番号が指定された場合、端末がサポートしている数以上の電話番号が指定された場合に発生します。; IllegalArgumentException - メールアドレスとして登録できない文字列が指定された場合、端末がサポートしている長さ以上のメールアドレスが指定された場合、端末がサポートしている数以上のメールアドレスが指定された場合に発生します。

メソッドの詳細

getName

public String getName()

名前(通常文字列)を取得します。
setName(String) メソッドまたはコンストラクタで設定した内容を返します。

戻り値:: 名前を返します。設定されていない場合、nullを返します。

setName

public void setName(String name)

名前(通常文字列)を設定します。
このメソッドを呼び出すと、以前にsetName(int, String) メソッドで設定した内容は破棄されます。
姓と名を区別して登録できる端末の場合、姓として登録されます。

パラメータ:: name - 名前を指定します。 nullを指定すると名前が削除されます。

getName

public String getName(int part)

姓または名(通常文字列)を取得します。
setName(int, String) メソッドで設定した内容を返します。

パラメータ:: part - 姓、名の区別を指定します。 FAMILY_NAME、 GIVEN_NAME のいずれかを指定します。
戻り値:: 名前を返します。設定されていない場合、nullを返します。
例外:: IllegalArgumentException - 引数 part の値が不正な場合に発生します。

setName

public void setName(int part,
                    String name)

姓または名(通常文字列)を設定します。
このメソッドを呼び出すと、以前にsetName(String) メソッドで設定した内容は破棄されます。
姓と名を区別して登録できない端末の場合、
getName(FAMILY_NAME)+getName(GIVEN_NAME)の内容が登録されます。

パラメータ:: part - 姓、名の区別を指定します。 FAMILY_NAME、 GIVEN_NAME のいずれかを指定します。; name - 名前を指定します。 nullを指定すると名前が削除されます。
例外:: IllegalArgumentException - 引数 part の値が不正な場合に発生します。

getKana

public String getKana()

読み仮名(通常文字列)を取得します。
setKana(String) メソッドまたはコンストラクタで設定した内容を返します。

戻り値:: 読み仮名を返します。設定されていない場合、nullを返します。

setKana

public void setKana(String kana)

読み仮名(通常文字列)を設定します。
このメソッドを呼び出すと、以前にsetKana(int, String) メソッドで設定した内容は破棄されます。
姓と名を区別して登録できる端末の場合、姓として登録されます。

getKana

public String getKana(int part)

姓または名の読み仮名(通常文字列)を取得します。
setKana(int, String) メソッドで設定した内容を返します。

パラメータ:: part - 姓、名の区別を指定します。 FAMILY_NAME、 GIVEN_NAME のいずれかを指定します。
戻り値:: 読み仮名を返します。設定されていない場合、nullを返します。
例外:: IllegalArgumentException - 引数 part の値が不正な場合に発生します。

setKana

public void setKana(int part,
                    String name)

姓または名の読み仮名(通常文字列)を設定します。
このメソッドを呼び出すと、以前にsetKana(String) メソッドで設定した内容は破棄されます。
姓と名を区別して登録できない端末の場合、
getKana(FAMILY_NAME)+getKana(GIVEN_NAME)の内容が登録されます。

パラメータ:: part - 姓、名の区別を指定します。 FAMILY_NAME、 GIVEN_NAME のいずれかを指定します。; name - 読み仮名を指定します。 nullを指定すると読み仮名が削除されます。
例外:: IllegalArgumentException - 引数 part の値が不正な場合に発生します。

getPhoneNumbers

public String[] getPhoneNumbers()

電話番号(通常文字列)を取得します。

戻り値:: 設定されているすべての電話番号を配列で返します。設定されていない場合、nullを返します。返される配列は、このオブジェクトが内部で保持している配列のコピーです。

getPhoneNumber

public String getPhoneNumber(int index)

電話番号(通常文字列)の1つを取得します。
getPhoneNumbers()[index] と同じ値が返ります。

パラメータ:: index - 電話番号のインデックスを指定します。
戻り値:: 指定されたインデックスの電話番号(通常文字列)を返します。
例外:: ArrayIndexOutOfBoundsException - 指定されたインデックスの電話番号が存在しない場合に発生します。

setPhoneNumbers

public void setPhoneNumbers(String[] phoneNumbers)

電話番号(通常文字列)を設定します。

例外:: NullPointerException - phoneNumbersがnullで無い場合に、配列の要素にnullが含まれていた場合に発生します。; IllegalArgumentException - 端末がサポートしている数以上の電話番号が指定された場合に発生します。; IllegalArgumentException - 電話番号として登録できない文字列が指定された場合に発生します。; IllegalArgumentException - 端末がサポートしている長さ以上の電話番号が指定された場合に発生します。

addPhoneNumber

public void addPhoneNumber(String phoneNumber)

電話帳パラメータに電話番号(通常文字列)を追加します。

パラメータ:: phoneNumber - 追加する電話番号を指定します。
例外:: IllegalStateException - 端末がサポートしている最大数の電話番号が既に設定されている場合に発生します。; NullPointerException - phoneNumberがnullの場合に発生します。; IllegalArgumentException - 電話番号として登録できない文字列が指定された場合に発生します。; IllegalArgumentException - 端末がサポートしている長さ以上の電話番号が指定された場合に発生します。

getMailAddresses

public String[] getMailAddresses()

メールアドレス(通常文字列)を取得します。

戻り値:: 設定されているすべてのメールアドレス(通常文字列)を配列で返します。設定されていない場合、nullを返します。返される配列は、このオブジェクトが内部で保持している配列のコピーです。

getMailAddress

public String getMailAddress(int index)

メールアドレス(通常文字列)の1つを取得します。
getMailAddresses()[index] と同じ値が返ります。

パラメータ:: index - メールアドレスのインデックスを指定します。
戻り値:: 指定されたインデックスのメールアドレス(通常文字列)を返します。
例外:: ArrayIndexOutOfBoundsException - 指定されたインデックスのメールアドレスが存在しない場合に発生します。

setMailAddresses

public void setMailAddresses(String[] mailAddresses)

メールアドレス(通常文字列)を設定します。

例外:: NullPointerException - mailAddressesがnullで無い場合に、配列の要素にnullが含まれていた場合に発生します。; IllegalArgumentException - 端末がサポートしている数以上のメールアドレスが指定された場合に発生します。; IllegalArgumentException - メールアドレスとして登録できない文字列が指定された場合に発生します。; IllegalArgumentException - 端末がサポートしている長さ以上のメールアドレスが指定された場合に発生します。

addMailAddress

public void addMailAddress(String mailAddress)

電話帳パラメータにメールアドレス(通常文字列)を追加します。

パラメータ:: mailAddress - 追加するメールアドレスを指定します。
例外:: IllegalStateException - 端末がサポートしている最大数のメールアドレスが既に設定されている場合に発生します。; NullPointerException - mailAddressがnullの場合に発生します。; IllegalArgumentException - メールアドレスとして登録できない文字列が指定された場合に発生します。; IllegalArgumentException - 端末がサポートしている長さ以上のメールアドレスが指定された場合に発生します。

getGroupId

public int getGroupId()

グループIDを取得します。

戻り値:: グループIDを返します。グループが設定されていない場合、グループ名が設定されている場合は、 -1を返します。

setGroupId

public void setGroupId(int id)

グループIDを設定します。

グループIDとして -1 を指定すると、グループを指定しないことを表し、ネイティブの標準のグループが指定されたことになります。
以前にグループ名が設定されている場合はグループ名が無効になります。

パラメータ:: id - グループIDを指定します。

getGroupName

public String getGroupName()

グループ名を取得します。

戻り値:: グループ名を返します。グループが設定されていない場合、グループIDが設定されている場合は、 nullを返します。

setGroupName

public void setGroupName(String name)

グループ名を設定します。

グループ名として null を指定すると、グループを指定しないことを表し、ネイティブの標準のグループが指定されたことになります。
以前にグループIDが設定されている場合はグループIDが無効になります。

パラメータ:: name - グループ名を指定します。

概要

パッケージ

クラス

階層ツリー

非推奨 API

索引

ヘルプ

前のクラス 次のクラス

フレームあり フレームなし

概要: 入れ子 | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

NTT DoCoMo,Inc.

本製品または文書は著作権法により保護されており、その使用、複製、再頒布および逆コンパイルを制限するライセンスのもとにおいて頒布されます。NTTドコモ（その他に許諾者がある場合は当該許諾者も含めて）の書面による事前の許可なく、本製品および関連する文書のいかなる部分も、いかなる方法によっても複製することが禁じられます。フォントを含む第三者のソフトウェアは、著作権法により保護されており、その提供者からライセンスを受けているものです。

Sun、Sun Microsystems、Java、J2MEおよびJ2SEは、米国およびその他の国における米国 Sun Microsystems,Inc.の商標または登録商標です。サンのロゴマークは、米国 Sun Microsystems, Inc.の登録商標です。

「ｉモード」、「ｉアプリ／アイアプリ」、「ｉ-αppli」ロゴ、「DoJa」はNTTドコモの商標または登録商標です。

コンストラクタの概要
`PhoneBookParam()` 新規登録用に電話帳パラメータを生成します。
`PhoneBookParam(String name, String kana, String[] phoneNumbers, String[] mailAddresses, int groupId)` 新規登録用に電話帳パラメータを生成します。
`PhoneBookParam(String name, String kana, String[] phoneNumbers, String[] mailAddresses, String groupName)` 新規登録用に電話帳パラメータを生成します。

メソッドの概要
`void`	`addMailAddress(String mailAddress)` 電話帳パラメータにメールアドレス(通常文字列)を追加します。
`void`	`addPhoneNumber(String phoneNumber)` 電話帳パラメータに電話番号(通常文字列)を追加します。
`int`	`getGroupId()` グループIDを取得します。
`String`	`getGroupName()` グループ名を取得します。
`String`	`getKana()` 読み仮名(通常文字列)を取得します。
`String`	`getKana(int part)` 姓または名の読み仮名(通常文字列)を取得します。
`String`	`getMailAddress(int index)` メールアドレス(通常文字列)の1つを取得します。
`String[]`	`getMailAddresses()` メールアドレス(通常文字列)を取得します。
`String`	`getName()` 名前(通常文字列)を取得します。
`String`	`getName(int part)` 姓または名(通常文字列)を取得します。
`String`	`getPhoneNumber(int index)` 電話番号(通常文字列)の1つを取得します。
`String[]`	`getPhoneNumbers()` 電話番号(通常文字列)を取得します。
`void`	`setGroupId(int id)` グループIDを設定します。
`void`	`setGroupName(String name)` グループ名を設定します。
`void`	`setKana(int part, String name)` 姓または名の読み仮名(通常文字列)を設定します。
`void`	`setKana(String kana)` 読み仮名(通常文字列)を設定します。
`void`	`setMailAddresses(String[] mailAddresses)` メールアドレス(通常文字列)を設定します。
`void`	`setName(int part, String name)` 姓または名(通常文字列)を設定します。
`void`	`setName(String name)` 名前(通常文字列)を設定します。
`void`	`setPhoneNumbers(String[] phoneNumbers)` 電話番号(通常文字列)を設定します。

com.nttdocomo.system クラス PhoneBookParam

PhoneBookParam

PhoneBookParam

PhoneBookParam

getName

setName

getName

setName

getKana

setKana

getKana

setKana

getPhoneNumbers

getPhoneNumber

setPhoneNumbers

addPhoneNumber

getMailAddresses

getMailAddress

setMailAddresses

addMailAddress

getGroupId

setGroupId

getGroupName

setGroupName

com.nttdocomo.system
クラス PhoneBookParam