SPSolution members

Represents a solution on a farm.

The SPSolution type exposes the following members.

Constructors

  Name Description
Public method SPSolution Reserved for internal use only.

Top

Properties

  Name Description
Public property Added Gets a value specifying whether a language-neutral solution package has been added to this solution.
Public property CanSelectForBackup Gets or sets whether this item can be selected by itself for backup operations.
Public property CanSelectForRestore Gets or sets whether this item can be selected by itself for restore operations.
Public property ContainsCasPolicy Gets a Boolean value that indicates whether the solution contains Code Access Security (CAS) policies.
Public property ContainsGlobalAssembly Returns a value indicating whether the solution contains an assembly that is installed in the global assembly cache.
Public property ContainsWebApplicationResource Gets a value indicating whether the solution contains any web application-specific resources to deploy.
Public property Deployed Returns a value indicating whether the solution is deployed to one or more web applications in the farm.
Public property DeployedServers Gets the collection of servers to which the solution is deployed.
Public property DeployedWebApplications Gets the collection of web applications to which this solution is deployed.
Public property DeploymentLocked (Inherited from SPPersistedObject.)
Public property DeploymentState Gets a value indicating whether the solution has been deployed, and if so, whether it has assemblies installed in the global assembly cache, in the application's bin directory, or both.
Public property DisplayName Gets the display name that describes the persisted object instance within the administrative user interface. (Inherited from SPPersistedObject.)
Public property Farm The farm on which this solution is installed.
Public property Id Gets or sets the GUID that is associated with the object. (Inherited from SPPersistedObject.)
Public property IsWebPartPackage Gets a value indicating whether the solution represents a Web Part package. Do not use. The concept of a "Web Part package" is obsolete.
Public property JobExists Specifies whether a timer job exists for this SPSolution.
Public property JobStatus Gets the job status that is associated with the language-neutral solution.
Public property LanguagePacks Returns the list of language packages associated with this solution.
Public property LastOperationDetails Returns details of the last operation while deploying the solution.
Public property LastOperationEndTime Returns the date and time that the last operation ended.
Public property LastOperationResult Returns the result of the last operation.
Public property Name Returns the name of the solution.
Public property Parent Gets the parent in the logical hierarchy of the configuration object tree. (Inherited from SPPersistedObject.)
Public property Properties Gets metadata for the persisted object. (Inherited from SPPersistedObject.)
Public property SolutionFile Returns the file associated with the solution.
Public property SolutionId Returns the solution id specified in the manifest file.
Public property Status Gets or sets the status of the object that the class represents. (Inherited from SPPersistedObject.)
Public property TypeName Gets the display name that describes the object type in the administrative user interface. (Inherited from SPPersistedObject.)
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. (Inherited from SPPersistedObject.)
Protected property WasCreated Gets a Boolean value that indicates whether the object is initialized and can be found in the database. (Inherited from SPPersistedObject.)

Top

Methods

  Name Description
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. (Inherited from SPPersistedObject.)
Public method Delete Deletes the object. (Inherited from SPPersistedObject.)
Public method Deploy(DateTime, Boolean, Boolean) Creates a timer job to deploy the language-neutral solution at a specified time.
Public method Deploy(DateTime, Boolean, Collection<SPWebApplication>, Boolean) Creates a timer job to deploy the language-neutral solution to the specified web applications at a specified time.
Public method DeployLocal(Boolean, Boolean) Deploys the solution to all applications on the local server for trouble-shooting purposes.
Public method DeployLocal(Boolean, Collection<SPWebApplication>, Boolean) Deploys the language neutral solution to the specified web applications on the local server for trouble-shooting purposes.
Public method Equals Determines whether the current persisted object equals the specified object. (Inherited from SPPersistedObject.)
Protected method Finalize (Inherited from Object.)
Public method GetChild<T>() Returns the child of the persisted object based on the specified type. (Inherited from SPPersistedObject.)
Public method GetChild<T>(String) Returns the child object of the persisted object based on the specified name. (Inherited from SPPersistedObject.)
Public method GetHashCode Serves as a hash function for the persisted object. (Inherited from SPPersistedObject.)
Public method GetLanguagePack Returns the language pack in the solution for the specified locale identifier.
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. (Inherited from SPPersistedObject.)
Public method LegacyUpdate (Inherited from SPPersistedObject.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method OnDeserialization Called immediately after the base class deserializes itself to do additional work. (Inherited from SPPersistedObject.)
Protected method OnPostCreate (Inherited from SPPersistedObject.)
Protected method OnPreCreate (Inherited from SPPersistedObject.)
Public method Provision Makes the changes to the local server that are needed before the object can be used. (Inherited from SPPersistedObject.)
Public method Retract(DateTime) Creates a timer job to retract the specified solution at a particular time.
Public method Retract(DateTime, Collection<SPWebApplication>) Creates a timer job to retract the specified solution from the specified web applications at a particular time.
Public method RetractLocal() Retracts the solution from all web applications on the local server for trouble-shooting purposes.
Public method RetractLocal(Collection<SPWebApplication>) Retracts the solution from the specified web applications on the local server for trouble-shooting purposes.
Public method RunWithConcurrencyRetries (Inherited from SPPersistedObject.)
Public method Synchronize Synchronizes the solution on this machine with other machines in the farm.
Public method ToString Returns the type and name of an object and of all its ancestors (parent, grandparent, and so on). (Inherited from SPPersistedObject.)
Public method Uncache Frees the memory cache that is used by the object. (Inherited from SPPersistedObject.)
Public method Unprovision Makes the changes to the local server that are needed to clean up after deleting the object. (Inherited from SPPersistedObject.)
Public method Update() Causes the object to save its state and propagate changes to all the computers in the server farm. (Inherited from SPPersistedObject.)
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. (Inherited from SPPersistedObject.)
Protected method UpdateParent Causes the containing SPPersistedObject, if one exists, to update its state. (Inherited from SPAutoSerializingObject.)
Public method UpdateWithNoObjectCallbackCheck (Inherited from SPPersistedObject.)
Public method Upgrade(String) Upgrades the solution from a previous version to the current version using the specified solution file.
Public method Upgrade(String, DateTime) Upgrades the solution from a previous version to the current version using the specified solution file, and scheduled to run at a specified time.
Protected method Validate Validates the state of all fields before persisting the object. (Inherited from SPPersistedObject.)

Top

Explicit interface implementations

  Name Description
Explicit interface implemetationPrivate method IBackupRestore.AddBackupObjects Adds the solution to the backup and restore operation.
Explicit interface implemetationPrivate property IBackupRestore.CanRenameOnRestore Gets whether this item can be renamed at restore time.
Explicit interface implemetationPrivate property IBackupRestore.DiskSizeRequired Gets the disk size required for a backup operation.
Explicit interface implemetationPrivate property IBackupRestore.Name Gets or sets the name of the solution.
Explicit interface implemetationPrivate method IBackupRestore.OnAbort An event that is called in the backup and restore infrastructure when the user cancels the operation.
Explicit interface implemetationPrivate method IBackupRestore.OnBackup An event that is called when the system is being backed up.
Explicit interface implemetationPrivate method IBackupRestore.OnBackupComplete The event that is called when the system is finished with the backup and restore procedure.
Explicit interface implemetationPrivate method IBackupRestore.OnPostRestore The event that is called when the system is finished restoring.
Explicit interface implemetationPrivate method IBackupRestore.OnPrepareBackup The event that is called when the system is preparing a backup operation.
Explicit interface implemetationPrivate method IBackupRestore.OnPreRestore The event that is called when the system is preparing a restore operation.
Explicit interface implemetationPrivate method IBackupRestore.OnRestore The event that is called when the system is being restored.
Explicit interface implemetationPrivate property IBackupRestoreConfiguration.CanBackupRestoreAsConfiguration Gets whether the item can be selectable during configuration-only backup or restore.

Top

See also

Reference

SPSolution class

Microsoft.SharePoint.Administration namespace