SPPersistedObject Members
Include Protected Members
Include Inherited Members
Provides the methods for an object to automatically serialize its state, persist that state in a permanent store, retrieve it at a later time, and deserialize it back into an in-memory object.
The SPPersistedObject type exposes the following members.
Constructors
Name | Description | |
---|---|---|
SPPersistedObject() | Initializes a new instance of the SPPersistedObject class. | |
SPPersistedObject(String, SPPersistedObject) | Initializes a new instance of the SPPersistedObject class based on the specified name and parent object. | |
SPPersistedObject(String, SPPersistedObject, Guid) | Initializes a new instance of the SPPersistedObject class based on the specified name, parent object, and GUID. |
Top
Properties
Name | Description | |
---|---|---|
DisplayName | Gets the display name that describes the persisted object instance within the administrative user interface. | |
Farm | Gets the server farm where the object resides. | |
Id | Gets or sets the GUID that is associated with the object. | |
Name | Gets or sets a name that is used to uniquely identify two objects that have the same parent and class. | |
Parent | Gets the parent in the logical hierarchy of the configuration object tree. | |
Properties | Gets metadata for the persisted object. | |
Status | Gets or sets the status of the object that the class represents. | |
TypeName | Gets the display name that describes the object type in the administrative user interface. | |
UpgradedPersistedProperties | Gets the collection of field names and values for fields that were deleted or changed. (Inherited from SPAutoSerializingObject.) | |
Version | Gets a value that is incremented each time the object is updated. | |
WasCreated | Gets a Boolean value that indicates whether the object is initialized and can be found in the database. |
Top
Methods
Name | Description | |
---|---|---|
Clone | Returns a clone of the object that does not come from the in-memory cache, which enables calling code to help ensure thread safety. | |
Delete | Deletes the object. | |
Equals | Determines whether the current persisted object equals the specified object. (Overrides Object.Equals(Object).) | |
Finalize | (Inherited from Object.) | |
GetChild<T>() | Returns the child of the persisted object based on the specified type. | |
GetChild<T>(String) | Returns the child object of the persisted object based on the specified name. | |
GetHashCode | Serves as a hash function for the persisted object. (Overrides Object.GetHashCode().) | |
GetObjectData | Gets the serialized state of the object. (Inherited from SPAutoSerializingObject.) | |
GetType | (Inherited from Object.) | |
HasAdditionalUpdateAccess | Override this method to allow more users to update the object. | |
MemberwiseClone | (Inherited from Object.) | |
OnDeserialization | Called immediately after the base class deserializes itself to do additional work. (Overrides SPAutoSerializingObject.OnDeserialization().) | |
Provision | Makes the changes to the local server that are needed before the object can be used. | |
ToString | Returns the type and name of an object and of all its ancestors (parent, grandparent, and so on). (Overrides Object.ToString().) | |
Uncache | Frees the memory cache that is used by the object. | |
Unprovision | Makes the changes to the local server that are needed to clean up after deleting the object. | |
Update() | Causes the object to save its state and propagate changes to all the computers in the server farm. | |
Update(Boolean) | Causes the object to save its state and propagate changes to all the computers in the server farm, optionally throwing an exception if the object already exists in the configuration store. | |
UpdateParent | Causes the containing SPPersistedObject, if one exists, to update its state. (Inherited from SPAutoSerializingObject.) | |
Validate | Validates the state of all fields before persisting the object. |
Top
Operators
Name | Description | |
---|---|---|
Equality | Returns a Boolean value that indicates whether the two specified persisted objects are equal. | |
Inequality | Returns a Boolean value that indicates whether the two specified persisted objects are not equal. |
Top