Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

SPPersistedObject 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.

  NameDescription
Public method SPPersistedObject() Initializes a new instance of the SPPersistedObject class.
Protected method SPPersistedObject(String, SPPersistedObject) Initializes a new instance of the SPPersistedObject class based on the specified name and parent object.
Protected method SPPersistedObject(String, SPPersistedObject, Guid) Initializes a new instance of the SPPersistedObject class based on the specified name, parent object, and GUID.
Top
  NameDescription
Public property DisplayName Gets the display name that describes the persisted object instance within the administrative user interface.
Public property Farm Gets the server farm where the object resides.
Public property Id Gets or sets the GUID that is associated with the object.
Public property Name Gets or sets a name that is used to uniquely identify two objects that have the same parent and class.
Public property Parent Gets the parent in the logical hierarchy of the configuration object tree.
Public property Properties Gets metadata for the persisted object.
Public property Status Gets or sets the status of the object that the class represents.
Public property TypeName Gets the display name that describes the object type in the administrative user interface.
Public property UpgradedPersistedProperties Gets the collection of field names and values for fields that were deleted or changed. (Inherited from SPAutoSerializingObject.)
Public property Version Gets a value that is incremented each time the object is updated.
Protected property WasCreated Gets a Boolean value that indicates whether the object is initialized and can be found in the database.
Top
  NameDescription
Public method 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.
Public method Delete Deletes the object.
Public method Equals Determines whether the current persisted object equals the specified object. (Overrides Object.Equals(Object).)
Protected method Finalize (Inherited from Object.)
Public method GetChild<T>() Returns the child of the persisted object based on the specified type.
Public method GetChild<T>(String) Returns the child object of the persisted object based on the specified name.
Public method GetHashCode Serves as a hash function for the persisted object. (Overrides Object.GetHashCode().)
Public method GetObjectData Gets the serialized state of the object. (Inherited from SPAutoSerializingObject.)
Public method GetType (Inherited from Object.)
Protected method HasAdditionalUpdateAccess Override this method to allow more users to update the object.
Protected method MemberwiseClone (Inherited from Object.)
Protected method OnDeserialization Called immediately after the base class deserializes itself to do additional work. (Overrides SPAutoSerializingObject.OnDeserialization().)
Public method Provision Makes the changes to the local server that are needed before the object can be used.
Public method ToString Returns the type and name of an object and of all its ancestors (parent, grandparent, and so on). (Overrides Object.ToString().)
Public method Uncache Frees the memory cache that is used by the object.
Public method Unprovision Makes the changes to the local server that are needed to clean up after deleting the object.
Public method Update() Causes the object to save its state and propagate changes to all the computers in the server farm.
Public method 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.
Protected method UpdateParent Causes the containing SPPersistedObject, if one exists, to update its state. (Inherited from SPAutoSerializingObject.)
Protected method Validate Validates the state of all fields before persisting the object.
Top
  NameDescription
Public operator Static member Equality Returns a Boolean value that indicates whether the two specified persisted objects are equal.
Public operator Static member Inequality Returns a Boolean value that indicates whether the two specified persisted objects are not equal.
Top
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.