CObjectImplBase Class

Base class for Business Objects implementations.

Inheritance Hierarchy

SystemObject
  SystemMarshalByRefObject
    PDTec.IceNet.Sdk.ImplementationCObjectImplBase
      More...

Namespace: PDTec.IceNet.Sdk.Implementation
Assembly: PDTec.IceNet.Sdk (in PDTec.IceNet.Sdk.dll) Version: 7.2.0.0 (7.2.7583.15464)

Syntax

Copy

public abstract class CObjectImplBase : MarshalByRefObject, 
	IObjectImpl, IObject

The CObjectImplBase type exposes the following members.

Constructors

	Name	Description
	CObjectImplBase	Initializes a new instance of the CObjectImplBase class

Top

Properties

	Name	Description
	ChangedBy
	ChangedOn
	CreatedBy
	CreatedOn
	Description
	Folder
	Id
	IsLocked
	IsValid
	LockedBy
	LockedOn
	Name
	ObjType
	Repository

Top

Methods

	Name	Description
	AddKey
	AsT
	AsBaseT
	CastT
	CastBaseT
	ChangeObjType
	CopyTo
	CreateObjRef	Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
	DeleteKey
	Destroy
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetAttrValue(IAttrDef)
	GetAttrValue(String, String)
	GetAttrValue(IAttrDef, Boolean)
	GetAttrValue(String, String, Boolean)
	GetAttrValues
	GetFolder
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetKeys
	GetLifetimeService	Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	GetLockInfo
	GetObjType
	GetRelationships(RelDirection)
	GetRelationships(String, RelDirection)
	GetRelationships(IRelType, RelDirection)
	GetSingleRelationship(String, RelDirection)
	GetSingleRelationship(IRelType, RelDirection)
	GetTableAttrTemplateRow
	GetTableAttrValues
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	InitializeLifetimeService	Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	IsOf(String)
	IsOf(IObjType)
	Lock
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	MemberwiseClone(Boolean)	Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
	MoveTo
	QueryInterface
	Reload
	SetAttrValue(IAttrDef, Object)
	SetAttrValue(String, String, Object)
	SetAttrValues
	SetRelationshipIndex
	SetRelationshipIndices
	SetTableAttrValues
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Touch
	TriggerEventEventImpl, EventArgs
	TryCastT
	TryCastBaseT
	TryGetAttrValue(IAttrDef, Boolean)
	TryGetAttrValue(IAttrDef, DateTime)
	TryGetAttrValue(IAttrDef, Double)
	TryGetAttrValue(IAttrDef, Int64)
	TryGetAttrValue(IAttrDef, Object)
	TryGetAttrValue(IAttrDef, String)
	TryGetAttrValue(String, String, Boolean)
	TryGetAttrValue(String, String, DateTime)
	TryGetAttrValue(String, String, Double)
	TryGetAttrValue(String, String, Int64)
	TryGetAttrValue(String, String, Object)
	TryGetAttrValue(String, String, String)
	TryGetSingleRelationship(String, RelDirection, IRelationship)
	TryGetSingleRelationship(IRelType, RelDirection, IRelationship)
	UnLock

Top

Extension Methods

	Name	Description
	GetFolderId	Gets the folder ID without unneccessarily retrieving the full folder information. (Defined by ModelExtensions.)
	GetRepository	Gets the corresponding repository for an object. (Defined by ModelExtensions.)
	IsConnected(String, RelDirection)	Overloaded. Detects whether an object is connected by at least one relationship of a specific type. (Defined by ModelExtensions.)
	IsConnected(IRelType, RelDirection)	Overloaded. Detects whether an object is connected by at least one relationship of a specific type. (Defined by ModelExtensions.)

Top

Examples

This example explains how to implement ice.NET Business Objects (BOs). The data model that is used for this example is part of the ice.NET Ice Car Rental turorial and can be found in the PDTec.ICR model package.

The example consists of multiple parts:

The BO interface definition.
The BO implementation.
The BO factory class with the declaration of associated ice.NET object types.
The registration of BO assemblies.
A usage example.

The first part of the example shows a BO interface definition. It is a normal C# interface that derives from the IObject interface. It can contain arbitrary methods and properties .

The following code is stored in the file IVehicle.cs:

Copy

using System;
using PDTec.IceNet.Core.Model;

namespace PDTec.ICR.BusinessLogic.BusinessObjects
{
    public interface IVehicle : IObject
    {
        double CurrentMileage
        {
            get;
            set;
        }

        double CalculatePrice(DateTime pFromDate, DateTime pToDate);
    }
}

The interface IVehicle is implemented in the next code example. To implement a BO interface a class is required that is derived from PDTec.IceNet.Sdk.Implementation.CObjectImplBase" and implements the BO interface.

The following code is stored in the file CVehicleImpl.cs:

Copy

using System;
using System.Collections;

using PDTec.IceNet.Core.Model;
using PDTec.IceNet.Core.Model.Implementation;
using PDTec.IceNet.Sdk.Implementation;

using PDTec.ICR.BusinessLogic.BusinessObjects;

namespace PDTec.ICR.BusinessLogic.BusinessObjects.Implementation
{
    public class CVehicleImpl : CObjectImplBase, IVehicle
    {
        public CVehicleImpl(IRepository pRepository, IObjectImpl pObject) :
             base(pRepository, pObject)
        {
        }

        public double CurrentMileage
        {
            get
            {
                return (double)GetAttrValue("PDTec.ICR.Vehicle", "CurrentMileage");
            }

            set
            {
                SetAttrValue("PDTec.ICR.Vehicle", "CurrentMileage", value);
            }
        }

        private IModel Model
        {
            get
            {
                IRelationship pRelationship = GetSingleRelationship("PDTec.ICR.VehicleModel", RelDirection.Forward);

                IModel pResult = pRelationship.GetObject(Direction.To).Cast<IModel>();

                return pResult;
            }
        }

        public double CalculatePrice(DateTime pFromDate, DateTime pToDate)
        {
            TimeSpan pTimeSpan =  pToDate - pFromDate;

            double price = pTimeSpan.Days * DailyRate - Model.CalculateRebate(this);

            return price;
        }
    }
}

To associate the BO implementation with a modeled object type a BO factory is required. This factory class is decorated with a code attributes of type ObjectImplAttribute and implements IObjectImplFactory.

The property ObjTypeName defines the association with the ice.NET object type. All object instances of this type (or its subtypes) provide the BO methods declated in the BO interface.

The following code is stored in the file CVehicleImplFactory.cs:

Copy

using PDTec.IceNet.Core.Model;
using PDTec.IceNet.Core.Model.Implementation;

namespace PDTec.ICR.BusinessLogic.BusinessObjects.Implementation
{
    [ObjectImpl(ObjTypeName="PDTec.ICR.Vehicle", Interface=typeof(IVehicle))]
    public class CVehicleImplFactory : IObjectImplFactory
    {
       public IObject CreateObject(IRepository pRepository, IObjectImpl pBaseImpl)
       {
           return new CVehicleImpl(pRepository, pBaseImpl);
       }
    }
}

The BO factory provides the connection between interface, implementation and data model. In order to be used in an application, the containing .NET assembly must be registered with the .NET platform. The easies way to do this is to add a <implementationAssembly> tag that contains the assembly name into the application's configuration file as shown in the follwing example.

If the BO interface, the implementation and the factory class are distributed over multiple assemblies, the assembly containing the factory class must be registered in the configuration file.

The following code is part of a .NET configuration file (e.g. web.config):

XML

Copy

<?xml version="1.0"?>
<configuration>
  <configSections>
    <section name="ice.net" type="PDTec.IceNet.Sdk.ConfigSectionHandler,PDTec.IceNet.Sdk"/>
  </configSections>
  <ice.net>
    <database service="SQLServer" connectionString="server=(local)\SQLEXPRESS;trusted_connection=yes;database=icr" encrypted="false"/>
    <businessObjects>
      <implementationAssembly assemblyName="PDTec.ICR.BusinessLogic"/>
    </businessObjects>
    <!-- ... -->
  </ice.net>
  <!-- ... -->
</configuration>

The following code shows how to use the BO methods:

Copy

IVehicle pVehicle = Repository.Get<IVehicle>(Request["vid"]);

double price = pVehicle.CalculatePrice(DateTime.UtcNow, DateTime.UtcNow.AddDays(2.0));

Reference

PDTec.IceNet.Sdk.Implementation Namespace

Inheritance Hierarchy