Try our conversational search powered by Generative AI!

smithsson68@gmail.com
Jan 3, 2011
  5546
(0 votes)

Proposed API changes in Visitor Groups (CMS 6 R2)

The EPiServer CMS 6 R2 Beta released just before Christmas has some new functionality called Visitor Groups. You can read more about that here.

Having reviewed the API carefully, we have decided to make a few small (breaking) changes for the next (Beta/RC) release.

CriterionBase

The non generic EPiServer.Personalization.VisitorGroups.CriterionBase class has been replaced by the EPiServer.Personalization.VisitorGroups.ICriterion interface. All criteria must implement this although it is recommended that you use the generic EPiServer.Personalization.VisitorGroups.CriterionBase<T> in your implementations.

CriterionBase<T>

In the CMS 6 R2 Beta, the generic parameter T had to implement IDynamicData and ICloneable.

This has been changed so the generic parameter T now has to implement the new interface EPiServer.Personalization.VisitorGroups.ICriterionModel interface.

ICriterionModel looks like this:

   1:  /// <summary>
   2:  /// Interface for criterion model
   3:  /// </summary>
   4:  public interface ICriterionModel : IDynamicData
   5:  {
   6:      /// <summary>
   7:      /// Create a copy of this criterion model.
   8:      /// </summary>
   9:      /// <remarks>The implementation should have deep clone semantics as appropriate.</remarks>
  10:      /// <returns>The copy of the criterion model.</returns>
  11:      ICriterionModel Copy();
  12:  }

As you will see, the ICriterionModel interface inherits from IDynamicData and also specifies a method for deep copying of the model. We have done this as Microsoft themselves do not recommend the use of ICloneable any more due to its rather cloudy specification about whether a deep or shallow copy should be done. See this article from Brad Abrams for more information.

You don’t have to implement ICriterionModel yourself, you can inherit from the new EPiServer.Personalization.VisitorGroups.CriterionModelBase class. This takes care of the IDynamicData implementation for you but actually declares the Copy method as abstract leaving you to implement this yourself.

Why not have a default implementation marked virtual?

There has been great debate about this internally. OK, but how does the default implementation do a deep copy properly?

We decided to err on the side of safety, by making it abstract it forces you to implement the deep copy property. There is a protected helper method on the class called ShallowCopy which you can call from your Copy implementation. This will help you when you only have values types or as a starting point for a deep copy.

Your feedback on this is as always most welcome and invaluable.

Jan 03, 2011

Comments

Please login to comment.
Latest blogs
Join the Content Recommendations Work Smarter webinar May 8th 16.00-16.45 CET with expert Aidan Swain

Learn more about Content Recommendations, with Optimizely’s very own Senior Solutions consultant, Aidan Swain . He will discuss best practices and...

Karen McDougall | Apr 12, 2024

Plugin for Identifying and Bulk Deleting Orphaned Missing Properties in Optimizely

I am aware that the Optimizely World community has extensively discussed this topic, with numerous solutions and code snippets available to help...

Adnan Zameer | Apr 11, 2024 | Syndicated blog

Enhancing the Authoring Experience: Extending the LinkItem

The LinkItem field is one of the most demanded properties by the community, allowing editors to effortlessly create and manage links across pages a...

Santiago Morla | Apr 10, 2024 | Syndicated blog

The distinctions between Optimizely Web Experimentation and Optimizely Feature Experimentation

This blog is part of the series - Unlocking the Power of Experimentation: A Marketer's Insight. Let’s dive into Optimizely's powerful experimentati...

Holly Quilter | Apr 9, 2024

Optimizely SaaS CMS: Balancing TCO and ROI in Your CMS Hosting Decision

With Optimizely SaaS CMS coming soon, I’ve been talking with companies about the tricky business of picking the right core system software for thei...

Johnny Mullaney | Apr 8, 2024 | Syndicated blog

What version of Optimizely CMS am I running?

Optimizely continually rolls out new features for CMS customers and these features are normally for the latest major version of Optimizely CMS (CMS...

David Knipe | Apr 8, 2024 | Syndicated blog