Apex 開発者ガイド
jカスタム設定メソッド
使用方法
カスタム設定メソッドはすべてインスタンスメソッドです。つまり、カスタム設定の特定のインスタンスでコールされ、動作します。カスタム設定には、階層とリストの 2 種類があります。メソッドは、リストカスタム設定を処理するメソッド、および階層カスタム設定を処理するメソッドに分類されます。
Salesforce ユーザインターフェースでのカスタム設定の作成についての詳細は、Salesforce オンラインヘルプの「カスタム設定」を参照してください。
カスタム設定の例
次の例では、Games というリストカスタム設定を使用します。Games には GameType という項目があります。この例では、最初のデータセットの値が文字列 PC がどうかを決定します。
階層カスタム設定の例
次の例では、階層カスタム設定 GamesSupport に Corporate_number という項目があります。コードは pid で指定されたプロファイルの値を返します。
次の例では、階層カスタム設定メソッドの使用方法を示します。この例では、getInstance には、階層の下から 2 番目のレベルで定義されている項目から返される特定のユーザまたはプロファイルに設定されない項目値が返されます。また、getOrgDefaults の使用方法を例で示します。
- 組織の設定
- OverrideMe: Hello
- DontOverrideMe: World
- プロファイルの設定
- OverrideMe: Goodbye
- DontOverrideMe は設定されません。
- ユーザの設定
- OverrideMe: Fluffy
- DontOverrideMe は設定されません。
国コードと州コードのカスタム設定例
この例では、関連する情報を保存するために 2 つのカスタム設定オブジェクトを使用する方法と、関連する選択リストの集合のデータを表示する Visualforce ページについて示します。
次の例では、国コードと州コードは、Foundation_Countries と Foundation_States という 2 つの異なるカスタム設定に保存されます。
- 国コード
- 都道府県コード
- 都道府県名
リストカスタム設定メソッド
次に、リストカスタム設定のインスタンスメソッドを示します。
getAll()
署名
public Map<String, CustomSetting__c> getAll()
戻り値
型: Map<String, CustomSetting__c>
使用方法
データセットが定義されていない場合、このメソッドは空の対応付けを返します。
getInstance(dataSetName)
署名
public CustomSetting__c getInstance(String dataSetName)
パラメータ
- dataSetName
- 型: String
戻り値
型: CustomSetting__c
getValues(dataSetName)
署名
public CustomSetting__c getValues(String dataSetName)
パラメータ
- dataSetName
- 型: String
戻り値
型: CustomSetting__c
使用方法
指定されたデータセットにデータが定義されていない場合は、このメソッドは null を返します。
階層カスタム設定メソッド
次に、階層カスタム設定のインスタンスメソッドを示します。
getInstance()
署名
public CustomSetting__c getInstance()
戻り値
型: CustomSetting__c
使用方法
ユーザにカスタム設定データが定義されていない場合、このメソッドは新しいカスタム設定オブジェクトを返します。新しいカスタム設定オブジェクトには、null に設定された ID と、より上位の階層からマージされた項目が含まれます。この新しいカスタム設定レコードをユーザに追加するには、insert または upsert を使用します。階層にカスタム設定データが定義されていない場合、ユーザ ID が含まれる SetupOwnerId 項目を除き、返されるカスタム設定の項目は空です。
このメソッドは現在のユーザの getInstance(User_Id) へのメソッドコールと同じです。
例
- ユーザに定義されているカスタム設定データセット:「山田太郎」というユーザ、「システム管理者」というプロファイル、および組織全体に定義されたカスタム設定データセットがあり、コードを実行しているユーザが山田太郎である場合、このメソッドは、山田太郎に定義されているカスタム設定レコードを返します。
- 差し込み項目:「山田太郎」というユーザと「システム管理者」というプロファイルに項目 A および項目 B を持つカスタム設定データセットがあるとします。項目 A は山田太郎に定義されており、項目 B は null であるがシステム管理者プロファイルに定義されている場合、このメソッドは、山田太郎には、山田太郎の項目 A とシステム管理者プロファイルから得た項目 B を持つカスタム設定レコードを返します。
- ユーザにカスタム設定データセットレコードが定義されていない: 現在のユーザが「井上花子」であり、「システム管理者」プロファイルを共有しているが、ユーザとしての井上花子に定義されたデータがない場合、このメソッドは、ID が null で、階層内で最下位レベルに定義された項目に基づいて差し込まれた項目を持つ、新しいカスタム設定レコードを返します。
getInstance(userId)
署名
public CustomSetting__c getInstance(ID userId)
パラメータ
- userId
- 型: ID
戻り値
型: CustomSetting__c
getInstance(profileId)
署名
public CustomSetting__c getInstance(ID profileId)
パラメータ
- profileId
- 型: ID
戻り値
型: CustomSetting__c
getOrgDefaults()
署名
public CustomSetting__c getOrgDefaults()
戻り値
型: CustomSetting__c
使用方法
組織にカスタム設定データが定義されていない場合、このメソッドは空のカスタム設定オブジェクトを返します。
getValues(userId)
署名
public CustomSetting__c getValues(ID userId)
パラメータ
- userId
- 型: ID
戻り値
型: CustomSetting__c
使用方法
ユーザレベルで定義されているカスタム設定データのサブセットが必要な場合にのみ使用します。たとえば、組織レベルで「foo」の値を割り当てられているカスタム設定項目があり、ユーザレベルまたはプロファイルレベルで値が割り当てられていないとします。getValues(UserId) は、このカスタム設定項目に null を返します。
getValues(profileId)
署名
public CustomSetting__c getValues(ID profileId)
パラメータ
- profileId
- 型: ID
戻り値
型: CustomSetting__c
使用方法
プロファイルレベルで定義されているカスタム設定データのサブセットが必要な場合にのみ使用します。たとえば、組織レベルで「foo」の値を割り当てられているカスタム設定項目があり、ユーザレベルまたはプロファイルレベルで値が割り当てられていないとします。getValues(ProfileId) は、このカスタム設定項目に null を返します。