1. EntityBase

クラスEntityBase

Version:
日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

エンティティの基本クラス。

継承
System.Object
EntityBase
名前空間: Stylelabs.M.Sdk.Models.Base
アセンブリ: Stylelabs.M.Sdk.dll
構文
public abstract class EntityBase : object, IEntity, IResource, IDirtyTracking

コンストラクター

EntityBase(IMClient, EntityConstructionArgs)

EntityBase クラスの新しいインスタンスを初期化します。

宣言
protected EntityBase(IMClient client, EntityConstructionArgs args)
パラメーター
名前説明
IMClientclient

クライアント。

EntityConstructionArgsargs

構築パラメーターの集約

プロパティ

Client

宣言
protected IMClient Client { get; }
プロパティ値
説明
IMClient

CreatedBy

このリソースを作成したユーザーの ID を取得します。 作成されていない場合 null

宣言
public long? CreatedBy { get; set; }
プロパティ値
説明
System.Nullable<System.Int64>

CreatedOn

このリソースが作成された日付を取得します。 作成されていない場合 null

宣言
public DateTime? CreatedOn { get; set; }
プロパティ値
説明
System.Nullable<DateTime>

Cultures

エンティティとともに読み込まれたすべてのカルチャの 常に等しくなります。null を返すことはありません。 すべての ICultureSensitiveProperty プロパティには、 これらのカルチャの値のみが含まれます。

宣言
public IReadOnlyList<CultureInfo> Cultures { get; }
プロパティ値
説明
IReadOnlyList<CultureInfo>

DefinitionName

このエンティティを定義する IEntityDefinition の名前を取得します。 名前を取得します。

宣言
public string DefinitionName { get; set; }
プロパティ値
説明
System.String

Id

エンティティの ID を取得します。 この ID はエンティティを特定する、自動的に割り当てられた、読み取り専用の 一意で厳密に正の数です。 エンティティがまだ永続化されていない場合、ID は null です。

宣言
public long? Id { get; set; }
プロパティ値
説明
System.Nullable<System.Int64>

Identifier

エンティティの識別子を取得します。 識別子は、永続化されるまで、新しいエンティティに設定できます。 ただし、常に一意である必要があります。 識別子は、永続化するときに null の場合、自動生成されます。

宣言
public string Identifier { get; set; }
プロパティ値
説明
System.String

InheritsSecurity

InheritsSecurity を持つリレーションを使用して接続された祖先から、 エンティティがセキュリティを継承するかどうかを示す 値を取得または設定します。

宣言
public bool InheritsSecurity { get; set; }
プロパティ値
説明
System.Boolean

IsDirty

宣言
public bool IsDirty { get; }
プロパティ値
説明
System.Boolean

IsNew

宣言
public bool IsNew { get; }
プロパティ値
説明
System.Boolean

IsPathRoot

このエンティティがトップ レベルのパスであるかどうかを示す値を取得または設定します。

宣言
public bool IsPathRoot { get; set; }
プロパティ値
説明
System.Boolean
関連項目

IsRootTaxonomyItem

このエンティティがトップ レベルのファセットであるかどうかを示す値を取得または設定します。

宣言
public bool IsRootTaxonomyItem { get; set; }
プロパティ値
説明
System.Boolean
関連項目

IsSystemOwned

このエンティティをシステムが所有していて、 通常のユーザーにより変更や削除ができないかどうかを示す値を取得または設定します。

宣言
public bool IsSystemOwned { get; set; }
プロパティ値
説明
System.Boolean

IsTracking

宣言
public bool IsTracking { get; }
プロパティ値
説明
System.Boolean

LockedBy

このエンティティをロックしたユーザーの ID を取得します。 ロックされていない場合 null

宣言
public long? LockedBy { get; set; }
プロパティ値
説明
System.Nullable<System.Int64>

LockedOn

このエンティティがロックされた日付を取得します。 ロックされていない場合 null

宣言
public DateTime? LockedOn { get; set; }
プロパティ値
説明
System.Nullable<DateTime>

ModifiedBy

このリソースを変更したユーザーの ID を取得します。 作成されていない場合 null

宣言
public long? ModifiedBy { get; set; }
プロパティ値
説明
System.Nullable<System.Int64>

ModifiedOn

このリソースが変更された日付を取得します。 作成されていない場合 null

宣言
public DateTime? ModifiedOn { get; set; }
プロパティ値
説明
System.Nullable<DateTime>

プロパティ

エンティティに現在読み込まれているすべてのプロパティの リストを取得します。null を返すことはありません。

宣言
public IReadOnlyList<IProperty> Properties { get; }
プロパティ値
説明
IReadOnlyList<IProperty>
備考

新しいプロパティは、遅延読み込みによって追加できます。

Relations

エンティティに現在読み込まれているすべてのリレーションの リストを取得します。null を返すことはありません。

宣言
public IReadOnlyList<IRelation> Relations { get; }
プロパティ値
説明
IReadOnlyList<IRelation>
備考

新しいリレーションは、遅延読み込みによって追加できます。

Renditions

このエンティティに対するすべてのレンディションのリストを取得します。 null を返すことはありません。

宣言
public abstract IReadOnlyList<IRendition> Renditions { get; }
プロパティ値
説明
IReadOnlyList<IRendition>

Version

エンティティの現在のバージョンを取得します。 バージョンは (1から) 単調に増加する数です。 永続ストレージに伝播されたエンティティの変更により、 この数が増加します。

宣言
public long Version { get; set; }
プロパティ値
説明
System.Int64

メソッド

CanDoLazyLoading()

遅延読み込みが可能かどうかを確認します。遅延読み込みは、永続化されたエンティティでのみ可能です。

宣言
public bool CanDoLazyLoading()
戻り値
説明
System.Boolean

遅延読み込みが可能な場合 true

GetEntityDefinitionAsync()

エンティティの IEntityDefinition を取得します。 一度読み込まれ、結果をキャッシュします。

宣言
public Task<IEntityDefinition> GetEntityDefinitionAsync()
戻り値
説明
Task<IEntityDefinition>

エンティティ定義。

GetPermissionsAsync()

現在のユーザーがこのエンティティに対して持っている権限を取得します。

宣言
public abstract Task<ISet<string>> GetPermissionsAsync()
戻り値
説明
Task<ISet<System.String>>

大文字と小文字を区別しない権限のセット。

GetProperty(String)

指定されたプロパティを取得します。 プロパティが見つからない場合、null を返します。

宣言
public IProperty GetProperty(string name)
パラメーター
名前説明
System.Stringname

プロパティ名。

戻り値
説明
IProperty

プロパティ

GetProperty<T>(String)

指定されたプロパティを取得します。 プロパティが見つからない場合、null を返します。

宣言
public T GetProperty<T>(string name)
where T : class, IProperty
パラメーター
名前説明
System.Stringname

プロパティ名。

戻り値
説明
T

プロパティ

型パラメーター
名前説明
T

GetPropertyAsync(String, MemberLoadOption)

指定されたプロパティを取得します。 プロパティが見つからない場合、null を返します。 ただし、プロパティが存在しない場合は、遅延読み込みされる可能性があります。

宣言
public Task<IProperty> GetPropertyAsync(string name, MemberLoadOption loadOption = MemberLoadOption.LazyLoading)
パラメーター
名前説明
System.Stringname

プロパティ名。

MemberLoadOptionloadOption

遅延読み込みを有効 (既定) または無効にします。

戻り値
説明
Task<IProperty>

プロパティ

GetPropertyAsync<T>(String, MemberLoadOption)

指定されたプロパティを取得します。 プロパティが見つからない場合、null を返します。 ただし、プロパティが存在しない場合は、遅延読み込みされる可能性があります。

宣言
public Task<T> GetPropertyAsync<T>(string name, MemberLoadOption loadOption = MemberLoadOption.LazyLoading)
where T : class, IProperty
パラメーター
名前説明
System.Stringname

プロパティ名。

MemberLoadOptionloadOption

遅延読み込みを有効 (既定) または無効にします。

戻り値
説明
Task<T>

プロパティ

型パラメーター
名前説明
T

プロパティの種類。

GetPropertyValue(String)

指定された、カルチャに依存しないプロパティの値を取得します。 プロパティが見つからない場合、null を返します。

宣言
public object GetPropertyValue(string name)
パラメーター
名前説明
System.Stringname

プロパティ名。

戻り値
説明
System.Object

プロパティ

GetPropertyValue(String, CultureInfo)

指定された、カルチャに依存するプロパティの値を取得します。 プロパティが見つからない場合、null を返します。

宣言
public object GetPropertyValue(string name, CultureInfo culture)
パラメーター
名前説明
System.Stringname

プロパティ名。

CultureInfoculture
戻り値
説明
System.Object

プロパティ

GetPropertyValue<T>(String)

指定された、カルチャに依存しないプロパティの値を取得し、 対応する型にキャストします。 プロパティが見つからない場合、null を返します。

宣言
public T GetPropertyValue<T>(string name)
パラメーター
名前説明
System.Stringname

プロパティ名。

戻り値
説明
T

プロパティ

型パラメーター
名前説明
T

GetPropertyValue<T>(String, CultureInfo)

指定された、カルチャに依存するプロパティの値を取得し、 対応する型にキャストします。 プロパティが見つからない場合、null を返します。

宣言
public T GetPropertyValue<T>(string name, CultureInfo culture)
パラメーター
名前説明
System.Stringname

プロパティ名。

CultureInfoculture
戻り値
説明
T

プロパティ

型パラメーター
名前説明
T

GetPropertyValueAsync(String, CultureInfo, MemberLoadOption)

宣言
public Task<object> GetPropertyValueAsync(string name, CultureInfo culture, MemberLoadOption loadOption = MemberLoadOption.LazyLoading)
パラメーター
名前説明
System.Stringname
CultureInfoculture
MemberLoadOptionloadOption
戻り値
説明
Task<System.Object>

GetPropertyValueAsync(String, MemberLoadOption)

指定された、カルチャに依存しないプロパティの値を取得し、 対応する型にキャストします。 プロパティが存在しない場合は、遅延読み込みされる可能性があります。

宣言
public Task<object> GetPropertyValueAsync(string name, MemberLoadOption loadOption = MemberLoadOption.LazyLoading)
パラメーター
名前説明
System.Stringname

プロパティ名。

MemberLoadOptionloadOption

遅延読み込みを有効 (既定) または無効にします。

戻り値
説明
Task<System.Object>

プロパティの値。 プロパティが存在しないか、読み込まれていない場合は、 null を返します。

GetPropertyValueAsync<T>(String, CultureInfo, MemberLoadOption)

指定された、カルチャに依存しないプロパティの値を取得し、 対応する型に変換します。 プロパティが存在しない場合は、遅延読み込みされる可能性があります。

宣言
public Task<T> GetPropertyValueAsync<T>(string name, CultureInfo culture, MemberLoadOption loadOption = MemberLoadOption.LazyLoading)
パラメーター
名前説明
System.Stringname

プロパティ名。

CultureInfoculture

値のカルチャ。

MemberLoadOptionloadOption

遅延読み込みを有効 (既定) または無効にします。

戻り値
説明
Task<T>

特定のカルチャ内のプロパティ値。 プロパティが存在しないか、読み込まれていない場合は、 null を返します。

型パラメーター
名前説明
T

値のタイプ。

GetPropertyValueAsync<T>(String, MemberLoadOption)

指定された、カルチャに依存しないプロパティの値を取得し、 対応する型にキャストします。 プロパティが存在しない場合は、遅延読み込みされる可能性があります。

宣言
public Task<T> GetPropertyValueAsync<T>(string name, MemberLoadOption loadOption = MemberLoadOption.LazyLoading)
パラメーター
名前説明
System.Stringname

プロパティ名。

MemberLoadOptionloadOption

遅延読み込みを有効 (既定) または無効にします。

戻り値
説明
Task<T>

プロパティの値。 プロパティが存在しないか、読み込まれていない場合は、 null を返します。

型パラメーター
名前説明
T

値のタイプ。

GetRelation(String, Nullable<RelationRole>)

名前でリレーションを取得します。 リレーションが見つからなかった場合は null を返します。

宣言
public IRelation GetRelation(string name, RelationRole? role = null)
パラメーター
名前説明
System.Stringname

リレーションの名前。

System.Nullable<RelationRole>role
戻り値
説明
IRelation

リレーション

GetRelation<T>(String)

名前でリレーションを取得し、指定されたインターフェイスによってロールを自動的に解決しようとします。 リレーションが見つからなかった場合は null を返します。

宣言
public T GetRelation<T>(string name)
where T : class, IRelation
パラメーター
名前説明
System.Stringname

リレーションの名前。

戻り値
説明
T

リレーション

型パラメーター
名前説明
T

GetRelationAsync(String, Nullable<RelationRole>, MemberLoadOption)

エンティティからリレーションを取得します。 リレーションが見つからなかった場合は null を返します。 ただし、リレーションが存在しない場合は、遅延読み込みされる可能性があります。

宣言
public Task<IRelation> GetRelationAsync(string name, RelationRole? role = null, MemberLoadOption loadOption = MemberLoadOption.LazyLoading)
パラメーター
名前説明
System.Stringname

リレーション名。

System.Nullable<RelationRole>role

リレーションのロール。

MemberLoadOptionloadOption

遅延読み込みを有効 (既定) または無効にします。

戻り値
説明
Task<IRelation>

リレーション、またはリレーションが存在しないか、遅延読み込みされていない場合 null

GetRelationAsync<T>(String, MemberLoadOption)

名前でリレーションを取得し、指定されたインターフェイスによってロールを自動的に解決しようとします。 リレーションが見つからなかった場合は null を返します。 リレーションが存在しない場合は、遅延読み込みされる可能性があります。

宣言
public Task<T> GetRelationAsync<T>(string name, MemberLoadOption loadOption = MemberLoadOption.LazyLoading)
where T : class, IRelation
パラメーター
名前説明
System.Stringname

リレーション名。

MemberLoadOptionloadOption

遅延読み込みを有効 (既定) または無効にします。

戻り値
説明
Task<T>

リレーション、またはリレーションが存在しないか、遅延読み込みされていない場合 null

型パラメーター
名前説明
T

リレーションのタイプ。

GetRendition(String)

IRendition を名前で取得します。

宣言
public abstract IRendition GetRendition(string name)
パラメーター
名前説明
System.Stringname

レンディションの名前

戻り値
説明
IRendition

レンディション、またはレンディションが存在しない場合は null

LoadMembersAsync(IPropertyLoadOption, IRelationLoadOption)

指定されたメンバーを現在のエンティティに読み込みます。 実際にメンバーが欠落している場合にのみ読み込まれ、既存のメンバーを上書きしません。

宣言
public Task<bool> LoadMembersAsync(IPropertyLoadOption propertyLoadOption, IRelationLoadOption relationLoadOption)
パラメーター
名前説明
IPropertyLoadOptionpropertyLoadOption

読み込むプロパティ。

IRelationLoadOptionrelationLoadOption

読み込むリレーション。

戻り値
説明
Task<System.Boolean>

現在のエンティティに新しいメンバーが追加された場合 true

備考

カルチャに依存するプロパティは、現在のカルチャにのみ読み込まれます。 遅延読み込みは、新規ではないエンティティでのみ可能です。

LoadPropertiesAsync(IPropertyLoadOption)

指定されたプロパティを現在のエンティティに読み込みます。 実際にプロパティが欠落している場合にのみ読み込まれ、既存のプロパティを上書きしません。

宣言
public Task<bool> LoadPropertiesAsync(IPropertyLoadOption propertyLoadOption)
パラメーター
名前説明
IPropertyLoadOptionpropertyLoadOption

読み込むプロパティ。

戻り値
説明
Task<System.Boolean>

現在のエンティティに新しいプロパティが追加された場合 true

備考

カルチャに依存するプロパティは、現在のカルチャにのみ読み込まれます。 遅延読み込みは、新規ではないエンティティでのみ可能です。

LoadRelationsAsync(IRelationLoadOption)

指定されたリレーションを現在のエンティティに読み込みます。 実際にリレーションが欠落している場合にのみ読み込まれ、既存のリレーションを上書きしません。

宣言
public Task<bool> LoadRelationsAsync(IRelationLoadOption relationLoadOption)
パラメーター
名前説明
IRelationLoadOptionrelationLoadOption

読み込むリレーション。

戻り値
説明
Task<System.Boolean>

現在のエンティティに新しいメンバーが追加された場合 true

備考

遅延読み込みは、新規ではないエンティティでのみ可能です。

MarkClean()

宣言
public void MarkClean()

SetPropertyValue(String, CultureInfo, Object)

指定された、カルチャに依存するプロパティの値を 設定します。

宣言
public void SetPropertyValue(string name, CultureInfo culture, object value)
パラメーター
名前説明
System.Stringname

プロパティ名。

CultureInfoculture

値のカルチャ

System.Objectvalue

プロパティ値。

例外
条件
PropertyNotFoundException

プロパティが存在しない場合や読み込まれなかった場合。

SetPropertyValue(String, Object)

指定された、カルチャに依存しないプロパティの値を 設定します。

宣言
public void SetPropertyValue(string name, object value)
パラメーター
名前説明
System.Stringname

プロパティ名。

System.Objectvalue

プロパティ値。

例外
条件
PropertyNotFoundException

プロパティが存在しない場合や読み込まれなかった場合。

StartTracking()

オブジェクトの変更の追跡を開始します。

宣言
public void StartTracking()

実装

この記事を改善するための提案がある場合は、 お知らせください!