ServiceCollection Class
The ServiceCollection class represents a collection of Service objects in the topology of a server farm.
System.Object
Microsoft.SharePoint.Portal.Topology.SqlCollectionBase
Microsoft.SharePoint.Portal.Topology.TopologyObjectCollectionBase
Microsoft.SharePoint.Portal.Topology.ServiceCollection
Public Constructors
The following table shows the constructors of the ServiceCollection class and a brief description of each.
| Name | Description |
|---|---|
| ServiceCollection(Microsoft.SharePoint.Portal.Topology.TopologyManager, System.Guid) | Initializes a new instance of the ServiceCollection class. |
| ServiceCollection(Microsoft.SharePoint.Portal.Topology.TopologyManager, System.Guid, Microsoft.SharePoint.Portal.Topology.Server) | Initializes a new instance of the ServiceCollection class. |
Public Methods
The following table shows the public methods of the ServiceCollection class and a brief description of each.
| Name | Description |
|---|---|
| Add(Microsoft.SharePoint.Portal.Topology.Service) | Adds a Service object to the topology. |
| Remove(System.Guid) | Removes the specified Service object. |
Protected Methods
The following table shows the protected methods of the ServiceCollection class and a brief description of each.
| Name | Description |
|---|---|
| CreateSqlCollectionItem(System.Data.SqlClient.SqlDataReader) | Populates the values of the properties of a Service object from a row in the configuration database and returns the Service object. |
| InitializeSqlCollection | Returns a collection of existing Service objects. |
Public Properties
The following table shows the properties of the ServiceCollection class, the data type of each property, and a brief description of each.
| Name | Data type | Description |
|---|---|---|
| Item(String) | Microsoft.SharePoint.Portal.Topology.Service | Gets a Service object by instance name. |
| Item(System.Guid) | Microsoft.SharePoint.Portal.Topology.Service | Gets a Service object by ID. |
Thread Safety
Any public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Instance members are not guaranteed to be thread safe.
Remarks
Use the ServiceCollection class to manage the Service objects in the topology of the server farm. The ServiceCollection object corresponds to the list of Service objects in the Services table of the configuration database. Specific Service objects are distinguished from other Service objects in the Services table by the GUID value in the ClassID column.
To use the properties and methods of the objects in the Topology namespace you must be a member of the local STS_WPG and SPS_WPG security groups, and a member of the db_owner database role for the configuration database.
In addition, for certain methods, such as those that create a portal site, you must be a member of the local Administrators group, and have membership in the Database Creators and Security Administrators server roles in the SQL Server instance that hosts the configuration database.
Requirements
Namespace: Microsoft.SharePoint.Portal.Topology
Platforms: Microsoft Windows Server 2003
Assembly: Microsoft.SharePoint.Portal (in Microsoft.SharePoint.Portal.dll)
Security: Code Access Security