com.docomostar.system
クラス ScheduleParam

Object
  com.docomostar.system.ScheduleParam

public final class ScheduleParam
extends Object

スケジュールデータの新規登録用のパラメータを定義します。

スケジュールデータを新規に作成し、登録するためには、 コンストラクタにより ScheduleParam オブジェクトを生成します。 生成したオブジェクトに対して、スケジュールの件名等を設定後、 Schedule.addEntry(ScheduleParam) メソッドによる登録を行うことができます。 登録時の動作の詳細は、メソッドの説明を参照して下さい。

導入されたバージョン:

Star-1.0

コンストラクタの概要

ScheduleParam()
スケジュールデータを生成します。

メソッドの概要

boolean	getAlarm() アラームの鳴動設定の有無を取得します。
ScheduleDate	getDate() スケジュールの日時を取得します。
String	getDescription() スケジュールの詳細を取得します。
Location	getLocation() [iアプリオプションAPI] 位置情報を取得します。
String	getSummary() スケジュールの件名を取得します。
void	setAlarm(boolean b) アラームの鳴動有無を設定します。
void	setDate(ScheduleDate date) スケジュール日時を設定します。
void	setDescription(String description) スケジュールの詳細を設定します。
void	setLocation(Location location) [iアプリオプションAPI] 位置情報を設定します。
void	setSummary(String summary) スケジュールの件名を設定します。

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

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

コンストラクタの詳細

ScheduleParam

public ScheduleParam()

スケジュールデータを生成します。

初期状態は以下のようになります。

• 件名 : null
• 詳細 : null
• 日時 : null
• 位置情報 : null
• アラームの有無 : false

メソッドの詳細

getDescription

public String getDescription()

スケジュールの詳細を取得します。

戻り値:

スケジュールの詳細を返します。

getSummary

public String getSummary()

スケジュールの件名を取得します。

戻り値:

スケジュールの件名を返します。

getDate

public ScheduleDate getDate()

スケジュールの日時を取得します。

戻り値:

スケジュールの日時を返します。

getLocation

public Location getLocation() [iアプリオプションAPI]

位置情報を取得します。

スケジュールエントリにおいて位置情報をサポートしていない実装でも、 メソッドは正常に動作します。 すなわち、 setLocation() メソッドで設定された位置情報オブジェクトのコピーが返されます。

戻り値:

位置情報を返します。 返される位置情報オブジェクトは、 このオブジェクトが保持している Location オブジェクトのコピーです。

getAlarm

public boolean getAlarm()

アラームの鳴動設定の有無を取得します。

戻り値:

アラームの鳴動設定の有無を返します。

setDescription

public void setDescription(String description)

スケジュールの詳細を設定します。 null を指定可能です。

パラメータ:

description - スケジュールの詳細を指定します。

setSummary

public void setSummary(String summary)

スケジュールの件名を設定します。 null を指定可能です。

パラメータ:

summary - スケジュールの件名を指定します。

setLocation

public void setLocation(Location location) [iアプリオプションAPI]

位置情報を設定します。 null を指定すると、既に設定されていた位置情報がクリアされます。

このオブジェクトは、引数に指定された Location オブジェクトをコピーして保持します。

スケジュールエントリにおいて位置情報をサポートしていない実装でも、 メソッドは正常に動作します (このオブジェクトを登録する時に位置情報のみ無視されます)。

パラメータ:

location - 位置情報を指定します。

setDate

public void setDate(ScheduleDate date)

スケジュール日時を設定します。 null を指定可能です。

スケジュールエントリにおいて繰り返し回数をサポートしていない実装でも、 メソッドは正常に動作します (このオブジェクトを登録する時に繰り返し回数のみ無視されます)。

引数 date の各メソッドと、その戻り値の意味の対応は以下の通りです。

メソッド	意味
ScheduleDate.getStartTime()	スケジュール開始時刻
ScheduleDate.getEndTime()	スケジュール終了時刻
ScheduleDate.getType()	日付指定タイプ
ScheduleDate.getSpanSet()	期間の集合
ScheduleDate.getRepeatCount()	繰り返し回数

パラメータ:

date - スケジュールの開始時刻、終了時刻、日付指定タイプ、期間の集合、ならびに繰り返し回数が格納された ScheduleDate オブジェクトを指定します。

setAlarm

public void setAlarm(boolean b)

アラームの鳴動有無を設定します。

パラメータ:

b - アラームを設定する場合 true を、アラームを設定しない場合 false を指定します。