com.docomostar.system
クラス DTVSchedule

Object
  com.docomostar.system.DTVSchedule

public final class DTVSchedule
extends Object

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

携帯電話のネイティブの (デジタルテレビ)視聴/録画予約スケジューラ機能にアクセスする手段を提供します。 このクラスのインスタンスは、 携帯電話のネイティブの視聴/録画予約スケジュールデータの 1 つのエントリを表しますが、 インスタンスを取得する手段はありません。

このクラスに定義されているクラスメソッドの使い方や、 ネイティブのデータへのアクセス方法に関する規定の大原則は com.docomostar.system パッケージの記述を参照して下さい。 ただし、エントリ取得機能 (selectEntry、getEntry) は提供されず、 エントリ登録機能 (addEntry(int, DTVScheduleParam)) についても、 下記の点が大原則と異なります。

addEntry の戻り値について:

このクラスにおいては、addEntryの戻り値として、 エントリ ID ではなく、登録成否を表す論理値が返されます。

エントリ登録時に、引数に渡す DTVScheduleParam オブジェクトの設定により、 「1回限り」 「毎日」 「毎週」 「毎月」 「毎年」のスケジュール時刻を設定できます。 ただし、 サポートされるスケジュールタイプは、 ネイティブの視聴/録画予約スケジューラ機能に依存します。 この端末でサポートされるスケジュールタイプを取得するには、 getSupportedTypes(int) を使用して下さい。 また、期間の集合への対応有無を取得するには、 getMultiRepeatableTypes(int) を使用して下さい。

ミニマムスペック:

• ミニマムスペックでは、「1回限り」のスケジュール時刻を設定可能です。

導入されたバージョン:

Star-1.0

フィールドの概要

static int	AFFILIATION_ID_NONE 系列識別が未指定であることを表します(=-1)。
static int	FREQUENCY_NONE 物理チャンネルが未指定であることを表します(=-1)。
static int	SERVICE_ID_NONE サービス識別が未指定であることを表します(=-1)。
static int	TYPE_RECORD 録画予約を表します(=1)。
static int	TYPE_WATCH 視聴予約を表します(=0)。

メソッドの概要

static boolean	addEntry(int type, DTVScheduleParam param) 予約タイプを指定して、ユーザ操作により視聴/録画予約スケジュールを新規登録します。
static int	getMultiRepeatableTypes(int type) 視聴/録画予約において、スケジュール時刻のタイプのうち、期間の集合をサポートしているものを取得します。
static int	getSupportedTypes(int type) 予約タイプを指定して、 視聴/録画予約においてサポートしているスケジュール時刻のタイプを取得します。

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

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

フィールドの詳細

FREQUENCY_NONE

public static final int FREQUENCY_NONE

物理チャンネルが未指定であることを表します(=-1)。

関連項目:

定数フィールド値

SERVICE_ID_NONE

public static final int SERVICE_ID_NONE

サービス識別が未指定であることを表します(=-1)。

関連項目:

定数フィールド値

AFFILIATION_ID_NONE

public static final int AFFILIATION_ID_NONE

系列識別が未指定であることを表します(=-1)。

関連項目:

定数フィールド値

TYPE_WATCH

public static final int TYPE_WATCH

視聴予約を表します(=0)。

関連項目:

定数フィールド値

TYPE_RECORD

public static final int TYPE_RECORD

録画予約を表します(=1)。

関連項目:

定数フィールド値

メソッドの詳細

getSupportedTypes

public static int getSupportedTypes(int type)

予約タイプを指定して、 視聴/録画予約においてサポートしているスケジュール時刻のタイプを取得します。

予約タイプに TYPE_WATCH を指定すると視聴予約において、 TYPE_RECORD を指定すると録画予約において、 それぞれサポートしているスケジュール時刻のタイプを取得できます。

このメソッドは ScheduleDate.ONETIME、 ScheduleDate.DAILY、 ScheduleDate.WEEKLY、 ScheduleDate.MONTHLY、 ScheduleDate.YEARLY のうち、 サポートされているスケジュール時刻タイプ(日時指定タイプ)の論理和を返します。 例えば、「1回限り」「毎日」「毎週」をサポートしている場合、
7( = ONETIME|DAILY|WEEKLY)
が返ります。

パラメータ:

type - 予約タイプを指定します。

戻り値:

サポートしているスケジュール時刻のタイプを返します。

例外:

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

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

IllegalArgumentException -
引数 type に不正な値が指定された場合に発生します。

getMultiRepeatableTypes

public static int getMultiRepeatableTypes(int type)

視聴/録画予約において、スケジュール時刻のタイプのうち、期間の集合をサポートしているものを取得します。

予約タイプに TYPE_WATCH を指定すると視聴予約において、 TYPE_RECORD を指定すると録画予約において、 それぞれサポートしている期間の集合に対応したスケジュール時刻のタイプを取得できます。

ScheduleDate.WEEKLY、 ScheduleDate.MONTHLY、 ScheduleDate.YEARLY、 のうち、 この端末がサポートしている期間の集合に対応したスケジュール時刻タイプ(日時指定タイプ)の論理和を返します。 例えば、「毎週」「毎月」「毎年」をサポートしている場合、
28( = WEEKLY|MONTHLY|YEARLY)
が返ります。

パラメータ:

type - 予約タイプを指定します。

戻り値:

スケジュール時刻のタイプのうち、期間の集合をサポートしているものを取得します。

例外:

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

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

IllegalArgumentException -
引数 type に不正な値が指定された場合に発生します。

addEntry

public static boolean addEntry(int type,
                               DTVScheduleParam param)
                        throws InterruptedOperationException

予約タイプを指定して、ユーザ操作により視聴/録画予約スケジュールを新規登録します。

予約タイプに TYPE_WATCH を指定すると視聴予約スケジュールを、 TYPE_RECORD を指定すると録画予約スケジュールをそれぞれ新規登録します。 各予約タイプにおいてパラメータに指定すべき項目は下記表の通りになります。 指定必須の項目に null や「未指定を表す値」を指定した場合は例外が発生します。

パラメータ項目		視聴予約	録画予約
物理チャンネル		M (※1)	M (※1)
サービス識別
系列識別
チャンネル名		O	O
番組開始時刻		M	M
番組終了時刻		- (※2)	M
繰り返し設定	繰り返しタイプ	M	M
	期間の集合	O	O
	繰り返し回数	- (※2)	- (※2)
番組名		O	O

[凡例] "M"=指定必須、"O"=指定オプション、"-"=指定不要
(※1) 少なくともいずれか 1 つは指定しなければなりません。
(※2) 指定しても無視されます。

ADF に AccessUserInfo キーの指定が必要です。 上記以外の動作の詳細については、このクラスの説明、 ならびに、その説明から引用されている com.docomostar.system パッケージに記述されている説明を参照して下さい。

データ保存領域の容量を超えているために登録できない場合は、 ユーザが登録操作をキャンセルした場合と同様の値を返します。

このメソッドは、 引数 param に設定されている「番組開始時刻」「番組終了時刻」を、 ローカルタイムゾーン下で再評価した上でネイティブの視聴/録画予約スケジュール機能に渡します。 例えば、ローカルタイムゾーンが JST (+0900) である環境下では、 番組開始時刻に 10:00 (+0000) が、番組終了時刻に 13:00 (+0200) が、 それぞれ格納されていた場合、 19:00 〜 20:00 を、番組放送時間帯としてネイティブ機能に渡します。

期間の集合に対応しない日時指定タイプを指定した場合に、 期間の集合に値が設定された場合の動作は、ネイティブの 視聴/録画予約スケジューラ機能の実装に依存します。

パラメータ:

type - 予約タイプを指定します。 TYPE_WATCH、TYPE_RECORD を指定可能です。

param - 予約スケジュールのパラメータを指定します。

戻り値:

登録が成功したか否かを返します。 登録が成功した場合にのみ、true を返します。 ユーザが登録操作をキャンセルした場合、false を返します。

例外:

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

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

IllegalStateException -
ミニアプリ実行時の Focused または Unfocused 状態で呼び出された場合に発生します。

IllegalArgumentException -
引数 type に不正な値が指定された場合に発生します。

NullPointerException -
引数 param が null の場合に発生します。

NullPointerException -
引数 param に含まれる「番組の放送時間帯と繰り返し設定」が null の場合に発生します。

NullPointerException -
引数 type が TYPE_RECORD である場合に、 引数 param に含まれる番組終了時刻が null の場合に発生します。

IllegalArgumentException -
引数 param に含まれる物理チャンネル、サービス識別、系列識別がいずれも「未指定を表す値」である場合に発生します。

IllegalArgumentException -
引数 param に含まれる繰り返しタイプが、 サポートされない日時指定タイプである場合に発生します。

IllegalArgumentException -
引数 param に含まれる番組開始時刻または番組終了時刻が、 サポートされない範囲の日時(例えば、1900年など)である場合に発生します。

SecurityException -
ADF に AccessUserInfo キーの指定がないアプリケーションが このメソッドを呼び出した場合に発生します。

SecurityException -
ロック機能などのネイティブ独自のセキュリティ設定により、 スケジュールを登録できない場合に発生します。

IllegalStateException -
端末の現在時刻が設定されていない場合に発生します。

InterruptedOperationException -
競合条件などにより、登録操作が異常終了した場合に発生します。