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

DescribeFieldResult クラス

sObject 項目を記述するメソッドが含まれます。

名前空間

Schema

使用方法

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

次に、Field Describe Result オブジェクトをインスタンス化する方法の例を示します。
1Schema.DescribeFieldResult dfr = Account.Description.getDescribe();

DescribeFieldResult のメソッド

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

getByteLength()

可変長項目 (バイナリ項目も含む) の場合は、最大サイズをバイトで返します。

署名

public Integer getByteLength()

戻り値

型: Integer

getCalculatedFormula()

この項目に指定された数式を返します。

署名

public String getCalculatedFormula()

戻り値

型: String

getController()

制御項目のトークンを返します。

署名

public Schema.sObjectField getController()

戻り値

型: Schema.SObjectField

getDefaultValue()

この項目のデフォルト値を返します。

署名

public Object getDefaultValue()

戻り値

型: Object

getDefaultValueFormula()

数式が使用されていない場合、この項目に指定されたデフォルト値を返します。

署名

public String getDefaultValueFormula()

戻り値

型: String

getDigits()

項目に指定された桁の最大数を返します。このメソッドは、integer 項目でのみ有効です。

署名

public Integer getDigits()

戻り値

型: Integer

getInlineHelpText()

項目レベルのヘルプの内容を返します。

署名

public String getInlineHelpText()

戻り値

型: String

使用方法

詳細は、Salesforce オンラインヘルプの「項目レベルのヘルプの定義」を参照してください。

getLabel()

Salesforce ユーザインターフェースの項目の隣に表示されるテキストラベルを返します。このラベルはローカライズが可能です。

署名

public String getLabel()

戻り値

型: String

使用方法

標準オブジェクトの [種別] 項目の場合、getLabel はデフォルトのラベルとは異なるラベルを返します。これは、Object Type という形式のラベルを返します。Object は標準オブジェクトラベルです。たとえば、[取引先] の [種別] 項目の場合、getLabel はデフォルトラベルの Type ではなく、Account Type を返します。[種別] ラベルの名前が変更されると、getLabel によって新しいラベルが返されます。すべての標準オブジェクト項目の表示ラベルを確認または変更するには、[設定] から、[クイック検索] ボックス「タブと表示ラベルの名称変更」と入力し、[タブと表示ラベルの名称変更] を選択します。

メモ

getLength()

Unicode 文字での DescribeFieldResult オブジェクトの項目の最大サイズ (バイト数ではない) を返します。

署名

public Integer getLength()

戻り値

型: Integer

getLocalName()

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

署名

public String getLocalName()

戻り値

型: String

getName()

Apex で使用される項目名を返します。

署名

public String getName()

戻り値

型: String

getPicklistValues()

PicklistEntry オブジェクトのリストを返します。項目が選択リストでない場合、ランタイムエラーを返します。

署名

public List<Schema.PicklistEntry> getPicklistValues()

戻り値

型: List<Schema.PicklistEntry>

getPrecision()

データ型 double の項目には、小数点の右側と左側の両方をあわせた (ただし小数点自体は含まない)、格納可能な最大桁数を返します。

署名

public Integer getPrecision()

戻り値

型: Integer

getReferenceTargetField()

値が外部子オブジェクトの間接参照関係項目の値と照合される標準親オブジェクトまたはカスタム親オブジェクトのカスタム項目の名前を返します。この照合により、どのレコードが相互に関連しているかを判断します。

署名

public String getReferenceTargetField()

戻り値

型: String

使用方法

間接参照関係についての詳細は、Salesforce ヘルプの「外部オブジェクトの間接参照関係項目」を参照してください。

getReferenceTo()

この項目の親オブジェクトの Schema.sObjectType オブジェクトのリストを返します。isNamePointing メソッドが true を返す場合、リストには複数のエントリがあります。返さない場合、エントリは 1 つのみです。

署名

public List <Schema.sObjectType> getReferenceTo()

戻り値

型: List<Schema.sObjectType>

バージョン管理動作の変更

API バージョン 51.0 以降では、getReferenceTo() メソッドは、コンテキストユーザがアクセスできない参照オブジェクトを返します。コンテキストユーザが、他のオブジェクトを参照するオブジェクトの項目にアクセスできる場合、メソッドは、コンテキストユーザが相互参照されるオブジェクトにアクセスできるかどうかに関係なく参照を返します。API バージョン 50.0 以前では、コンテキストユーザが相互参照されるオブジェクトにアクセスできない場合、メソッドは空のリストを返します。

getRelationshipName()

リレーションの名前を返します。

署名

public String getRelationshipName()

戻り値

型: String

使用方法

リレーションとリレーション名についての詳細は、『SOQL および SOSL リファレンス』���「リレーション名について」を参照してください。

getRelationshipOrder()

項目が子の場合は 1、子でない場合は 0 を返します。

署名

public Integer getRelationshipOrder()

戻り値

型: Integer

使用方法

リレーションとリレーション名についての詳細は、『SOQL および SOSL リファレンス』「リレーション名について」を参照してください。

getScale()

データ型 double の項目には、小数点の右側の桁数を返します。小数点の右側に余分な桁がある場合は、切り捨てられます。

署名

public Integer getScale()

戻り値

型: Integer

使用方法

小数点の左側の桁数が多すぎる場合は、このメソッドはエラー応答を返します。

getSOAPType()

項目のデータ型に応じて、SoapType 列挙値の 1 つを返します。

署名

public Schema.SOAPType getSOAPType()

戻り値

型: Schema.SOAPType

getSObjectField()

この項目のトークンを返します。

署名

public Schema.sObjectField getSObjectField()

戻り値

型: Schema.SObjectField

getType()

項目のデータ型に応じて、DisplayType 列挙値の 1 つを返します。

署名

public Schema.DisplayType getType()

戻り値

型: Schema.DisplayType

isAccessible()

現在のユーザがこの項目を参照できる場合は true、できない場合は false を返します。

署名

public Boolean isAccessible()

戻り値

型: Boolean

isAiPredictionField() (ベータ)

Einstein 予測データを表示するように現在の項目が有効化されている場合は true を返し、それ以外の場合は false を返します。

署名

public Boolean isAiPredictionField()

戻り値

型: Boolean

使用方法

Einstein 予測値を表示するようにカスタム数値項目を設定できます。Einstein 予測ビルダーのベータプログラムに参加している場合は、Einstein 予測ビルダーを使用して、表示する値を設定します。この方法を使用して、Einstein 予測値を表示するように項目が有効化されているかどうかを調べます。

isAutoNumber()

項目が Auto Number 項目の場合は true、そうでない場合は false を返します。

署名

public Boolean isAutoNumber()

戻り値

型: Boolean

使用方法

SQL IDENTITY 型に似て、Auto Number 項目は参照のみ可能で、作成できない項目であり、最長 30 文字です。Auto Number 項目は、内部オブジェクト ID に依存しない一意な ID を提供します (購入注文番号や請求書番号など)。Auto Number 項目は、全体的に Salesforce ユーザインターフェースで構成されています。

isCalculated()

項目がカスタム数式項目の場合は true、そうでない場合は false を返します。カスタム数式項目は常に参照のみです。

署名

public Boolean isCalculated()

戻り値

型: Boolean

isCascadeDelete()

親オブジェクトの削除時に子オブジェクトが削除される場合は true、削除されない場合は false を返します。

署名

public Boolean isCascadeDelete()

戻り値

型: Boolean

isCaseSensitive()

項目が大文字と小文字を区別する場合は true、区別しない場合は false を返します。

署名

public Boolean isCaseSensitive()

戻り値

型: Boolean

isCreateable()

現在のユーザが項目を作成できる場合は true、できない場合は false を返します。

署名

public Boolean isCreateable()

戻り値

型: Boolean

isCustom()

項目がカスタム項目の場合は true を、Name などの標準項目の場合は false を返します。

署名

public Boolean isCustom()

戻り値

型: Boolean

isDefaultedOnCreate()

作成時に項目がデフォルト値を受け取る場合は true、受け取らない場合は false を返します。

署名

public Boolean isDefaultedOnCreate()

戻り値

型: Boolean

使用方法

このメソッドが true を返す場合、この項目の値が作成コールで渡されなくても、Salesforce はオブジェクト作成時にこの項目の値を暗黙的に割り当てます。たとえば、Opportunity オブジェクトでは値が Stage 項目から取得されているため、Probability 項目にはこの属性が指定されています。同様に、ほとんどのオブジェクトの Owner にはこの属性が設定されています。Owner 項目が特に指定されない限り、値は現在のユーザから取得されます。

isDependentPicklist()

選択リストが連動選択リストの場合は true、そうでない場合は false を返します。

署名

public Boolean isDependentPicklist()

戻り値

型: Boolean

isDeprecatedAndHidden()

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

署名

public Boolean isDeprecatedAndHidden()

戻り値

型: Boolean

isExternalID()

項目が外部 ID として使用されている場合は true、そうでない場合は false を返します。

署名

public Boolean isExternalID()

戻り値

型: Boolean

isFilterable()

項目を WHERE ステートメントの検索条件の一部として使用できる場合は true、そうでない場合は false を返します。

署名

public Boolean isFilterable()

戻り値

型: Boolean

isFormulaTreatNullNumberAsZero()

数式項目で null が 0 として処理される場合は true、そうでない場合は false を返します。

署名

public Boolean isFormulaTreatNullNumberAsZero()

戻り値

型: Boolean

isGroupable()

項目が SOQL クエリの GROUP BY 句に含まれる場合は true、含まれない場合は false を返します。このメソッドは、API バージョン 18.0 以降を使用して保存された Apex クラスおよびトリガにのみ使用できます。

署名

public Boolean isGroupable()

戻り値

型: Boolean

isHtmlFormatted()

項目が HTML のために形式化されており、HTML として表示されるように符号化する必要がある場合は true、そうでない場合は false を返します。このメソッドに対して true を返す項目の例の 1 つは、ハイパーリンクのカスタム数式項目です。もう 1 つの例は、IMAGE テキスト関数があるカスタム数式項目です。

署名

public Boolean isHtmlFormatted()

戻り値

型: Boolean

isIdLookup()

upsert メソッドでレコードを指定するために項目を使用できる場合は true、使用できない場合は false を返します。

署名

public Boolean isIdLookup()

戻り値

型: Boolean

isNameField()

項目が名前項目の場合は true、そうでない場合は false を返します。

署名

public Boolean isNameField()

戻り値

型: Boolean

使用方法

このメソッドは、標準オブジェクトの名前項目 (Account オブジェクトの AccountName など) やカスタムオブジェクトの名前項目を識別するために使用します。Contact オブジェクトのように FirstNameLastName 項目が代わりに使用される場合を除き、オブジェクトは名前項目を 1 つのみ持つことができます。

個人取引先の Name 項目などのように複合名が存在する場合、そのレコードの isNameFieldtrue に設定されます。

isNamePointing()

項目が複数のデータ型のオブジェクトを親として持つことが可能な場合、true を返します。たとえば、ToDo は [取引先責任者/リード ID] (WhoId) 項目と [商談/取引先 ID] (WhatId) 項目の両方を持つことができ、いずれかのオブジェクトが特定 ToDo レコードの親になる可能性があるため、このメソッドに対して true を返します。それ以外の場合、このメソッドは false を返します。

署名

public Boolean isNamePointing()

戻り値

型: Boolean

isNillable()

項目を空白にできる場合は true、できない場合は false を返します。null 値が許可される項目は、中身を空にすることができます。空白にできない項目では、オブジェクトを作成して保存するには必ず値を設定する必要があります。

署名

public Boolean isNillable()

戻り値

型: Boolean

isPermissionable()

項目に項目の権限を指定できる場合は true、そうでない場合は false を返します。

署名

public Boolean isPermissionable()

戻り値

型: Boolean

isRestrictedDelete()

子オブジェクトから参照されるため親オブジェクトを削除できない場合は true を返し、削除できる場合は false を返します。

署名

public Boolean isRestrictedDelete()

戻り値

型: Boolean

isRestrictedPicklist()

項目が制限つき選択リストの場合は true、そうでない場合は false を返します。

署名

public Boolean isRestrictedPicklist()

戻り値

型: Boolean

isSearchPrefilterable()

外部キーを SOSL WHERE 句で使用するときに外部キーを事前絞り込みに組み込むことができる場合は true を返し、それ以外の場合は false を返します。

署名

public Boolean isSearchPrefilterable()

戻り値

型: Boolean

使用方法

事前絞り込みでは、完全な検索クエリを実行する前に特定の項目値で絞り込みを行います。事前絞り込みは、WHERE 句で「次の文字列と一致する」 (=) 演算子を使用する場合のみサポートされます。

isSortable()

項目上でクエリを並び替えられる場合は true、できない場合は false を返します。

署名

public Boolean isSortable()

戻り値

型: Boolean

isUnique()

項目の値を一意にする必要がある場合は true、そうでない場合は false を返します。

署名

public Boolean isUnique()

戻り値

型: Boolean

isUpdateable()

現在のユーザが項目を編集できる場合、またはカスタムオブジェクトの主従関係項目である子レコードの親を別の親レコードに変更できる場合は true、できない場合は、false を返します。

署名

public Boolean isUpdateable()

戻り値

型: Boolean

isWriteRequiresMasterRead()

詳細オブジェクトへの書き込みに親の参照・更新共有ではなく参照共有が必要な場合は、true を返します。

署名

public Boolean isWriteRequiresMasterRead()

戻り値

型: Boolean