/
InstancePersistenceCommand.xml
159 lines (153 loc) · 10.1 KB
/
InstancePersistenceCommand.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
<Type Name="InstancePersistenceCommand" FullName="System.Runtime.DurableInstancing.InstancePersistenceCommand">
<TypeSignature Language="C#" Value="public abstract class InstancePersistenceCommand" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit InstancePersistenceCommand extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.Runtime.DurableInstancing.InstancePersistenceCommand" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class InstancePersistenceCommand" />
<TypeSignature Language="F#" Value="type InstancePersistenceCommand = class" />
<TypeSignature Language="C++ CLI" Value="public ref class InstancePersistenceCommand abstract" />
<AssemblyInfo>
<AssemblyName>System.Runtime.DurableInstancing</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Base class for all persistence related commands. Commands are distinguished by their Name. Usually commands can also be distinguished by their derived type.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected InstancePersistenceCommand (System.Xml.Linq.XName name);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(class System.Xml.Linq.XName name) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Runtime.DurableInstancing.InstancePersistenceCommand.#ctor(System.Xml.Linq.XName)" />
<MemberSignature Language="VB.NET" Value="Protected Sub New (name As XName)" />
<MemberSignature Language="F#" Value="new System.Runtime.DurableInstancing.InstancePersistenceCommand : System.Xml.Linq.XName -> System.Runtime.DurableInstancing.InstancePersistenceCommand" Usage="new System.Runtime.DurableInstancing.InstancePersistenceCommand name" />
<MemberSignature Language="C++ CLI" Value="protected:
 InstancePersistenceCommand(System::Xml::Linq::XName ^ name);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime.DurableInstancing</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="name" Type="System.Xml.Linq.XName" />
</Parameters>
<Docs>
<param name="name">The XName (the combination of namespace and name) of the command.</param>
<summary>Initializes an instance of the <see cref="T:System.Runtime.DurableInstancing.InstancePersistenceCommand" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AutomaticallyAcquiringLock">
<MemberSignature Language="C#" Value="protected internal virtual bool AutomaticallyAcquiringLock { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool AutomaticallyAcquiringLock" />
<MemberSignature Language="DocId" Value="P:System.Runtime.DurableInstancing.InstancePersistenceCommand.AutomaticallyAcquiringLock" />
<MemberSignature Language="VB.NET" Value="Protected Friend Overridable ReadOnly Property AutomaticallyAcquiringLock As Boolean" />
<MemberSignature Language="F#" Value="member this.AutomaticallyAcquiringLock : bool" Usage="System.Runtime.DurableInstancing.InstancePersistenceCommand.AutomaticallyAcquiringLock" />
<MemberSignature Language="C++ CLI" Value="protected public:
 virtual property bool AutomaticallyAcquiringLock { bool get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime.DurableInstancing</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Indicates whether the command could attempt to acquire a lock on the instance.</summary>
<value>
<see langword="true" /> if the command acquires a lock on the instance;, otherwise <see langword="false" />. The default is <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The command classes that derive from this class can override this property to set it to `true`.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="IsTransactionEnlistmentOptional">
<MemberSignature Language="C#" Value="protected internal virtual bool IsTransactionEnlistmentOptional { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsTransactionEnlistmentOptional" />
<MemberSignature Language="DocId" Value="P:System.Runtime.DurableInstancing.InstancePersistenceCommand.IsTransactionEnlistmentOptional" />
<MemberSignature Language="VB.NET" Value="Protected Friend Overridable ReadOnly Property IsTransactionEnlistmentOptional As Boolean" />
<MemberSignature Language="F#" Value="member this.IsTransactionEnlistmentOptional : bool" Usage="System.Runtime.DurableInstancing.InstancePersistenceCommand.IsTransactionEnlistmentOptional" />
<MemberSignature Language="C++ CLI" Value="protected public:
 virtual property bool IsTransactionEnlistmentOptional { bool get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime.DurableInstancing</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns a value that indicates whether the persistence provider may choose not to enlist in the ambient transaction (Transaction.Current) when executing this command.</summary>
<value>
<see langword="true" /> if enlisting in the transaction is optional for this command, otherwise <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The command classes that derive from this class can override this property to set it to `true`.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public System.Xml.Linq.XName Name { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Xml.Linq.XName Name" />
<MemberSignature Language="DocId" Value="P:System.Runtime.DurableInstancing.InstancePersistenceCommand.Name" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Name As XName" />
<MemberSignature Language="F#" Value="member this.Name : System.Xml.Linq.XName" Usage="System.Runtime.DurableInstancing.InstancePersistenceCommand.Name" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Xml::Linq::XName ^ Name { System::Xml::Linq::XName ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime.DurableInstancing</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Xml.Linq.XName</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the name of the persistence command.</summary>
<value>An XName (the combination of namespace and name).</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Validate">
<MemberSignature Language="C#" Value="protected internal virtual void Validate (System.Runtime.DurableInstancing.InstanceView view);" />
<MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig newslot virtual instance void Validate(class System.Runtime.DurableInstancing.InstanceView view) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Runtime.DurableInstancing.InstancePersistenceCommand.Validate(System.Runtime.DurableInstancing.InstanceView)" />
<MemberSignature Language="VB.NET" Value="Protected Friend Overridable Sub Validate (view As InstanceView)" />
<MemberSignature Language="F#" Value="abstract member Validate : System.Runtime.DurableInstancing.InstanceView -> unit
override this.Validate : System.Runtime.DurableInstancing.InstanceView -> unit" Usage="instancePersistenceCommand.Validate view" />
<MemberSignature Language="C++ CLI" Value="protected public:
 virtual void Validate(System::Runtime::DurableInstancing::InstanceView ^ view);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime.DurableInstancing</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="view" Type="System.Runtime.DurableInstancing.InstanceView" />
</Parameters>
<Docs>
<param name="view">An <see cref="T:System.Runtime.DurableInstancing.InstanceView" /> object representing the current state of the instance handle.</param>
<summary>Validates the command.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Commands override Validate to ensure that a command is valid to execute at the current time. Implementations should throw an InvalidOperationException if the command is not valid to execute against the InstanceView passed as a parameter. The Validate method is called by InstanceStore before the command is passed to InstanceStore.TryCommand.
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>