com.docomostar.system
クラス DataBoxFolder

Object
  com.docomostar.system.DataBoxFolder

public final class DataBoxFolder
extends Object

データ BOX のフォルダを管理する手段を提供します。

このクラスのインスタンスは、フォルダの 1 つのエントリを表しますが、 インスタンスを取得する手段はありません。

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

エントリ ID のみ取得機能 (selectEntryId) を提供しますが、下記の点が大原則と異なります。

selectEntryIdについて:

このクラスにおいては、「Star アプリからの ID 取得・テーマ設定」の許可による制限はありません。

このクラスの addEntry(int, String) と selectEntryId(int) で得られたエントリ ID は、ImageStore.getEntryIds(int) でフォルダを指定するために使用されます。

導入されたバージョン:

Star-1.0

フィールドの概要

static int

FOLDER_MY_PICTURE データ BOX フォルダ配下のフォルダの種類を表す定数で、 マイピクチャフォルダを表します(=1)。

メソッドの概要

static int	addEntry(int folder, String name) ユーザ操作によりフォルダを新規作成します。
static int	selectEntryId(int folder) ユーザ操作によりフォルダのエントリ ID を取得します。

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

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

フィールドの詳細

FOLDER_MY_PICTURE

public static final int FOLDER_MY_PICTURE

データ BOX フォルダ配下のフォルダの種類を表す定数で、 マイピクチャフォルダを表します(=1)。

addEntry(int, String) または selectEntryId(int) メソッドの引数 folder で利用します。

関連項目:

addEntry(int, String), selectEntryId(int), 定数フィールド値

メソッドの詳細

addEntry

public static int addEntry(int folder,
                           String name)
                    throws InterruptedOperationException

ユーザ操作によりフォルダを新規作成します。 引数 folder で指定したフォルダの直下に、引数 name で指定したフォルダ名のフォルダを新規作成します。

引数 folder に、フォルダの種類として定義されていない値を指定した場合には例外が発生します。 引数 name に指定したフォルダ名について、重複するフォルダ名でフォルダを作成できるかどうかは機種依存です。

フォルダの作成が完了した場合には、このメソッドは 作成されたフォルダのエントリ ID を返します。 ユーザ操作によりキャンセルした場合には -1 を返します。 データ保存領域の容量を超えているために登録できない場合は、 ユーザが登録操作をキャンセルした場合と同様の値を返します。

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

パラメータ:

folder - このクラスで定数として定義されたデータ BOX フォルダ配下のフォルダの種類を指定します。

name - フォルダ名を指定します。

戻り値:

作成されたフォルダのエントリの ID を返します。 ユーザが登録操作をキャンセルした場合には -1 を返します。

例外:

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

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

SecurityException -
ロック機能などのネイティブ独自のセキュリティ設定により、 フォルダが作成できない場合に発生します。

InterruptedOperationException -
競合条件などにより、フォルダ作成の操作が異常終了した場合に発生します。

selectEntryId

public static int selectEntryId(int folder)
                         throws InterruptedOperationException

ユーザ操作によりフォルダのエントリ ID を取得します。 引数 folder で指定したフォルダの直下にあるフォルダのエントリ ID を取得できます。

引数 folder に、フォルダの種類として定義されていない値を指定した場合には例外が発生します。

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

パラメータ:

folder - このクラスで定数として定義されたデータ BOX フォルダ配下のフォルダの種類を指定します。

戻り値:

選択したフォルダのエントリ ID を返します。 ユーザが選択操作をキャンセルすると -1 を返します。 また、選択可能なエントリが存在しない場合にも -1 を返します。

例外:

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

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

SecurityException -
ロック機能などのネイティブ独自のセキュリティ設定により、 画像データのエントリ ID を取得できない場合に発生します。

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