Reads and updates/adds System Defaults. More...

Static Public Member Functions
static bool	IsSystemDefaultDefined (String ASystemDefaultName)
	Call this Method to find out whether a System Default is defined, that is, if it exists in the System Defaults table. More...

static String	GetSystemDefault (String ASystemDefaultName)
	Returns the value of the specified System Default. More...

static String	GetSystemDefault (String ASystemDefaultName, String ADefault)
	Returns the value of the specified System Default. More...

static bool	GetBooleanDefault (String ASystemDefaultName, bool ADefault)
	Gets the value of a System Default as a bool. More...

static bool	GetBooleanDefault (String ASystemDefaultName)
	Gets the value of a System Default as a bool. More...

static System.Char	GetCharDefault (String ASystemDefaultName, System.Char ADefault)
	Gets the value of a System Default as a char. More...

static System.Char	GetCharDefault (String ASystemDefaultName)
	Gets the value of a System Default as a char. More...

static double	GetDoubleDefault (String ASystemDefaultName, double ADefault)
	Gets the value of a System Default as a double. More...

static double	GetDoubleDefault (String ASystemDefaultName)
	Gets the value of a System Default as a double. More...

static System.Int16	GetInt16Default (String ASystemDefaultName, System.Int16 ADefault)
	Gets the value of a System Default as an Int16. More...

static System.Int16	GetInt16Default (String ASystemDefaultName)
	Gets the value of a System Default as an Int16. More...

static System.Int32	GetInt32Default (String ASystemDefaultName, System.Int32 ADefault)
	Gets the value of a System Default as an Int32. More...

static System.Int32	GetInt32Default (String ASystemDefaultName)
	Gets the value of a System Default as an Int32. More...

static System.Int64	GetInt64Default (String ASystemDefaultName, System.Int64 ADefault)
	Gets the value of a System Default as an Int64. More...

static System.Int64	GetInt64Default (String ASystemDefaultName)
	Gets the value of a System Default as an Int64. More...

static String	GetStringDefault (String ASystemDefaultName, String ADefault)
	Gets the value of a System Default as a string. More...

static String	GetStringDefault (String ASystemDefaultName)
	Gets the value of a System Default as a string. More...

static Int64	GetSiteKeyDefault ()
	Gets the SiteKey Sytem Default. More...

static SSystemDefaultsTable	GetSystemDefaults ()
	Returns the System Defaults as a DataTable. More...

static bool	SetSystemDefault (String AKey, String AValue)
	Sets the value of a System Default. If the System Default doesn't exist yet it will be created by that call. More...

static bool	SetSystemDefault (String AKey, String AValue, out bool AAdded)
	Sets the value of a System Default. If the System Default doesn't exist yet it will be created by that call. More...

Detailed Description

Reads and updates/adds System Defaults.

Member Function Documentation

◆ GetBooleanDefault() [1/2]

static bool Ict.Petra.Server.MSysMan.Common.WebConnectors.TSystemDefaultsConnector.GetBooleanDefault ( String ASystemDefaultName )

inlinestatic

Gets the value of a System Default as a bool.

Parameters

ASystemDefaultName The System Default for which the value should be returned.

Returns: The value of the System Default as a bool, or true if the specified System Default was not found.

◆ GetBooleanDefault() [2/2]

static bool Ict.Petra.Server.MSysMan.Common.WebConnectors.TSystemDefaultsConnector.GetBooleanDefault	(	String	ASystemDefaultName,
		bool	ADefault
	)

inlinestatic

Gets the value of a System Default as a bool.

Parameters

ASystemDefaultName	The System Default for which the value should be returned.
ADefault	The value that should be returned if the System Default was not found.

Returns: The value of the System Default as a bool, or the value of ADefault if the specified System Default was not found.

◆ GetCharDefault() [1/2]

static System.Char Ict.Petra.Server.MSysMan.Common.WebConnectors.TSystemDefaultsConnector.GetCharDefault ( String ASystemDefaultName )

inlinestatic

Gets the value of a System Default as a char.

Parameters

ASystemDefaultName The System Default for which the value should be returned.

Returns: The value of the System Default as a char, or the space character if the specified System Default was not found.

◆ GetCharDefault() [2/2]

static System.Char Ict.Petra.Server.MSysMan.Common.WebConnectors.TSystemDefaultsConnector.GetCharDefault	(	String	ASystemDefaultName,
		System.Char	ADefault
	)

inlinestatic

Gets the value of a System Default as a char.

Parameters

ASystemDefaultName	The System Default for which the value should be returned.
ADefault	The value that should be returned if the System Default was not found.

Returns: The value of the System Default as a char, or the value of ADefault if the specified System Default was not found.

◆ GetDoubleDefault() [1/2]

static double Ict.Petra.Server.MSysMan.Common.WebConnectors.TSystemDefaultsConnector.GetDoubleDefault ( String ASystemDefaultName )

inlinestatic

Gets the value of a System Default as a double.

Parameters

ASystemDefaultName The System Default for which the value should be returned.

Returns: The value of the System Default as a double, or 0.0 if the specified System Default was not found.

◆ GetDoubleDefault() [2/2]

static double Ict.Petra.Server.MSysMan.Common.WebConnectors.TSystemDefaultsConnector.GetDoubleDefault	(	String	ASystemDefaultName,
		double	ADefault
	)

inlinestatic

Gets the value of a System Default as a double.

Parameters

ASystemDefaultName	The System Default for which the value should be returned.
ADefault	The value that should be returned if the System Default was not found.

Returns: The value of the System Default as a double, or the value of ADefault if the specified System Default was not found.

◆ GetInt16Default() [1/2]

static System.Int16 Ict.Petra.Server.MSysMan.Common.WebConnectors.TSystemDefaultsConnector.GetInt16Default ( String ASystemDefaultName )

inlinestatic

Gets the value of a System Default as an Int16.

Parameters

ASystemDefaultName The System Default for which the value should be returned.

Returns: The value of the System Default as an Int16, or 0 if the specified System Default was not found.

◆ GetInt16Default() [2/2]

static System.Int16 Ict.Petra.Server.MSysMan.Common.WebConnectors.TSystemDefaultsConnector.GetInt16Default	(	String	ASystemDefaultName,
		System.Int16	ADefault
	)

inlinestatic

Gets the value of a System Default as an Int16.

Parameters

ASystemDefaultName	The System Default for which the value should be returned.
ADefault	The value that should be returned if the System Default was not found.

Returns: The value of the System Default as an Int16, or the value of ADefault if the specified System Default was not found.

◆ GetInt32Default() [1/2]

static System.Int32 Ict.Petra.Server.MSysMan.Common.WebConnectors.TSystemDefaultsConnector.GetInt32Default ( String ASystemDefaultName )

inlinestatic

Gets the value of a System Default as an Int32.

Parameters

ASystemDefaultName The System Default for which the value should be returned.

Returns: The value of the System Default as an Int32, or 0 if the specified System Default was not found.

◆ GetInt32Default() [2/2]

static System.Int32 Ict.Petra.Server.MSysMan.Common.WebConnectors.TSystemDefaultsConnector.GetInt32Default	(	String	ASystemDefaultName,
		System.Int32	ADefault
	)

inlinestatic

Gets the value of a System Default as an Int32.

Parameters

ASystemDefaultName	The System Default for which the value should be returned.
ADefault	The value that should be returned if the System Default was not found.

Returns: The value of the System Default as an Int32, or the value of ADefault if the specified System Default was not found.

◆ GetInt64Default() [1/2]

static System.Int64 Ict.Petra.Server.MSysMan.Common.WebConnectors.TSystemDefaultsConnector.GetInt64Default ( String ASystemDefaultName )

inlinestatic

Gets the value of a System Default as an Int64.

Parameters

ASystemDefaultName The System Default for which the value should be returned.

Do not inquire the 'SiteKey' System Default with this Method! Rather, always use the GetSiteKeyDefault Method!

Returns: The value of the System Default as an Int64, or 0 if the specified System Default was not found.

◆ GetInt64Default() [2/2]

static System.Int64 Ict.Petra.Server.MSysMan.Common.WebConnectors.TSystemDefaultsConnector.GetInt64Default	(	String	ASystemDefaultName,
		System.Int64	ADefault
	)

inlinestatic

Gets the value of a System Default as an Int64.

Parameters

ASystemDefaultName	The System Default for which the value should be returned.
ADefault	The value that should be returned if the System Default was not found.

Do not inquire the 'SiteKey' System Default with this Method! Rather, always use the GetSiteKeyDefault Method!

Returns: The value of the System Default as an Int64, or the value of ADefault if the specified System Default was not found.

◆ GetSiteKeyDefault()

static Int64 Ict.Petra.Server.MSysMan.Common.WebConnectors.TSystemDefaultsConnector.GetSiteKeyDefault ( )

inlinestatic

Gets the SiteKey Sytem Default.

Note: The SiteKey can get changed by a user with the necessary priviledges while being logged in to OpenPetra and this gets reflected when this Method gets called.

Returns: The SiteKey of the Site.

◆ GetStringDefault() [1/2]

static String Ict.Petra.Server.MSysMan.Common.WebConnectors.TSystemDefaultsConnector.GetStringDefault ( String ASystemDefaultName )

inlinestatic

Gets the value of a System Default as a string.

Parameters

ASystemDefaultName The System Default for which the value should be returned.

Returns: The value of the System Default as a string, or string.Empty if the specified System Default was not found.

◆ GetStringDefault() [2/2]

static String Ict.Petra.Server.MSysMan.Common.WebConnectors.TSystemDefaultsConnector.GetStringDefault	(	String	ASystemDefaultName,
		String	ADefault
	)

inlinestatic

Gets the value of a System Default as a string.

Parameters

ASystemDefaultName	The System Default for which the value should be returned.
ADefault	The value that should be returned if the System Default was not found.

Returns: The value of the System Default as a string, or the value of ADefault if the specified System Default was not found.

◆ GetSystemDefault() [1/2]

static String Ict.Petra.Server.MSysMan.Common.WebConnectors.TSystemDefaultsConnector.GetSystemDefault ( String ASystemDefaultName )

inlinestatic

Returns the value of the specified System Default.

The caller doesn't need to know whether the Cache is already populated - if this should be necessary, this function will make a request to populate the cache.

SystemDefault Names are not case sensitive.

Parameters

ASystemDefaultName The System Default for which the value should be returned.

Returns: The value of the System Default, or SharedConstants.SYSDEFAULT_NOT_FOUND if the specified System Default doesn't exist.

◆ GetSystemDefault() [2/2]

static String Ict.Petra.Server.MSysMan.Common.WebConnectors.TSystemDefaultsConnector.GetSystemDefault	(	String	ASystemDefaultName,
		String	ADefault
	)

inlinestatic

Returns the value of the specified System Default.

The caller doesn't need to know whether the Cache is already populated - if this should be necessary, this function will make a request to populate the cache.

Parameters

ASystemDefaultName	The System Default for which the value should be returned.
ADefault	The value that should be returned if the System Default was not found.

SystemDefault Names are not case sensitive.

Returns: The value of the System Default, or the value of ADefault if the specified System Default was not found.

◆ GetSystemDefaults()

static SSystemDefaultsTable Ict.Petra.Server.MSysMan.Common.WebConnectors.TSystemDefaultsConnector.GetSystemDefaults ( )

inlinestatic

Returns the System Defaults as a DataTable.

Returns: System Defaults Typed DataTable.

◆ IsSystemDefaultDefined()

static bool Ict.Petra.Server.MSysMan.Common.WebConnectors.TSystemDefaultsConnector.IsSystemDefaultDefined ( String ASystemDefaultName )

inlinestatic

Call this Method to find out whether a System Default is defined, that is, if it exists in the System Defaults table.

Parameters

ASystemDefaultName The System Default that should be checked.

Returns: True if the System Default is defined, false if it isn't.

◆ SetSystemDefault() [1/2]

static bool Ict.Petra.Server.MSysMan.Common.WebConnectors.TSystemDefaultsConnector.SetSystemDefault	(	String	AKey,
		String	AValue
	)

inlinestatic

Sets the value of a System Default. If the System Default doesn't exist yet it will be created by that call.

Parameters

AKey	Name of new or existing System Default.
AValue	String Value.

◆ SetSystemDefault() [2/2]

static bool Ict.Petra.Server.MSysMan.Common.WebConnectors.TSystemDefaultsConnector.SetSystemDefault	(	String	AKey,
		String	AValue,
		out bool	AAdded
	)

inlinestatic

Sets the value of a System Default. If the System Default doesn't exist yet it will be created by that call.

Parameters

AKey	Name of new or existing System Default.
AValue	String Value.
AAdded	True if the System Default got added, false if it already existed.

The documentation for this class was generated from the following file:

csharp/ICT/Petra/Server/lib/MSysMan/Common/SystemDefaults.cs

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ GetBooleanDefault() [1/2]

◆ GetBooleanDefault() [2/2]

◆ GetCharDefault() [1/2]

◆ GetCharDefault() [2/2]

◆ GetDoubleDefault() [1/2]

◆ GetDoubleDefault() [2/2]

◆ GetInt16Default() [1/2]

◆ GetInt16Default() [2/2]

◆ GetInt32Default() [1/2]

◆ GetInt32Default() [2/2]

◆ GetInt64Default() [1/2]

◆ GetInt64Default() [2/2]

◆ GetSiteKeyDefault()

◆ GetStringDefault() [1/2]

◆ GetStringDefault() [2/2]

◆ GetSystemDefault() [1/2]

◆ GetSystemDefault() [2/2]

◆ GetSystemDefaults()

◆ IsSystemDefaultDefined()

◆ SetSystemDefault() [1/2]

◆ SetSystemDefault() [2/2]