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

Class: Workflow

Source Location: /CORE/system/classes/workflow/Workflow.php

Class Workflow

Class Overview

Superclass for all Workflows.

All implementing classes should overwrite the methods marked with:
TO BE OVERWRITTEN!

Located in /CORE/system/classes/workflow/Workflow.php [line 38]

Author(s):

Kevin Papst

Information Tags:

Version:	$Id: Workflow.php,v 1.3 2006/11/26 22:04:00 kpapst Exp $
Copyright:	Copyright (C) 2002-2006 Kevin Papst
License:	GNU Public License

Methods

[ Top ]

Descendants

Child Class	Description
PublishingWorkflow	The PublishingWorkflow is a really simple Workflow.
SingleReviewWorkflow	The SingleReviewWorkflow is a Workflow where one Person of a specified User Group has to accept the submitted Changes.

[ Top ]

Method Summary

Workflow	Workflow()	Creates a new Workflow Instance.
void	getActivityID()	Get the current Step of this Workflow.
void	getDescription()	Return the Description of this Workflow.
void	getItem()	Get the Item for this Workflow instance.
void	getName()	Return the Name of this Workflow.
array	getPossibleActivities()	Return the next possible Activities.
void	initWorkflow()	Will be called when the WorkflowService instantiates a new Object of this Type.
void	performActivity()	Return whether the requested Activity could be performed.

[ Top ]

Methods

Constructor Workflow [line 48]

Workflow Workflow(
)

Creates a new Workflow Instance.

[ Top ]

getActivityID [line 80]

void getActivityID(
)

Get the current Step of this Workflow.

If the Workflow has just started and no Activity has performed it returns null. Might be overwritten...

[ Top ]

getDescription [line 108]

void getDescription(
)

Return the Description of this Workflow.

TO BE OVERWRITTEN!

Redefined in descendants as:

[ Top ]

getItem [line 69]

void getItem(
)

Get the Item for this Workflow instance.

DO NOT OVERWRITE!

[ Top ]

getName [line 98]

void getName(
)

Return the Name of this Workflow.

The Name should be a short String.
TO BE OVERWRITTEN!

Redefined in descendants as:

[ Top ]

getPossibleActivities [line 141]

array getPossibleActivities(
)

Return the next possible Activities.

If there are no more Activities the Array has a length of 0.
TO BE OVERWRITTEN!

API Tags:

Return:

an Array of

WorkflowActivity

instances

Redefined in descendants as:

[ Top ]

initWorkflow [line 119]

void initWorkflow(
)

Will be called when the WorkflowService instantiates a new Object of this Type.

Overwrite this method to do some initialization work within your Workflow.
TO BE OVERWRITTEN!

Redefined in descendants as:

[ Top ]

performActivity [line 128]

void performActivity(

$activityID 
)

Return whether the requested Activity could be performed.

TO BE OVERWRITTEN!

Parameters:

$activityID:

Redefined in descendants as:

[ Top ]