Class Describe

Namespace

ArcanaDevelopment.adTempus.Shared

Assembly

ArcanaDevelopment.adTempus.Shared.dll

Provides methods to get the user-friendly (display) names for enumeration values and other constants.

public static class Describe

Inheritance

object

Describe

Methods

ComparisonOperatorDescription(ComparisonOperator)

Gets the name for a ComparisonOperator.

public static string ComparisonOperatorDescription(ComparisonOperator value)

Parameters

Name	Type	Description
value	ComparisonOperator	The ComparisonOperator to describe.

Returns

string

ExitCodeTestTypeDescription(ExitCodeTestType, int?, int?, string)

Gets the description for an exit code test rule.

public static string ExitCodeTestTypeDescription(ExitCodeTestType ComparisonOperator, int? ExitCodeMin, int? ExitCodeMax, string exitCodeRange)

Parameters

Name	Type	Description
ComparisonOperator	ExitCodeTestType	The ExitCodeTestType used for the rule.
ExitCodeMin	int?	The minimum exit code, if applicable.
ExitCodeMax	int?	The maximum exit code, if applicable.
exitCodeRange	string

Returns

string

GetChangeDescription(ObjectChangeType)

Gets the display name for an ObjectChangeType.

public static string GetChangeDescription(ObjectChangeType changeType)

Parameters

Name	Type	Description
changeType	ObjectChangeType	The change action to describe.

Returns

string

GetChangeDescription(ObjectChangeType, TextCase)

Gets the display name for an ObjectChangeType.

public static string GetChangeDescription(ObjectChangeType changeType, TextCase textCaseOption)

Parameters

Name	Type	Description
changeType	ObjectChangeType	The change action to describe.
textCaseOption	TextCase	The text casing to apply to the returned value. See ArcanaDevelopment.adTempus.Resources.TextCase.

Returns

string

GetClassName(ClassID)

Gets the display name for a class identified by a ClassID

public static string GetClassName(ClassID classID)

Parameters

Name	Type	Description
classID	ClassID	The class ID to get the name for.

Returns

string

GetConditionStateDescription(ConditionState)

Gets the description for a ConditionState value.

public static string GetConditionStateDescription(ConditionState status)

Parameters

Name	Type	Description
status	ConditionState

Returns

string

GetConditionStateDescription(ConditionState, string)

Gets a description combining the description for a ConditionState value and an optional extended description.

public static string GetConditionStateDescription(ConditionState status, string extendedDescription)

Parameters

Name	Type	Description
status	ConditionState	The status to describe.
extendedDescription	string	Optional extended description. Can be null.

Returns

string

The display value for the status followed by the extendedDescription if specified.

GetDayList(int)

Returns a comma-delimited list of the days of the month selected in a bitmask.

public static string GetDayList(int dayMask)

Parameters

Name	Type	Description
dayMask	int	A bitmask containing the selected day numbers (see DayMask).

Returns

string

The list of days, or "All days" if all days are selected.

GetMonthList(int)

Returns a comma-delimited list of the names of the months selected in a bitmask.

public static string GetMonthList(int monthMask)

Parameters

Name	Type	Description
monthMask	int	A bitmask containing the selected months (see MonthMask).

Returns

string

The list of months, or "All months" if all months are selected.

GetSecurityPermissionList(IEnumerable<SecurityPermission>, string)

Gets a comma-separated list of permission names

public static string GetSecurityPermissionList(IEnumerable<SecurityPermission> permissions, string classKeyName = null)

Parameters

Name	Type	Description
permissions	IEnumerable<SecurityPermission>	The list of permissions to return names for.
classKeyName	string	The key name (from ClassKeyName) of the secured class. For some permissions, the display name may be different depending on the class.

Returns

string

The display name for the permission.

GetSecurityPermissionList(IEnumerable<int>, string)

Gets a comma-separated list of permission names

public static string GetSecurityPermissionList(IEnumerable<int> permissions, string classKeyName = null)

Parameters

Name	Type	Description
permissions	IEnumerable<int>	The list of permissions to return names for.
classKeyName	string	The key name (from ClassKeyName) of the secured class. For some permissions, the display name may be different depending on the class.

Returns

string

The display name for the permission.

GetSecurityPermissionName(SecurityPermission, string)

Gets the name of a security permission.

public static string GetSecurityPermissionName(SecurityPermission permission, string classKeyName = null)

Parameters

Name	Type	Description
permission	SecurityPermission	The permission.
classKeyName	string	The key name (from ClassKeyName) of the secured class. For some permissions, the display name may be different depending on the class.

Returns

string

The display name for the permission.

GetSecurityPermissionName(int, string)

Gets the name of a security permission.

public static string GetSecurityPermissionName(int permission, string classKeyName = null)

Parameters

Name	Type	Description
permission	int	The permission. Permissions are defined in SecurityPermission
classKeyName	string	The key name (from ClassKeyName) of the secured class. For some permissions, the display name may be different depending on the class.

Returns

string

The display name for the permission. If no display name is defined for the value, returns the permission value formatted as a hex string.

GetTriggerStateDescription(TriggerState)

Gets the display name for a TriggerState.

public static string GetTriggerStateDescription(TriggerState status)

Parameters

Name	Type	Description
status	TriggerState	The trigger state to describe.

Returns

string

GetWeekdayList(int)

Returns a comma-delimited list of the days of the week selected in a bitmask.

public static string GetWeekdayList(int weekdayMask)

Parameters

Name	Type	Description
weekdayMask	int	A bitmask containing the selected days of the week (see WeekdayMask).

Returns

string

The list of days.

IPStatusDescription(IPStatus)

Gets display name for an System.Net.NetworkInformation.IPStatus value

public static string IPStatusDescription(IPStatus value)

Parameters

Name	Type	Description
value	IPStatus	The System.Net.NetworkInformation.IPStatus to describe.

Returns

string

JobEventDescription(JobEvent)

Gets display name for a JobEvent value

public static string JobEventDescription(JobEvent value)

Parameters

Name	Type	Description
value	JobEvent	The JobEvent to describe.

Returns

string

JobTriggerTypeDescription(JobTriggerType)

Gets display name for a JobTriggerType value

public static string JobTriggerTypeDescription(JobTriggerType value)

Parameters

Name	Type	Description
value	JobTriggerType	The JobTriggerType to describe.

Returns

string

OccurrenceTypeDescription(OccurrenceType)

Gets display name for an OccurrenceType value

public static string OccurrenceTypeDescription(OccurrenceType value)

Parameters

Name	Type	Description
value	OccurrenceType	The OccurrenceType to describe.

Returns

string

QueueState(QueueState?)

Gets display name for a QueueState(QueueState?) value

public static string QueueState(QueueState? value)

Parameters

Name	Type	Description
value	QueueState?	The QueueState(QueueState?) to describe.

Returns

string

TextMatchRuleDescription(TextMatchRule)

Gets display name for a TextMatchRule value

public static string TextMatchRuleDescription(TextMatchRule value)

Parameters

Name	Type	Description
value	TextMatchRule	The TextMatchRule to describe.

Returns

string

VariableTypeDescription(JobVariableType)

Gets display name for a JobVariableType value

public static string VariableTypeDescription(JobVariableType value)

Parameters

Name	Type	Description
value	JobVariableType	The JobVariableType to describe.

Returns

string

WeekdayDescription(Weekday)

Gets display name for a Weekday value

public static string WeekdayDescription(Weekday value)

Parameters

Name	Type	Description
value	Weekday	The Weekday to describe.

Returns

string