%SYS
DeepSeeSynchronize Class Reference
Inheritance diagram for DeepSeeSynchronize:
Collaboration diagram for DeepSeeSynchronize:

Public Member Functions

_.Library.Status OnTask ()
 This method is responsible for executing the task. More...
 
- Public Member Functions inherited from Definition
_.Library.List GetSettings ()
 Return a serialized list of user-defined Property values for an instance of this Task as a $List. More...
 
_.Library.Status OnSubmit (_.Library.String pID, _.Library.String pSubmit)
 This callback is called when this form is submitted. More...
 
_.Library.Status SetSettings (_.Library.List pState)
 Called by the Task Manager prior to running OnTask() to set all Property values. More...
 

Static Public Member Functions

_.Library.Status Schedule (pSuspend, pDailyFrequency, pDailyFrequencyTime, pDailyIncrement, pStartTime, pEndTime)
 This method will make sure the task is registered with the. More...
 
- Static Public Member Functions inherited from Definition
_.Library.Boolean CheckPermission (_.Library.String taskClass, _.Library.String namespace, _.Library.Status sc)
 This method checks if the current process has the permission defined by the RESOURCE parameter for the given Task class. More...
 
_.Library.String GetCollectionType (_.Library.String propertyName, _.Library.String tCollection)
 Return a collection type for a property. More...
 
_.Library.String GetTaskName ()
 Returns the localized name of this task.
 

Additional Inherited Members

- Static Public Attributes inherited from Definition
 DOMAIN = None
 This class defines a task that can be executed by the Task Manager. More...
 
 RESOURCE = None
 This specifies a security resource and optional permission. More...
 
 TaskName = None
 This defines the user-visible name of this task. More...
 

Member Function Documentation

◆ OnTask()

_.Library.Status OnTask ( )

This method is responsible for executing the task.


At the scheduled time, the Task Manager creates an instance of this object, sets any property values using the stored "settings" for the task, and then invokes this method to execute the task.
In order to execute a real task, override this method in a subclass.

Reimplemented from Definition.

◆ Schedule()

_.Library.Status Schedule (   pSuspend,
  pDailyFrequency,
  pDailyFrequencyTime,
  pDailyIncrement,
  pStartTime,
  pEndTime 
)
static

This method will make sure the task is registered with the.

Task Manager to run on the schedule defined by the arguments.

If there is currently no task scheduled, this will create one, otherwise it will modify any pre-existing task. The default settings will run the synch task every 60 minutes.