SlidingWindow Class Reference

The SYS.Date.SlidingWindow class supports methods for setting, modifying and inspecting the system-wide or process-specific sliding window definitions. More...

Inheritance diagram for SlidingWindow:

Collaboration diagram for SlidingWindow:

Static Public Member Functions
_.Library.String	Get (_.Library.Integer Scope)
	Get current default definition in the format: More...
_.Library.String	NoWindow (_.Library.Integer Scope)
	Set default to be an "empty" window, so that all. More...
_.Library.Status	SetAbsolute (_.Library.Integer Scope, _.Library.Integer StartYear, _.Library.Integer EndYear)
	Set date window to begin on the absolute year StarYear. More...
_.Library.Status	SetDate (_.Library.Integer Scope, _.Library.Integer StartDate, _.Library.Integer EndDate)
	Set date window to begin on the absolute date StartDate. More...
_.Library.Status	SetRelative (_.Library.Integer Scope, _.Library.Integer StartYear, _.Library.Integer EndYear)
	Set date window to begin on the relative year StartYear. More...
_.Library.Status	Twentieth (_.Library.Integer Scope)
	Remove current default so that a 20th century. More...
	UseDefault ()
	Set process window to be the same as the current system default.

Detailed Description

The SYS.Date.SlidingWindow class supports methods for setting, modifying and inspecting the system-wide or process-specific sliding window definitions.

With the exception of Get(), all the other class methods return a Status to indicate success or failure. Any modified system-wide definition will be active until the system is restarted. If necessary, users can add the new settings to ^ZSTU or ^ZSTART in order to make them survive across reboots.

In most cases, the first parameter indicates whether the call is system or process-specific:

Scope = 0: system (default)
Scope = 1: process<br>

Depending of the method, start and end dates can be specified in 3 different ways:

1. Absolute Dates, represented in $H format
2. Absolute Years, represented by 4-digit numbers relative to the start of the Common Era (0 C.E.)
3. Relative Years, represented by numbers relative the current year

When relative years are used to define a sliding window, the first or only relative year is interpreted as the start year, expressed as the number of years PRIOR to the current year. The second relative year, if any, is interpreted as the end year, expressed as one more than the number of years AFTER the current year.

Member Function Documentation

Get()

_.Library.String Get ( _.Library.Integer  Scope )

static

Get current default definition in the format:

OldStartDate^OldEndDate

Where OldStartDate and OldEndDate are absolute dates in $H format representing the start and end, respectively, of the current sliding window.

NoWindow()

_.Library.String NoWindow ( _.Library.Integer  Scope )

static

Set default to be an "empty" window, so that all.

years display using 4 digits.

SetAbsolute()

_.Library.Status SetAbsolute ( _.Library.Integer  Scope, _.Library.Integer  StartYear, _.Library.Integer  EndYear  )

static

Set date window to begin on the absolute year StarYear.

and to end on the absolute year EndYear.

SetDate()

_.Library.Status SetDate ( _.Library.Integer  Scope, _.Library.Integer  StartDate, _.Library.Integer  EndDate  )

static

Set date window to begin on the absolute date StartDate.

and to end on the absolute date EndDate.

SetRelative()

_.Library.Status SetRelative ( _.Library.Integer  Scope, _.Library.Integer  StartYear, _.Library.Integer  EndYear  )

static

Set date window to begin on the relative year StartYear.

and to end on the relative year EndYear.

Example: If issued in 2008, the following command would establish a process-specific sliding window definition which would result in this process displaying two-digit years for any dates in the range 01/01/1918 through 12/31/2017, inclusive.

Set status=##class(SYS.Date.SlidingWindow).SetRelative(1,90,10)

Twentieth()

_.Library.Status Twentieth ( _.Library.Integer  Scope )

static

Remove current default so that a 20th century.

fixed window is used by default.