この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

Newer Version Available

This content describes an older version of this product. View Latest

StandardSetController クラス

StandardSetController オブジェクトを使用すると、Salesforce が提供する、プリビルドされた Visualforce リストコントローラと同様のリストコントローラ���またはその拡張としてリストコントローラを作成できます。

名前空間

ApexPages

使用方法

StandardSetController クラスには、プロトタイプオブジェクトも含まれます。これは、Visualforce の StandardSetController クラスに含まれる単一の sObject です。プロトタイプオブジェクトの項目が設定されている場合、それらの値は、保存操作中に使用されます。つまり、値は設定されたコントローラコレクションのすべてのレコードに適用されます。これは、一括更新 (オブジェクトのコレクション内の項目に同一の変更を適用) を実行するページを記述するときに役立ちます。

他の Salesforce オブジェクトに必要な項目は、プロトタイプオブジェクトに使用される場合にも必要です。

メモ

インスタンス化

次のいずれかの方法で、StandardSetController をインスタンス化することができます。
  • sObjects のリストを使用する場合:
  • クエリロケータを使用する場合:

StandardSetController のレコード数の上限は 10,000 件です。10,000 件を超えるレコードを返すクエリロケータを使用して StandardSetController をインスタンス化すると、LimitException が発生します。ただし、10,000 件を超えるレコードのリストを使用して StandardSetController をインスタンス化すると、例外が発生する代わりに、レコードが上限まで切り捨てられます。

メモ

次の例では、StandardSetController オブジェクトのカスタムリストコントローラのコンストラクタでの使用方法を示します。
次の Visualforce マークアップは、上記のコントローラをページ内で使用する方法を示します。

StandardSetController コンストラクタ

StandardSetController のコンストラクタは次のとおりです。

StandardSetController(queryLocator)

クエリロケータによって返されるオブジェクトのリストの ApexPages.StandardSetController クラスのインスタンスを作成します。

署名

public StandardSetController(Database.QueryLocator queryLocator)

パラメータ

queryLocator
型: Database.QueryLocator
sObject のリストを表すクエリロケータ。

StandardSetController(controllerSObjects)

指定した標準オブジェクトまたはカスタムオブジェクトのリストの ApexPages.StandardSetController クラスのインスタンスを作成します。

署名

public StandardSetController(List<sObject> controllerSObjects)

パラメータ

controllerSObjects
型: List<sObject>
標準オブジェクトまたはカスタムオブジェクトのリスト。

StandardSetController メソッド

StandardSetController のメソッドは次のとおりです。すべてインスタンスメソッドです。

cancel()

元のページ (わかっている場合)、またはホームページの PageReference を返します。

署名

public System.PageReference cancel()

戻り値

型: System.PageReference

first()

レコードの最初のページを返します。

署名

public Void first()

戻り値

型: Void

getCompleteResult()

セット内に存在するレコード数がレコード数の上限を超えているかどうかを示します。false の場合、レコード数がリストコントローラを使用して処理できる数を超えています。レコード数の上限は 10,000 レコードです。

署名

public Boolean getCompleteResult()

戻り値

型: Boolean

getFilterId()

現在のコンテキストでの検索条件の ID を返します。

署名

public String getFilterId()

戻り値

型: String

getHasNext()

現在のページセットの後に、より多くのレコードがあるかどうかを示します。

署名

public Boolean getHasNext()

戻り値

型: Boolean

getHasPrevious()

現在のページセットの前に、より多くのレコードがあるかどうかを示します。

署名

public Boolean getHasPrevious()

戻り値

型: Boolean

getListViewOptions()

現在のユーザが使用できるリストビューのリストを返します。

署名

public System.SelectOption getListViewOptions()

戻り値

型: System.SelectOption[]

getPageNumber()

現在のページセットのページ番号を返します。最初のページは 1 を返します。

署名

public Integer getPageNumber()

戻り値

型: Integer

getPageSize()

各ページセットに存在するレコード数を返します。

署名

public Integer getPageSize()

戻り値

型: Integer

getRecord()

選択したレコードへの変更を示す sObject を返します。クラス内に含まれるプロトタイプオブジェクトを取得し、一括更新の実行に使用されます。

署名

public sObject getRecord()

戻り値

型: sObject

getRecords()

現在のページセットにある sObject のリストを返します。このリストは不変であるため、clear() をコールできません。

署名

public sObject[] getRecords()

戻り値

型: sObject[]

getResultSize()

セットに存在するレコード数を返します。

署名

public Integer getResultSize()

戻り値

型: Integer

getSelected()

選択されている sObject のリストを返します。

署名

public sObject[] getSelected()

戻り値

型: sObject[]

last()

レコードの最後のページを返します。

署名

public Void last()

戻り値

型: Void

next()

レコードの次のページを返します。

署名

public Void next()

戻り値

型: Void

previous()

レコードの前のページを返します。

署名

public Void previous()

戻り値

型: Void

save()

新しいレコードを挿入するか、変更された既存のレコードを更新します。この操作が完了した後、元のページ (わかっている場合)、またはホームページの PageReference を返します。

署名

public System.PageReference save()

戻り値

型: System.PageReference

setFilterID(filterId)

コントローラの検索条件 ID を設定します。

署名

public Void setFilterID(String filterId)

パラメータ

filterId
型: String

戻り値

型: Void

setpageNumber(pageNumber)

ページ番号を設定します。

署名

public Void setpageNumber(Integer pageNumber)

パラメータ

pageNumber
型: Integer

戻り値

型: Void

setPageSize(pageSize)

各ページセット内のレコード数を設定します。

署名

public Void setPageSize(Integer pageSize)

パラメータ

pageSize
型: Integer

戻り値

型: Void

setSelected(selectedRecords)

選択したレコードを設定します。

署名

public Void setSelected(sObject[] selectedRecords)

パラメータ

selectedRecords
型: sObject[]

戻り値

型: Void