Learn More





DNN Community Blog

The Community Blog is a personal opinion of community members and by no means the official standpoint of DNN Corp or DNN Platform. This is a place to express personal thoughts about DNNPlatform, the community and its ecosystem. Do you have useful information that you would like to share with the DNN Community in a featured article or blog? If so, please contact .

The use of the Community Blog is covered by our Community Blog Guidelines - please read before commenting or posting.

IHydratable - An Interesting Side-Effect

In 4.6.0 a new IHydratable interface was added to the core.

This interface could be used to delegate Hydration of a Business Object from the CBO class to the object itself.  I have discussed this in an earlier blog.  If the interface is implemented in an Info class, you need to implement the Fill method to hydrate the objects properties from the passed in DataReader.  For example, lets implement this for the Announcements module.:

        Public Sub Fill(ByVal dr As IDataReader) Implements IHydratable.Fill

            ItemId = Convert.ToInt32(Null.SetNull(dr.Item("ItemID"), ItemId))
            ModuleId = Convert.ToInt32(Null.SetNull(dr.Item("ModuleID"), ModuleId))
            Title = Convert.ToString(Null.SetNull(dr.Item("Title"), Title))
            Url = Convert.ToString(Null.SetNull(dr.Item("Url"), Url))
            ViewOrder = Convert.ToInt32(Null.SetNull(dr.Item("ViewOrder"), ViewOrder))
            Description = Convert.ToString(Null.SetNull(dr.Item("Description"), Description))
            ImageSource = Convert.ToString(Null.SetNull(dr.Item("ImageSource"), ImageSource))
            CreatedByUser = Convert.ToInt32(Null.SetNull(dr.Item("CreatedByUser"), CreatedByUser))
            CreatedDate = Convert.ToDateTime(Null.SetNull(dr.Item("CreatedDate"), CreatedDate))
            TrackClicks = Convert.ToBoolean(Null.SetNull(dr.Item("TrackClicks"), TrackClicks))
            NewWindow = Convert.ToBoolean(Null.SetNull(dr.Item("NewWindow"), NewWindow))
            PublishDate = Convert.ToDateTime(Null.SetNull(dr.Item("PublishDate"), PublishDate))
            ExpireDate = Convert.ToDateTime(Null.SetNull(dr.Item("ExpireDate"), ExpireDate))

        End Sub

So far so good, but the title of this blog refers to an interesting side-effect.  The side-effect is this: 

Using IHydratable allows the module developer to use "ReadOnly" properties and still use CBO.

Traditionally, CBO does not support the use of ReadOnly properties as the CreateObject method needs to set the property (from the value in the DataReader).  Quite often, for business reason we don't want to be allow the property to be set, BUT we still want to load the value from the Data Store.  This can now be accomplished by implementing IHydratable, as the Fill method can be used to set the underlying private member.

Lets look as an example.  The CreatedByUser and CreatedDate could be changed to ReadOnly properties, and the Fill method above would be rewritten as:

        Public Sub Fill(ByVal dr As IDataReader) Implements IHydratable.Fill

            _CreatedByUser = Convert.ToInt32(Null.SetNull(dr.Item("CreatedByUser"), _CreatedByUser))
            _CreatedDate = Convert.ToDateTime(Null.SetNull(dr.Item("CreatedDate"), _CreatedDate))
        End Sub

This would allow us to remove the setter in the properties. - other changes would be needed in code in order to set the CreatedByUser/CreatedDate for new announcments - but this ability provides more flexibility for Module Developers (and core developers) to provide better APIs.


Comment Form

Only registered users may post comments.


2sic Daniel Mettler (124)
Aderson Oliveira (15)
Alec Whittington (11)
Alex Shirley (10)
Andrew Nurse (30)
Anthony Glenwright (5)
Antonio Chagoury (28)
Ash Prasad (22)
Ben Schmidt (1)
Benjamin Hermann (25)
Benoit Sarton (9)
Beth Firebaugh (12)
Bill Walker (36)
Bob Kruger (5)
Brian Dukes (2)
Brice Snow (1)
Bruce Chapman (20)
Bryan Andrews (1)
cathal connolly (55)
Charles Nurse (163)
Chris Hammond (203)
Chris Paterra (55)
Clinton Patterson (28)
Cuong Dang (21)
Daniel Bartholomew (2)
Dave Buckner (2)
David Poindexter (3)
David Rodriguez (2)
Doug Howell (11)
Erik van Ballegoij (30)
Ernst Peter Tamminga (74)
Geoff Barlow (6)
Gifford Watkins (3)
Gilles Le Pigocher (3)
Ian Robinson (7)
Israel Martinez (17)
Jan Blomquist (2)
Jan Jonas (3)
Jaspreet Bhatia (1)
Jenni Merrifield (6)
Joe Brinkman (270)
John Mitchell (1)
Jon Henning (14)
Jonathan Sheely (4)
Jordan Coopersmith (1)
Joseph Craig (2)
Kan Ma (1)
Keivan Beigi (3)
Ken Grierson (10)
Kevin Schreiner (6)
Leigh Pointer (31)
Lorraine Young (60)
Malik Khan (1)
Matthias Schlomann (15)
Mauricio Márquez (5)
Michael Doxsey (7)
Michael Tobisch (3)
Michael Washington (202)
Mike Horton (19)
Mitchel Sellers (28)
Nathan Rover (3)
Navin V Nagiah (14)
Néstor Sánchez (31)
Nik Kalyani (14)
Peter Donker (52)
Philip Beadle (135)
Philipp Becker (4)
Richard Dumas (22)
Robert J Collins (5)
Roger Selwyn (8)
Ruben Lopez (1)
Ryan Martinez (1)
Salar Golestanian (4)
Sanjay Mehrotra (9)
Scott McCulloch (1)
Scott S (11)
Scott Wilkinson (3)
Scott Willhite (97)
Sebastian Leupold (80)
Shaun Walker (237)
Shawn Mehaffie (17)
Stefan Cullmann (12)
Stefan Kamphuis (12)
Steve Fabian (31)
Timo Breumelhof (24)
Tony Henrich (3)
Torsten Weggen (2)
Vicenç Masanas (27)
Vincent Nguyen (3)
Vitaly Kozadayev (6)
Will Morgenweck (37)
Will Strohl (163)
William Severance (5)
Try Evoq
For Free
Start Free Trial
a Demo
See Evoq Live
Need More Information?