[class tree: bigace-api] [index: bigace-api] [all elements]

Class: AutoJob

Source Location: /CORE/system/api/job/AutoJob.php

Class AutoJob

Class Overview

This represents an executable AutoJob, which can be runned at Program Startup in a defined time-cycle.

State:

10 = CORRUPT (corrupt, stopped until reactivation) 20 = FAILURE (failure during last execution, will be tried next time) 30 = RUNNING (normal state, running)

Developer should return a useful message in getMessage() if anything went wrong!

Located in /CORE/system/api/job/AutoJob.php [line 50]

Author(s):

Kevin Papst

Information Tags:

Version:	$Id: AutoJob.php,v 1.2 2007/12/27 21:28:51 kpapst Exp $
Copyright:	Copyright (C) Kevin Papst
License:	GNU Public License

Methods

[ Top ]

Descendants

Child Class	Description
SessionCleanup	This AutoJob cleans up all Session that are timed out.

[ Top ]

Method Summary

int	execute()
void	getConfigPackage()	If your AutoJob requires further configuration, you should return the configs package name.
String	getDescription()	Returns the Description of this AutoJob.
void	getMessage()	Return a log message at least if the execution task failed.
String	getName()	Returns the Name (unique identifier) of this AutoJob.
void	getNextExecution()	Calculates and returns the next execution time as Unix Timestamp.

[ Top ]

Methods

execute [line 89]

int execute(
)

API Tags:

Return:	the state of this and future executions
See:	AUTOJOB_STOPPED, AUTOJOB_CORRUPT, AUTOJOB_FAILURE, AUTOJOB_RUNNING

Redefined in descendants as:

SessionCleanup::execute()

[ Top ]

getConfigPackage [line 81]

void getConfigPackage(
)

If your AutoJob requires further configuration, you should return the configs package name.

This config package will be cached and be editable in the Administration.

Redefined in descendants as:

SessionCleanup::getConfigPackage() : null for no required config, otherwise a String

[ Top ]

getDescription [line 64]

String getDescription(
)

Returns the Description of this AutoJob.

API Tags:

Return:

the Template Description

Redefined in descendants as:

SessionCleanup::getDescription() : Returns the Description of this AutoJob.

[ Top ]

getMessage [line 97]

void getMessage(
)

Return a log message at least if the execution task failed.

This log message will be stored for later accessability.

[ Top ]

getName [line 56]

String getName(
)

Returns the Name (unique identifier) of this AutoJob.

API Tags:

Return:

the AutoJob Name

Redefined in descendants as:

SessionCleanup::getName() : Returns the Name (unique identifier) of this AutoJob.

[ Top ]

getNextExecution [line 71]

void getNextExecution(
)

Calculates and returns the next execution time as Unix Timestamp.

Redefined in descendants as:

SessionCleanup::getNextExecution()

[ Top ]