Table of Contents

Class CustomAction

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

A custom ResponseAction

[ComVisible(true)]
[Guid("ca67bb3f-5010-47e3-97a9-a3e9066d8c28")]
public sealed class CustomAction : ResponseAction, ICustomObject
Inheritance
object
CustomAction
Implements

Properties

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.

CustomObjectDefinition

Gets or sets the custom data definition for the custom object.

public ICustomObjectSettings CustomObjectDefinition { get; set; }

Property Value

ICustomObjectSettings

Remarks

The data definition is stored by adTempus in serialized form. When you request it using by reading the CustomObjectDefinition property, adTempus loads the add-in defined for the object, deserializes the data, and returns the add-in object. If the add-in cannot be loaded, an ExtensionTypeNotFoundException is thrown. To avoid the exception in this case, use TryGetCustomObjectDefinition(out ICustomObjectSettings) instead.

Exceptions

ExtensionTypeNotFoundException

Thrown if the extension class needed to read the definition is not installed on this computer. See Remarks.

See Also

CustomObjectDescription

Gets a description of the custom object.

public string CustomObjectDescription { get; set; }

Property Value

string

CustomObjectTypeID

Gets the unique identification string for this class.

public string CustomObjectTypeID { get; }

Property Value

string

CustomObjectVersion

Gets the version of the object.

public int CustomObjectVersion { get; }

Property Value

int

Remarks

The version is stored by adTempus and passed in to the object when deserializing.

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.

Methods

GetActionDescription() 

protected override string GetActionDescription()

Returns

string

TryGetCustomObjectDefinition(out ICustomObjectSettings)

Attempts to get the custom data definition for the custom object.

public bool TryGetCustomObjectDefinition(out ICustomObjectSettings objectDefinition)

Parameters

NameTypeDescription
objectDefinition ICustomObjectSettings

On success, contains the object definition

Returns

bool

True if the definition was successfully returned, False otherwise.

Remarks

The data definition is stored by adTempus in serialized form. When you request it using by reading the CustomObjectDefinition property, adTempus loads the add-in defined for the object, deserializes the data, and returns the add-in object. If the add-in cannot be loaded, or the data cannot be deserialized, this method returns False.

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