London Dev Meetup Rescheduled! Due to unavoidable reasons, the event has been moved to 21st May. Speakers remain the same—any changes will be communicated. Seats are limited—register here to secure your spot!

fredriktjarnberg
Jan 25, 2010
  7074
(1 votes)

Generic overloads of GetPage and GetChildren - To be or not to be?

Joel Abrahamsson put some light on some issues with the newly added generic overloads GetPage and GetChildren on DataFactory as well as the generic overload of ShallowCopy on PageData. These APIs were added mainly to give developers a way to hook in their own PageData implementation in a simple way which was used by the PageTypeTool and was mentioned by Daniel Rodin in his blog post Working with your own PageData types in CMS5 R2 SP2. However, as the use of these methods have been somewhat outdated by the introduction of PageTypeBuilder and as we agree with Joel’s feedback, we are now considering a removal of these APIs by the release of CMS 6.

Our only remaining concern is backward compatibility which is something we struggle to maintain as much as possible (even if we are shipping a new major version).  However our qualified guess (after all we can only guess) is that the adoption of these methods are not that widely spread. If we also take into account that we can create extension methods that replaces all but one of the APIs planned to be cut we think it should be rather safe to get rid of the methods in CMS 6. If you disagree, continue reading.

The signatures that are at stake:

On EPiServer.DataFactory:

public IEnumerable<T> GetChildren<T>(PageReference pageLink)
where T: PageData, new();

public IEnumerable<T> GetChildren<T>(PageReference pageLink, ILanguageSelector selector)
where T: PageData, new();

public T GetPage<T>(PageReference pageLink)
where T: PageData, new();

public T GetPage<T>(PageReference pageLink, ILanguageSelector selector)
where T: PageData, new();

On EPiServer.Core.PageData:

public static T ShallowCopy<T>(PageData copy)
where T: PageData, new();

 

Objections anyone?

We are now interested to hear if there are anyone that strongly disagrees with the suggested change.

Is there anyone out there that uses the APIs listed above?

If yes, would it be sufficient for you to replace the DataFactory changes with equivalent extension methods with the same signature and same semantics?

Please, post a comment here or drop me a mail (fredrik [dot] tjarnberg [at] episerver [dot] com).

Jan 25, 2010

Comments

Björn Olsson
Björn Olsson Sep 21, 2010 10:33 AM

No objections your honour. Haven't used them myself either. I would prefer some new, optimized and cached methods/ways to retrieve pages filtered by categories and so on. Instead of having to implement this logic on top of EPiServers API. I'm not a huge fan of FindPagesWithCritera, or similar aproaches (spelling?) :)

Sep 21, 2010 10:33 AM

I've used PageTypeBuilder on more-or-less every project since it's release in the summer last year and love working with EPiServer in this way and certainly wouldn't go back.

I personally have got round the issue described by Joel by creating extension methods on the PageData and PageReference objects instead (without going into too much detail). However, I'm fully behind Joel's request to have these superfluous methods removed - they can easily be replaced as you say with some custom extension method code anyhow. It may however come back to bite someone though when they upgrade to 6 - but I guess the release notes will have to cover this :-)

Please login to comment.
Latest blogs
Routing to a page in SaaS CMS

More early findings from using a SaaS CMS instance; setting up Graph queries that works for both visitor pageviews and editor previews.

Johan Kronberg | Apr 14, 2025 |

Developer Meetup - London, 24th April 2025

Next Thursday, 24th April will be Candyspace 's first Optimizely Developer Meetup, and the first one held in London this year! We've have some...

Gavin_M | Apr 14, 2025

Successful Digitalization for SMEs: How Optimizely One can Revolutionize Your Business Processes

"Achieve digital excellence with Optimizely One: Boost efficiency, delight customers, secure growth." In today's digital world, it's crucial for...

Frank Hohmeyer | Apr 11, 2025

Personalized Optimizely CMS Website Search Experiences Azure AI Search & Personalizer

In the last blog, we discussed Integrating the Optimizely CMS website with Azure AI search. Now let’s take a bit more advanced topic to serve...

Naveed Ul-Haq | Apr 10, 2025 |