Definition Class Reference

This class defines a task that can be executed by the Task Manager. More...

Inheritance diagram for Definition:

Collaboration diagram for Definition:

Public Member Functions
_.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	OnTask ()
	This method is responsible for executing the task. 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.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.

Static Public Attributes
	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...

Detailed Description

This class defines a task that can be executed by the Task Manager.

To create a new task, create a subclass and override the OnTask method.
All public properties whose name does not start with a "%" are treated as user-configurable "settings" for this task.

Member Function Documentation

CheckPermission()

_.Library.Boolean CheckPermission ( _.Library.String  taskClass, _.Library.String  namespace, _.Library.Status  sc  )

static

This method checks if the current process has the permission defined by the RESOURCE parameter for the given Task class.

This will

return 1 if the process has permission, or if no RESOURCE is defined. It will return 0 otherwise.

GetCollectionType()

_.Library.String GetCollectionType ( _.Library.String  propertyName, _.Library.String  tCollection  )

static

Return a collection type for a property.

By passing reference tCollection we can get all properties which are collections.

GetSettings()

_.Library.List GetSettings

(

)

Return a serialized list of user-defined Property values for an instance of this Task as a $List.

This serialized list is stored in SYS.Task.Settings for the scheduled Task and used by the Task Manager to set the Properties before OnTask() is run.
The serialized state is of the form: $LB(name,val,name,val)

OnSubmit()

_.Library.Status OnSubmit	(	_.Library.String	pID,
		_.Library.String	pSubmit
	)

This callback is called when this form is submitted.

pID is the ID value associated with the form. The default implementation will perform a Save if the AutoForm is a persistent object.
pSubmit is the name of the submit button (i.e., $AUTOFORM_SAVE).

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 in SwitchJournal, ShadowPurge, SecurityScan, RunLegacyTask, PurgeZENReports, PurgeTaskHistory, PurgeJournal, PurgeErrorsAndLogs, PurgeBackupLog, PurgeAudit, InventoryScan, IntegrityCheck, DiagnosticReport, DeepSeeSynchronize, DeepSeeBuild, CleanSourceJournal, and CheckLogging.

SetSettings()

_.Library.Status SetSettings

(

_.Library.List

pState

)

Called by the Task Manager prior to running OnTask() to set all Property values.

The 'pState' value is the serialized list of Property values stored in the scheduled Task in SYS.Task.Settings.

Member Data Documentation

DOMAIN

DOMAIN = None

static

This class defines a task that can be executed by the Task Manager.

To create a new task, create a subclass and override the OnTask method.
All public properties whose name does not start with a "%" are treated as user-configurable "settings" for this task.

Default Localization Domain

RESOURCE

RESOURCE = None

static

This specifies a security resource and optional permission.

Access to the resource

will be required to create, modify or run a task of this type. The format is "<resource>:<permission>". If is ommited, "USE" is implied. Note that this parameter cannot be overridden using the COSEXPRESSION parameter type.

TaskName

TaskName = None

static

This defines the user-visible name of this task.

It is defined in the subclasses.