DescribeFieldResult クラス
名前空間
使用方法
describe オブジェクトの状態と動作は、使用される API バージョンを含めさまざまな要素により決まるため、同じ DescribeFieldResult の feld describe result のインスタンスが等しくなる保証はありません。describe result を比較するには、field describe result で getSObjectField() メソッドをコールし、等価演算子 (==) を使用して SObjectField 値を比較します。
例
1Schema.DescribeFieldResult dfr = Account.Description.getDescribe();DescribeFieldResult のメソッド
DescribeFieldResult のメソッドは次のとおりです。すべてインスタンスメソッドです。
getInlineHelpText()
署名
public String getInlineHelpText()
戻り値
型: String
使用方法
詳細は、Salesforce オンラインヘルプの「項目レベルのヘルプの定義」を参照してください。
getLabel()
署名
public String getLabel()
戻り値
型: String
使用方法
getLength()
署名
public Integer getLength()
戻り値
型: Integer
getLocalName()
署名
public String getLocalName()
戻り値
型: String
getPicklistValues()
署名
public List<Schema.PicklistEntry> getPicklistValues()
戻り値
getPrecision()
署名
public Integer getPrecision()
戻り値
型: Integer
getReferenceTargetField()
署名
public String getReferenceTargetField()
戻り値
型: String
使用方法
間接参照関係についての詳細は、Salesforce ヘルプの「外部オブジェクトの間接参照関係項目」を参照してください。
getReferenceTo()
署名
public List <Schema.sObjectType> getReferenceTo()
戻り値
バージョン管理動作の変更
API バージョン 51.0 以降では、getReferenceTo() メソッドは、コンテキストユーザがアクセスできない参照オブジェクトを返します。コンテキストユーザが、他のオブジェクトを参照するオブジェクトの項目にアクセスできる場合、メソッドは、コンテキストユーザが相互参照されるオブジェクトにアクセスできるかどうかに関係なく参照を返します。API バージョン 50.0 以前では、コンテキストユーザが相互参照されるオブジェクトにアクセスできない場合、メソッドは空のリストを返します。
getRelationshipName()
署名
public String getRelationshipName()
戻り値
型: String
使用方法
リレーションとリレーション名についての詳細は、『SOQL および SOSL リファレンス』���「リレーション名について」を参照してください。
getRelationshipOrder()
署名
public Integer getRelationshipOrder()
戻り値
型: Integer
使用方法
リレーションとリレーション名についての詳細は、『SOQL および SOSL リファレンス』の「リレーション名について」を参照してください。
getScale()
署名
public Integer getScale()
戻り値
型: Integer
使用方法
小数点の左側の桁数が多すぎる場合は、このメソッドはエラー応答を返します。
isAiPredictionField() (ベータ)
署名
public Boolean isAiPredictionField()
戻り値
型: Boolean
使用方法
isAutoNumber()
署名
public Boolean isAutoNumber()
戻り値
型: Boolean
使用方法
SQL IDENTITY 型に似て、Auto Number 項目は参照のみ可能で、作成できない項目であり、最長 30 文字です。Auto Number 項目は、内部オブジェクト ID に依存しない一意な ID を提供します (購入注文番号や請求書番号など)。Auto Number 項目は、全体的に Salesforce ユーザインターフェースで構成されています。
isCalculated()
署名
public Boolean isCalculated()
戻り値
型: Boolean
isCascadeDelete()
署名
public Boolean isCascadeDelete()
戻り値
型: Boolean
isDefaultedOnCreate()
署名
public Boolean isDefaultedOnCreate()
戻り値
型: Boolean
使用方法
このメソッドが true を返す場合、この項目の値が作成コールで渡されなくても、Salesforce はオブジェクト作成時にこの項目の値を暗黙的に割り当てます。たとえば、Opportunity オブジェクトでは値が Stage 項目から取得されているため、Probability 項目にはこの属性が指定されています。同様に、ほとんどのオブジェクトの Owner にはこの属性が設定されています。Owner 項目が特に指定されない限り、値は現在のユーザから取得されます。
isFilterable()
署名
public Boolean isFilterable()
戻り値
型: Boolean
isGroupable()
署名
public Boolean isGroupable()
戻り値
型: Boolean
isHtmlFormatted()
署名
public Boolean isHtmlFormatted()
戻り値
型: Boolean
isIdLookup()
署名
public Boolean isIdLookup()
戻り値
型: Boolean
isNameField()
署名
public Boolean isNameField()
戻り値
型: Boolean
使用方法
このメソッドは、標準オブジェクトの名前項目 (Account オブジェクトの AccountName など) やカスタムオブジェクトの名前項目を識別するために使用します。Contact オブジェクトのように FirstName と LastName 項目が代わりに使用される場合を除き、オブジェクトは名前項目を 1 つのみ持つことができます。
個人取引先の Name 項目などのように複合名が存在する場合、そのレコードの isNameField は true に設定されます。
isNamePointing()
署名
public Boolean isNamePointing()
戻り値
型: Boolean
isNillable()
署名
public Boolean isNillable()
戻り値
型: Boolean
isRestrictedDelete()
署名
public Boolean isRestrictedDelete()
戻り値
型: Boolean
isSearchPrefilterable()
署名
public Boolean isSearchPrefilterable()
戻り値
型: Boolean
使用方法
事前絞り込みでは、完全な検索クエリを実行する前に特定の項目値で絞り込みを行います。事前絞り込みは、WHERE 句で「次の文字列と一致する」 (=) 演算子を使用する場合のみサポートされます。
isUpdateable()
署名
public Boolean isUpdateable()
戻り値
型: Boolean
isWriteRequiresMasterRead()
署名
public Boolean isWriteRequiresMasterRead()
戻り値
型: Boolean