MssScheduleDef Object
MSS schedule tasks are encapsulated in a MssScheduleDef object.
MssScheduleDef Properties
The MssScheduleDef object contains the following properties.
| Property | Type | Description |
|---|---|---|
|
SiteService |
String |
The Site.Service for the MSS for this schedule. |
|
MssKey |
String |
The unique database key for the MSS task. |
|
Name |
String |
The name of the MSS schedule task. |
|
Category |
String |
The category of the MSS schedule task. |
|
Description |
String |
The description of the MSS schedule task. |
|
Active |
Boolean |
Is the MSS task currently active? |
MssScheduleDef Methods
The MssScheduleDef object contains the following methods:
CreateSchedule
Creates a new MSS schedule task based on the properties of this object.
Syntax
CreateSchedule() As String
Parameters
None.
Remarks
Returns the unique database key for the newly created MSS task.
DeleteSchedule
Deletes the MSS schedule task.
Syntax
DeleteSchedule() As Boolean
Parameters
None.
Remarks
Returns true if the schedule is successfully deleted; returns false otherwise.
GetAsString
Returns an XML string representation of the MSS schedule task.
Syntax
GetAsString() As String
Parameters
None.
Remarks
None.
LoadFromString
Loads the MssScheduleDef object with the schedule details defined in the given XML string.
Syntax
LoadFromString(strScheduleDefXml As String)
Parameters
| Parameter | Required | Description |
|---|---|---|
|
strScheduleDefXml |
Yes |
An XML string that describes a MSS schedule task. |
Remarks
Returns true if the load was successful; returns false otherwise.
ReadScheduleFromMss (1)
Loads the MssScheduleDef object with the information stored in the MSS.
Syntax
ReadScheduleFromMss() As Boolean
Parameters
None.
Remarks
Returns true if the load was successful; returns false otherwise.
Requires that the MssKey and SiteService properties of the object have been set.
ReadScheduleFromMss (2)
Loads the MssScheduleDef object with the information stored in the MSS.
Syntax
ReadScheduleFromMss(strMssKey As String) As Boolean
Parameters
| Parameter | Required | Description |
|---|---|---|
|
strMssKey |
Yes |
The MSS key to get the record details from. |
Remarks
Returns true if the load was successful; returns false otherwise.
Requires that the SiteService properties of the object have been set.
UpdateSchedule
Updates the MSS schedule task based on the properties of this object.
Syntax
UpdateSchedule() As Boolean
Parameters
None.
Remarks
Returns true if the schedule is successfully updated; returns false otherwise.
