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

Apex 開発者ガイド

Apex 開発者ガイド
Apex の使用開始
Apex の作成
Apex の実行
Apex のデバッグ、テスト、リリース
Apex 言語のリファレンス
Apex DML 操作
ApexPages 名前空間
AppLauncher 名前空間
Approval 名前空間
Auth 名前空間
Cache 名前空間
Canvas 名前空間
ChatterAnswers 名前空間
CommercePayments 名前空間
ConnectApi 名前空間
Database 名前空間
Datacloud 名前空間
DataSource 名前空間
Dom 名前空間
EventBus 名前空間
Flow 名前空間
KbManagement 名前空間
LxScheduler 名前空間
Messaging 名前空間
Metadata 名前空間
Process 名前空間
QuickAction 名前空間
Reports 名前空間
Schema 名前空間
ChildRelationship クラス
DataCategory クラス
DataCategoryGroupSobjectTypePair クラス
DescribeColorResult クラス
Describe​DataCategoryGroupResult クラス
Describe​DataCategoryGroupStructureResult クラス
DescribeFieldResult クラス
DescribeIconResult クラス
DescribeSObjectResult クラス
DescribeSObjectResult のメソッド
DescribeTabResult クラス
DescribeTabSetResult クラス
DisplayType 列挙
FieldDescribeOptions 列挙
FieldSet クラス
FieldSetMember クラス
PicklistEntry クラス
RecordTypeInfo クラス
SOAPType 列挙
SObjectDescribeOptions 列挙
SObjectField クラス
SObjectType クラス
Search 名前空間
Sfc 名前空間
Sfdc_Checkout 名前空間
Site 名前空間
Support 名前空間
System 名前空間
TerritoryMgmt 名前空間
TxnSecurity 名前空間
UserProvisioning 名前空間
VisualEditor 名前空間
wave 名前空間
付録
用語集
PDF

DescribeSObjectResult クラス

sObject を記述するメソッドが含まれます。引数を取るメソッドはありません。

名前空間

Schema

使用方法

describe オブジェクトの状態と動作は、使用される API バージョンを含めさまざまな要素により決まるため、同じ DescribeSObjectResult の describe result のインスタンスが等しくなる保証はありません。describe result を比較するには、SObject describe result で getSObjectType() メソッドをコールし、等価演算子 (==) を使用して SObjectType 値を比較します。

DescribeSObjectResult のメソッド

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

fields

fields の後には項目メンバー変数名または getMap メソッドが続きます。

署名

public Schema.SObjectTypeFields fields()

戻り値

型: 戻り値は特殊なデータ型です。fields を使用する方法については、例を参照してください。

使用方法

Apex クラス内から sObject とその項目を記述する場合、クラスが保存されている API バージョンに関係なく、新しいデータ型のカスタム項目が返されます。地理位置情報データ型などのデータ型が最新の API バージョンのみで使用できる場合、クラスが以前のバージョンの API で保存されていても、地理位置情報項目のコンポーネントが返されます。

メモ

例

1Schema.DescribeFieldResult dfr = Schema.SObjectType.Account.fields.Name;

カスタム項目名を取得するには、カスタム項目名を指定します。

fieldSets

fieldSets の後には項目セット名または getMap メソッドが続きます。

署名

public Schema.SObjectTypeFields fieldSets()

戻り値

型: 戻り値は特殊なデータ型です。fieldSets を使用する方法については、例を参照してください。

例

1Schema.DescribeSObjectResult d = 
2  Account.sObjectType.getDescribe();
3Map<String, Schema.FieldSet> FsMap = 
4  d.fieldSets.getMap();

getChildRelationships()

定義される sObject の外部キーがある sObject の名前である、子リレーションのリストを返します。

署名

public Schema.ChildRelationship getChildRelationships()

戻り値

型: List<Schema.ChildRelationship>

例

たとえば、Account オブジェクトには、子リレーションとして Contacts と Opportunities が含まれます。

getDefaultImplementation()

将来の使用のために予約されています。

署名

public String getDefaultImplementation()

戻り値

型: String

getHasSubtypes()

将来の使用のために予約されています。

署名

現在の組織で個人取引先が有効かどうかを確認するには、次のコードスニペットを使用します。Schema.SObjectType.Account.fields.getMap().containsKey( 'isPersonAccount' );

public Boolean getHasSubtypes()

戻り値

型: Boolean

getImplementedBy()

将来の使用のために予約されています。

署名

public String getImplementedBy()

戻り値

型: String

getImplementsInterfaces()

将来の使用のために予約されています。

署名

public String getImplementsInterfaces()

戻り値

型: String

getIsInterface()

将来の使用のために予約されています。

署名

public Boolean getIsInterface()

戻り値

型: Boolean

getKeyPrefix()

オブジェクトの 3 文字のプレフィックスコードを返します。レコード ID は、プレフィックスとしてオブジェクトデータ型を指定する 3 文字コードが付きます (たとえば、取引先には 001 のプレフィックス、商談には 006 のプレフィックスが付きます)。

署名

public String getKeyPrefix()

戻り値

型: String

使用方法

DescribeSobjectResult オブジェクトは、安定したプレフィックスを持つオブジェクトに値を返します。安定したプレフィックスまたは予測可能なプレフィックスを持たないオブジェクトデータ型については、項目は空白です。これらのコードに依存するクライアントアプリケーションは、前方互換性を確保するために、このオブジェクトデータ型を決定する方法を使用できます。

getLabel()

オブジェクト名と一致または一致しないオブジェクトの表示ラベルを返します。

署名

public String getLabel()

戻り値

型: String

使用方法

オブジェクトの表示ラベルは、必ずオブジェクト名と一致するとは限りません。たとえば、医療分野の組織では、Account の表示ラベルを Patient に変更する可能性があります。この表示ラベルは、その後 Salesforce ユーザインターフェースで使用されます。詳細は、Salesforce オンラインヘルプを参照してください。

getLabelPlural()

オブジェクト名と一致または一致しないオブジェクトの複数の表示ラベルを返します。

署名

public String getLabelPlural()

戻り値

型: String

使用方法

オブジェクトの表示ラベル (複数形) は、必ずオブジェクト名と一致するとは限りません。たとえば、医療分野の組織では、Account の複数の表示ラベルを Patient に変更する可能性があります。この表示ラベルは、その後 Salesforce ユーザインターフェースで使用されます。詳細は、Salesforce オンラインヘルプを参照してください。

getLocalName()

getName メソッドと同様、オブジェクト名を返します。ただし、オブジェクトが現在の名前空間の一部である場合、名前の名前空間部分は削除されます。

署名

public String getLocalName()

戻り値

型: String

getName()

オブジェクトの名前を返します。

署名

public String getName()

戻り値

型: String

getRecordTypeInfos()

このオブジェクトがサポートするレコードタイプのリストを返します。このリスト内で参照するには、現在のユーザにレコードタイプへのアクセス権は必要ありません。

署名

public List<Schema.RecordTypeInfo> getRecordTypeInfos()

戻り値

型: List<Schema.RecordTypeInfo>

getRecordTypeInfosByDeveloperName()

関連付けられたレコードタイプに API 参照名を照合する対応付けを返します。この対応付け内で参照するには、現在のユーザにレコードタイプへのアクセス権は必要ありません。

署名

public Map<String, Schema.RecordTypeInfo> getRecordTypeInfosByDeveloperName()

戻り値

型: Map<String, Schema.RecordTypeInfo>

getRecordTypeInfosById()

関連付けられたレコードタイプにレコード ID を照合する対応付けを返します。この対応付け内で参照するには、現在のユーザにレコードタイプへのアクセス権は必要ありません。

署名

public Schema.RecordTypeInfo getRecordTypeInfosById()

戻り値

型: Map<ID, Schema.RecordTypeInfo>

getRecordTypeInfosByName()

関連付けられたレコードタイプにレコードラベルを照合する対応付けを返します。この対応付け内で参照するには、現在のユーザにレコードタイプへのアクセス権は必要ありません。

署名

public Schema.RecordTypeInfo getRecordTypeInfosByName()

戻り値

型: Map<String, Schema.RecordTypeInfo>

getSObjectDescribeOption()

システムによって SObject で使用される有効な describe オプションを返します。

署名

public Schema.SObjectDescribeOptions getSObjectDescribeOption()

戻り値

型: Schema.SObjectDescribeOptions

有効な値は、次のとおりです。
  • SObjectDescribeOptions.FULL: 指標メソッドの呼び出し前に、子リレーションを含む記述のすべての要素を一括で読み込むことを示します。
  • SObjectDescribeOptions.DEFERRED: 子リレーションの遅延読み込みを行うことを示します。これは、メソッドの最初の呼び出し時に一部の子リレーションが読み込まれないことを意味します。

getSobjectType()

sObject の Schema.SObjectType オブジェクトを返します。類似した sObject の作成に使用できます。

署名

public Schema.SObjectType getSobjectType()

戻り値

型: Schema.SObjectType

isAccessible()

現在のユーザがこのオブジェクトを参照できる場合は true、できない場合は false を返します。

署名

public Boolean isAccessible()

戻り値

型: Boolean

isCreateable()

現在のユーザがオブジェクトを作成できる場合は true、できない場合は false を返します。

署名

public Boolean isCreateable()

戻り値

型: Boolean

isCustom()

項目がカスタムオブジェクトの場合は true、標準オブジェクトの場合は false を返します。

署名

public Boolean isCustom()

戻り値

型: Boolean

isCustomSetting()

オブジェクトがカスタム設定の場合は true、そうでない場合は false を返します。

署名

public Boolean isCustomSetting()

戻り値

型: Boolean

isDeletable()

現在のユーザがオブジェクトを削除できる場合は true、できない場合は false を返します。

署名

public Boolean isDeletable()

戻り値

型: Boolean

isDeprecatedAndHidden()

将来の使用のために予約されています。

署名

public Boolean isDeprecatedAndHidden()

戻り値

型: Boolean

isFeedEnabled()

そのオブジェクトで Chatter フィードが有効になっている場合は true、有効でない場合は false を返します。このメソッドは、Salesforce API バージョン 19.0 以降を使用して保存された Apex クラスおよびトリガにのみ使用できます。

署名

public Boolean isFeedEnabled()

戻り値

型: Boolean

isMergeable()

現在のユーザがオブジェクトを同じデータ型の他のオブジェクトとマージできる場合は true、できない場合は false を返します。true は、リード、取引先責任者、および取引先に対して返されます。

署名

public Boolean isMergeable()

戻り値

型: Boolean

isMruEnabled()

オブジェクトで最後に使用 (MRU) リスト機能が有効な場合は true、それ以外の場合は false を返します。

署名

public Boolean isMruEnabled()

戻り値

型: Boolean

isQueryable()

現在のユーザがオブジェクトを照会できる場合は true、照会できない場合は false を返します。

署名

public Boolean isQueryable()

戻り値

型: Boolean

isSearchable()

現在のユーザがオブジェクトを検索できる場合は true、できない場合は false を返します。

署名

public Boolean isSearchable()

戻り値

型: Boolean

isUndeletable()

現在のユーザがオブジェクトを復元できる場合は true、できない場合は false を返します。

署名

public Boolean isUndeletable()

戻り値

型: Boolean

isUpdateable()

現在のユーザがオブジェクトを更新できる場合は true、できない場合は false を返します。

署名

public Boolean isUpdateable()

戻り値

型: Boolean