com.docomostar.system
クラス Alarm

Object
  com.docomostar.system.Alarm

public final class Alarm
extends Object

携帯電話のネイティブのアラーム機能にアクセスする手段を提供します。 このクラスのインスタンスは、 携帯電話のネイティブのアラームの 1 つのエントリを表しますが、 インスタンスを取得する手段はありません。

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

addEntry の戻り値について:

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

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

導入されたバージョン:

Star-1.0

メソッドの概要

static boolean	addEntry(ScheduleDate date) ユーザ操作によりアラームを新規登録します。
static int	getMultiRepeatableTypes() 日時指定タイプのうち、期間の集合をサポートしているものを取得します。
static int	getSupportedTypes() アラームに設定可能な日時指定タイプを取得します。

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

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

メソッドの詳細

getSupportedTypes

public static int getSupportedTypes()

アラームに設定可能な日時指定タイプを取得します。

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

戻り値:

アラームに設定可能な日時指定タイプを返します。

getMultiRepeatableTypes

public static int getMultiRepeatableTypes()

日時指定タイプのうち、期間の集合をサポートしているものを取得します。

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

戻り値:

日時指定タイプのうち、期間の集合をサポートしているものを取得します。

addEntry

public static boolean addEntry(ScheduleDate date)
                        throws InterruptedOperationException

ユーザ操作によりアラームを新規登録します。

date 引数が null の場合、 アラーム登録画面が起動された日付が指定されたことになります。 その場合に時刻がいつに設定されるかは機種依存です。

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

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

このメソッドでは、引数 date の情報のうち、 日時指定タイプと期間の集合、 および開始時刻のみが解釈されます。 終了時刻と 繰り返し回数に設定されている内容は無視されます。
期間の集合に対応しない日時指定タイプを指定した場合に、 期間の集合に値が設定された場合の動作は、ネイティブのアラーム機能実装に依存します。

また、開始時刻に設定されている日時は、 ローカルタイムゾーン下で再評価された上でネイティブのスケジュール機能に渡されます。 例えば、ローカルタイムゾーンが JST (+0900) である環境下では、 引数 date の開始時刻に 10:00 (+0000) が格納されていた場合、 19:00 がネイティブのスケジュール機能に渡されます。

パラメータ:

date - アラームを鳴らす日時を指定します。

戻り値:

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

例外:

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

IllegalArgumentException -
サポートされない日時指定タイプの起動時刻を指定した場合に発生します。

IllegalArgumentException -
サポートされない範囲の日時の起動時刻 (例えば、1900年など)を指定した場合に発生します。

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

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

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