Entity.GetById Method

Gets an entity given its ID.

Namespace:  Microsoft.Office.Server.ApplicationRegistry.Administration
Assembly:  Microsoft.SharePoint.Portal (in Microsoft.SharePoint.Portal.dll)

Syntax

'Declaration
Public Shared Function GetById ( _
    id As UInteger _
) As Entity

'Usage
Dim id As UInteger
Dim returnValue As Entity

returnValue = Entity.GetById(id)

public static Entity GetById(
    uint id
)

Parameters

• id
  Type: System.UInt32
  The ID of the entity.

Return Value

Type: Microsoft.Office.Server.ApplicationRegistry.Administration.Entity
An Entity object.

Examples

The following code example adds an action and updates the ProductModel entity.

Prerequisites

• Ensure a Shared Service Provider is already created.

• Create an LobSystem and set connection parameters as shown in How to: Create an LobSystem Using the Administration Object Model.

• Create the ProductModel entity as shown in How to: Create an Entity Using the Administration Object Model

• Create a Finder method as shown in How to: Create a Method and Filters Using the Administration Object Model

• Replace the constant value EnterYourSSPNameHere in the code with the name of your Shared Resource Provider.

Project References

Add the following Project References in your console application code project before running this sample:

• Microsoft.SharePoint

• Microsoft.SharePoint.Portal

• Microsoft.Office.Server

using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.Office.Server.ApplicationRegistry.Administration;
using Microsoft.Office.Server.ApplicationRegistry.Infrastructure;
using WSSAdmin = Microsoft.SharePoint.Administration;
using OSSAdmin = Microsoft.Office.Server.Administration;

namespace Microsoft.SDK.SharePointServer.Samples
{
    class GetStartedAndCreateSystem
    {
        const string yourSSPName ="EnterYourSSPNameHere";

        static void Main(string[] args)
        {
            SetupBDC();
            UpdateEntity();
            Console.WriteLine("Press any key to exit...");
            Console.Read();
        }
        static void SetupBDC()
        {
            SqlSessionProvider.Instance().SetSharedResourceProviderToUse(yourSSPName);
        }
        static void UpdateEntity()
        {
            LobSystemInstance mySysInstance = null;
            LobSystemInstanceCollection sysInsCollection = ApplicationRegistry.Instance.GetLobSystemInstancesLikeName("AdventureWorksSampleFromCode");
            foreach (LobSystemInstance sysInstance in sysInsCollection)
            {
                if (sysInstance.Name == "AdventureWorksSampleFromCode")
                {
                    mySysInstance = sysInstance;
                    break;
                }
            }
            IList<Entity> entityCollection = new List<Entity>(mySysInstance.LobSystem.Entities);
            Entity e = Entity.GetById(entityCollection[0].Id);
            Action pmaction = e.Actions.Create("Search on MSN", true, 1, true, "https://www.msn.com?q={0}", null);
            pmaction.ActionParameters.Create("Name", true, 0);
            e.Update();
            Console.WriteLine("Added an action and updated the entity successfully.");
        }
    }
}

See Also

Reference

Entity Class

Entity Members

Microsoft.Office.Server.ApplicationRegistry.Administration Namespace