com.docomostar.system
クラス DTVScheduleParam

Object
  com.docomostar.system.DTVScheduleParam

public final class DTVScheduleParam
extends Object

[iアプリオプションAPI]

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

予約スケジュールを新規に登録するためには、 コンストラクタにより DTVScheduleParam オブジェクトを生成します。 生成したオブジェクトには物理チャンネル等を設定することができます。

登録は DTVSchedule.addEntry(int, DTVScheduleParam) メソッドで行います。 登録時の動作の詳細は、メソッドの説明を参照して下さい。

導入されたバージョン:

Star-1.0

関連項目:

DTVSchedule

コンストラクタの概要

DTVScheduleParam()
新規登録用に予約スケジュールパラメータを生成します。

メソッドの概要

void	setAffiliationId(int affiliationId) 系列識別を設定します。
void	setFrequency(int frequency) 物理チャンネルを設定します。
void	setProgramTime(ScheduleDate programTime) 番組の放送時間帯と繰り返し設定を指定します。
void	setProgramTitle(String title) 番組名を設定します。
void	setServiceId(int serviceId) サービス識別を設定します。
void	setServiceName(String serviceName) チャンネル名を設定します。

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

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

コンストラクタの詳細

DTVScheduleParam

public DTVScheduleParam()

新規登録用に予約スケジュールパラメータを生成します。

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

• 物理チャンネル : DTVSchedule.FREQUENCY_NONE
• サービス識別 : DTVSchedule.SERVICE_ID_NONE
• 系列識別 : DTVSchedule.AFFILIATION_ID_NONE
• チャンネル名 : null
• 番組の放送時間帯と繰り返し設定: null
• 番組名 : null

例外:

UnsupportedOperationException -
端末がデジタルテレビ機能をサポートしていない場合に発生します。

UnsupportedOperationException -
デジタルテレビ機能はサポートしていても、 視聴/録画予約スケジューラ機能をサポートしていない場合に発生します。

メソッドの詳細

setFrequency

public void setFrequency(int frequency)

物理チャンネルを設定します。

パラメータ:

frequency - 物理チャンネルを指定します。 13 以上 62 以下の値を指定できます。 物理チャンネルを指定したくない場合は DTVSchedule.FREQUENCY_NONE を指定します。

例外:

IllegalArgumentException -
引数 frequency に 13 より小さい値、または 62 より大きい値が指定された場合に発生します。 ただし、-1 が指定された場合には発生しません。

setServiceId

public void setServiceId(int serviceId)

サービス識別を設定します。

パラメータ:

serviceId - サービス識別を指定します。 0 以上 2¹⁶ -1 以下の値を指定できます。 サービス識別を指定したくない場合は DTVSchedule.SERVICE_ID_NONE を指定します。

例外:

IllegalArgumentException -
引数 serviceId に -1 より小さい値、 または 2¹⁶ -1 より大きい値が指定された場合に発生します。

setAffiliationId

public void setAffiliationId(int affiliationId)

系列識別を設定します。

パラメータ:

affiliationId - 系列識別を指定します。 0 以上 11 以下の値を指定できます。 系列識別を指定したくない場合は DTVSchedule.AFFILIATION_ID_NONE を指定します。

例外:

IllegalArgumentException -
引数 affiliationId に -1 より小さい値、 または 11 より大きい値が指定された場合に発生します。

setServiceName

public void setServiceName(String serviceName)

チャンネル名を設定します。

パラメータ:

serviceName - チャンネル名(通常文字列)を指定します。 null を指定可能です。

setProgramTime

public void setProgramTime(ScheduleDate programTime)

番組の放送時間帯と繰り返し設定を指定します。 null を指定可能です。

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

メソッド	意味
ScheduleDate.getStartTime()	番組開始時刻
ScheduleDate.getEndTime()	番組終了時刻
ScheduleDate.getType()	繰り返しタイプ	繰り返し設定
ScheduleDate.getSpanSet()	期間の集合
ScheduleDate.getRepeatCount()	繰り返し回数

パラメータ:

programTime - 視聴・録画したい番組の放送時間帯、 ならびに繰り返し設定が格納された ScheduleDate オブジェクトを指定します。

setProgramTitle

public void setProgramTitle(String title)

番組名を設定します。

パラメータ:

title - 番組名を指定します。 null を指定可能です。