Table of Contents

Class ServerSettings

Namespace
ArcanaDevelopment.adTempus.Client
Assembly
ArcanaDevelopment.adTempus.Client.dll

Contains server-wide settings for the adTempus instance.

public sealed class ServerSettings : ADTIndependentObject, ISupportJobVariables
Inheritance
object
ServerSettings
Implements

Remarks

Use GetServerSettings() to retrieve the settings for the server.

After making changes you must call Save(ChangeLogParameters) to save the changes.

Properties

CanModify

Indicates whether the user has permission to save the settings.

public bool CanModify { get; }

Property Value

bool

ClassID

The Class ID for the object

[IgnoreDataMember]
public override ClassID ClassID { get; }

Property Value

ClassID

ClassKeyName

The key name for the class.

public override string ClassKeyName { get; }

Property Value

string

Remarks

This name the name used by adTempus to identify the class and is intended for programmatic use only. Use the ClassName for a user-friendly name.

ClassOptions

Audit, snapshot, and other settings for each class of adTempus objects.

public ClassOptionCollection ClassOptions { get; }

Property Value

ClassOptionCollection

IsDependent

Indicates whether the object is a dependent of (owned by) another object

[IgnoreDataMember]
public override bool IsDependent { get; }

Property Value

bool

Remarks

An independent object (IsDependent is false) is an object that can exist on its own without being part of another object. For example, Jobs, Job Groups, etc.

A dependent object (IsDependent is true) is a part of another object. For example, a JobStep cannot exist independently of a Job, so the JobStep is dependent.

Dependent objects cannot be directly fetched from the server: they are only fetched as part of the object they belong to. They also cannot be saved or deleted independently: they are automatically saved or deleted when the owning object is saved or deleted.

JobVariables

Contains the Job Variables that are available server-wide

public JobVariableCollection JobVariables { get; }

Property Value

JobVariableCollection

OptionCatalog

Returns XML documenting the available server options.

[RequiredVersion(5, 1, 0, 0)]
public string OptionCatalog { get; }

Property Value

string

ServerOptions

The server options

public OptionCollection ServerOptions { get; }

Property Value

OptionCollection

Methods

GetDescriptionWithClassName()

Gets a user-friendly description of the object, including the ClassName.

public override string GetDescriptionWithClassName()

Returns

string

Remarks

This method returns the ClassName plus the GetDescription(), similar to

Job "Job Name"

GetInheritedVariables(bool)

Gets a collection containing the JobVariables inherited by this object, and optionally the variables for the object itself.

public JobVariableCollection GetInheritedVariables(bool includeSelf)

Parameters

NameTypeDescription
includeSelf bool

If true the returned collection contains both inherited variables and variables defined at this level. If false the results only include inherited variables.

Returns

JobVariableCollection

GetObjectDescription()

Gets a description of the object's key settings.

protected override string GetObjectDescription()

Returns

string

Remarks

This method is called by GetDescription() to get a user-friendly description of the object (such as its key settings) for display to the user. The description should contain enough information to distinguish this object from others of the same class.

Save(ChangeLogParameters)

Saves the changes made to the settings

public void Save(ChangeLogParameters auditRecord)

Parameters

NameTypeDescription
auditRecord ChangeLogParameters

Options for generating an audit or snapshot for the save operation

Exceptions

PermissionDeniedException

Thrown if the user does not have Modify permission for the ServerSettings.

See Also

WriteToConfigurationReport(IADTObjectConfigurationReportWriter)

Writes the object and any contained objects to a configuration report

public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)

Parameters

NameTypeDescription
reportBuilder IADTObjectConfigurationReportWriter

The report builder to write the object to.

Inherited Members