All Classes Namespaces Functions Properties Pages
Public Member Functions | Properties | List of all members
OnHoldOptions Class Reference

Specifies the hold job information. OnHoldType member indicates whether we are using the Date member or the Period members to specify the activation date/period. More...

Public Member Functions

 OnHoldOptions ()
 Initializes a new instance of the OnHoldOptions class. More...
 

Properties

DateTime ActivationDate [get, set]
 Gets or sets the activation date. More...
 
short ActivationPeriodDays [get, set]
 Gets or sets the activation period in days. More...
 
short ActivationPeriodHours [get, set]
 Gets or sets the activation period in hours. More...
 
short ActivationPeriodWeeks [get, set]
 Gets or sets the activation period in weeks. More...
 
short OnHoldType [get, set]
 Gets or sets the OnHold Type. The value is an enumeration for HoldType.

EnumerationDescription
0Activation Date
1Activation Period
More...
 
bool PlaceOnHoldAllAssociatedJobs [get, set]
 Gets or sets a value indicating whether to place on hold all associated jobs. More...
 
string ReasonForHold [get, set]
 Gets or sets the reason for holding the job. More...
 

Description

Specifies the hold job information. OnHoldType member indicates whether we are using the Date member or the Period members to specify the activation date/period.

Constructor & Destructor Documentation

Initializes a new instance of the OnHoldOptions class.

Property Documentation

DateTime ActivationDate
getset

Gets or sets the activation date.

short ActivationPeriodDays
getset

Gets or sets the activation period in days.

short ActivationPeriodHours
getset

Gets or sets the activation period in hours.

short ActivationPeriodWeeks
getset

Gets or sets the activation period in weeks.

short OnHoldType
getset

Gets or sets the OnHold Type. The value is an enumeration for HoldType.

EnumerationDescription
0Activation Date
1Activation Period

bool PlaceOnHoldAllAssociatedJobs
getset

Gets or sets a value indicating whether to place on hold all associated jobs.

string ReasonForHold
getset

Gets or sets the reason for holding the job.