Window mode API overview

To view objects across all effective time, you can view the policy objects (or a whole branch) in window mode. Typically you do this with a version list for an object. A version list represents all versions of that one object within one policy period. For example, a version list for a car represents all versions of that car during the entire policy period.

In general, you get a version list from a revisioned object by getting its VersionList property. The result has the type specific to that object with the VersionList suffix, for example a Building version list has type BuildingVersionList. In the unusual case that you write general purpose code that operates on multiple revisioned entity types, declare variables as the base type EffDated or EffDatedBase. For those types, instead of getting the VersionList property, get the property VersionListUntyped.

If you have a version list, you can get various information about the object. For example, get all versions of the object, or navigate up or down the hierarchy to other entity instances or version lists.

The most important APIs on a version list are as follows. All results are in window mode unless otherwise noted.

• The versionList.AllVersions property gets all versions of this object. All results are in window mode. The order in the list (the sort order) is the effective date for each version.
• The versionList.asOf(date) method gets the one version of this object on that date, or null if none were effective on that date.
• If an entity property contains an array of entity instances, Gosu generates two version list properties related to that original entity property:
  • Gosu generates a version list property whose name exactly matches the property name on the original object. It contains a list of all unique objects that are ever in that array at any effective time in the period. For example, a personal vehicle object contains its drivers in the vehicle.Drivers property. Thus, a vehicle’s version list also has a Drivers property. It contains a list that contains one version list for each unique driver for that vehicle. The items in this list have no defined order. Do not rely on the order.
  • Gosu generates a version list method whose name matches the property name on the original object but with the suffix AsOf. This method takes a date argument, which is an effective date. The AsOf method returns a snapshot of that array property as of that effective date. The AsOf method converts and returns the results to a list, which is typically easier to code with than arrays. For example, a personal vehicle object contains its drivers in the vehicle.Drivers property. Thus, a vehicle version list has a DriverAsOf(date) method. This method returns a list of that vehicle’s drivers on that date. The entities are returned in window mode. The items in this list have no defined order. Do not rely on the order.
  Note: Generated methods like DriverAsOf are a rare exemption to the normal Gosu coding rule that method names always begin with a lowercase character. PolicyCenter capitalizes the first character in this case to improve Gosu code readability because these methods mirror the original property names with an initial capital letter.

The following subtopics describe real-world tasks with a version list by using as an example a car (a PersonalVehicle) and its version list. For code examples, assume that the variable vehicleVL contains a version list for the car (vehicle.VersionList). There are three versions of this car in this period, each with a different color. The car’s version list represents exactly three versions of this car.

var val = vehicleVL.AllVersions

var vehOnDate = vehicleVL.asOf(date)

var vehSlicedOnDate = vehicleVL.asOf(date).getSlice(date)

var drivers = vehicleVL.Drivers

var theDate = new Date() // a date object, in this case "today"
var drivers = vehicleVL.DriversAsOf(theDate)

var arrayOfPID = vehicleVL.DriversAsOf(date)*.PolicyDriver*.PublicID