fredriktjarnberg
Jan 25, 2010
  6375
(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
Customizing Property Lists in Optimizely CMS

Generic property lists is a cool editorial feature that has gained a lot of popularity - in spite of still being unsupported (officially). But if y...

Allan Thraen | Oct 2, 2022 | Syndicated blog

Content Delivery API – The Case of the Duplicate API Refresh Token

Creating a custom refresh provider to resolve the issues with duplicate tokens in the DXC The post Content Delivery API – The Case of the Duplicate...

David Lewis | Sep 29, 2022 | Syndicated blog

New Optimizely certifications - register for beta testing before November 1st

In January 2023, Optimizely is making updates to the current versions of our certification exams to make sure that each exam covers the necessary...

Jamilia Buzurukova | Sep 28, 2022

Optimizely community meetup - Sept 29 (virtual + Melbourne)

Super excited to be presenting this Thursday the 29th of September at the Optimizely community meetup. For the full details and RSVP's see the...

Ynze | Sep 27, 2022 | Syndicated blog

Preview multiple Visitor Groups directly while browsing your Optimizely site

Visitor groups are great - it's an easy way to add personalization towards market segments to your site. But it does come with it's own set of...

Allan Thraen | Sep 26, 2022 | Syndicated blog

The Report Center is finally back in Optimizely CMS 12

With Episerver.CMS.UI 12.12.0 the Report Center is finally re-introduced in the core product.

Tomas Hensrud Gulla | Sep 26, 2022 | Syndicated blog