EntityInstanceIdEncoder Class

  • Article

NOTE: This API is now obsolete.

Provides encoding and decoding of entity instance identifiers.

Inheritance Hierarchy

System.Object
  Microsoft.Office.Server.ApplicationRegistry.Infrastructure.EntityInstanceIdEncoder

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

Syntax

'Declaration
<ObsoleteAttribute("O12 Application Registry API is deprecated. Please use BusinessData.",  _
    False)> _
<SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel := True)> _
Public NotInheritable Class EntityInstanceIdEncoder
'Usage
You do not need to declare an instance of a static class in order to access its members.

[ObsoleteAttribute("O12 Application Registry API is deprecated. Please use BusinessData.", 
    false)]
[SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel = true)]
public static class EntityInstanceIdEncoder

Remarks

When entity instances are transformed into data rows in a data table, they lose the special semantics attached to them in the Business Data Catalog, such as the ability to call instance methods on them. Serializing the identifier column enables you to call instance methods. When the Business Data Catalog serializes the ID column, it encodes it, so you must decode the ID column before you can use the ID values. To decode the ID column, use the EntityInstanceIdEncoder.DecodeEntityInstanceId() method and pass in ColNameSerializedId, which is the name the Business Data Catalog assigns to the serialized ID column. This decodes the identifiers and returns an array of identifier values.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

EntityInstanceIdEncoder Members

Microsoft.Office.Server.ApplicationRegistry.Infrastructure Namespace