SmartBatch 2006 Application Programmatic Interface

ScheduleData Members

ScheduleData overview

Public Static Fields

HighDate Defines the high date recognized by SmartBatch.
LowDate Defines the low date recognized by SmartBatch.

Public Instance Constructors

ScheduleData Constructor Default constructor.

Public Instance Properties

AppName An Application Group provides a grouping of objects that you want to manage and secure together. Currently, the Default Application Group is provided. A future release of the product will provide the ability to add and manage additional Application Groups. An Application Group name consist of a combination of letters or numbers up to 32 characters in length.
DayOfMonth Indicates a day of the month.
DayOfWeek Indicates the day of week value.
Description Description of the schedule. Can be up to 64 characters.
DurEndDate The end date of the duration for the schedule.
DurStartDate The start date of the duraction for the schedule.
Enabled Indicates if the Schedule is enabled. The Executive Server will only process Schedules when they are enabled.
EndDate The end date for the Schedule.
EndTime The end time that is associated with schedules that have a recurring time within a day.
FreqInterval The frequencey interval. Defines how often something occurs. This is used in conjunction with FrequencyType.
FreqMinutes The frequence minutes for a schedule that has a recurring time.
FrequencyType Specifies the type of schedule from the ScheduleTypes enum.
FromTime Indicates how recurring times are calculated. This must be set to one of the ScheduleRecurringTime values.
ModDate The date and time that any information pertaining to the object was changed. The value is set by the product in the DataServices assembly.
ModUser The user that last changed any information pertaining to the object. The value is automatically obtained by a custom .NET remoting layer that provides the value of the Windows user/account.
NewSchedName This value is used when renaming a schedule. Set to the new name for the schedule.
NextRunDate The next run date for the Schedule. This is a calculated value that is calculated any time the Schedule information is updated or the Executive Server has restarted or the Executive Server has completed processing an object with the Schedule.
RunBetween Identifies the run between option value. This must be set to one of the ScheduleRecurringOptions values.
SchedName The name of the object. The name consist of a combination of letters or numbers up to 32 characters in length.
ScheduleStartup Identifies the startup option for the schedule. This must be set to one of the ScheduleStartupOptions values.
SpecificDates Provides a list of SpecificDateData objects that identify any additional or exception dates that are part of the Schedule.
StartDate The start date for the Schedule.
StartTime The start time for the schedule.
Status Reserved for future use.

Public Instance Methods

Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object)Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetType (inherited from Object)Gets the Type of the current instance.
ToString (inherited from Object)Returns a String that represents the current Object.

Protected Instance Methods

Finalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.

See Also

ScheduleData Class | OnLineToolWorks.SmartBatch.Data Namespace