BaseActivity Class Reference

Inheritance diagram for BaseActivity:

[legend]Collaboration diagram for BaseActivity:

[legend]List of all members.

Public Member Functions
	setDb ($db)
	BaseActivity ($db)
	getActivity ($activityId)
	getUserRoles ($user)
	getActivityRoleNames ()
	getNormalizedName ()
	setNormalizedName ($name)
	setName ($name)
	getName ()
	setDescription ($desc)
	getDescription ()
	setType ($type)
	getType ()
	setIsInteractive ($is)
	isInteractive ()
	setIsAutoRouted ($is)
	isAutoRouted ()
	setProcessId ($pid)
	getProcessId ()
	getActivityId ()
	setActivityId ($id)
	getRoles ()
	setRoles ($roles)
	checkUserRole ($user, $rolename)
Public Attributes
	$name
	$normalizedName
	$description
	$isInteractive
	$isAutoRouted
	$roles = Array()
	$outbound = Array()
	$inbound = Array()
	$pId
	$activityId
	$type

---

Detailed Description

This class represents activities, and must be derived for each activity type supported in the system. Derived activities extending this class can be found in the activities subfolder. This class is observable.

Definition at line 11 of file BaseActivity.php.

---

Member Function Documentation

BaseActivity::checkUserRole (  $  user, $  rolename )

Checks if a user has a certain role (by name) for this activity, e.g. $isadmin = $activity->checkUserRole($user,'admin'); Definition at line 212 of file BaseActivity.php.

BaseActivity::getActivity (  $  activityId  )

Factory method returning an activity of the desired type loading the information from the database. Definition at line 40 of file BaseActivity.php. References isAutoRouted(), and isInteractive().

BaseActivity::getActivityId (   )

Gets the activityId Definition at line 190 of file BaseActivity.php.

BaseActivity::getActivityRoleNames (   )

Returns an Array of asociative arrays with roleId and name for the given user Definition at line 108 of file BaseActivity.php.

BaseActivity::getDescription (   )

Gets the activity description Definition at line 145 of file BaseActivity.php.

BaseActivity::getName (   )

Gets the activity name Definition at line 135 of file BaseActivity.php.

BaseActivity::getNormalizedName (   )

Returns the normalized name for the activity Definition at line 120 of file BaseActivity.php.

BaseActivity::getProcessId (   )

Gets the processId for this activity Definition at line 185 of file BaseActivity.php.

BaseActivity::getRoles (   )

Gets array with roleIds asociated to this activity Definition at line 200 of file BaseActivity.php.

BaseActivity::getType (   )

Gets the activity type Definition at line 155 of file BaseActivity.php.

BaseActivity::getUserRoles (  $  user  )

Returns an Array of roleIds for the given user Definition at line 96 of file BaseActivity.php.

BaseActivity::isAutoRouted (   )

Gets if the activity is auto routed Definition at line 175 of file BaseActivity.php. Referenced by getActivity().

BaseActivity::isInteractive (   )

Returns if the activity is interactive Definition at line 165 of file BaseActivity.php. Referenced by getActivity().

BaseActivity::setActivityId (  $  id  )

Sets the activityId Definition at line 195 of file BaseActivity.php.

BaseActivity::setDescription (  $  desc  )

Sets the activity description Definition at line 140 of file BaseActivity.php.

BaseActivity::setIsAutoRouted (  $  is  )

Sets if the activity is auto-routed Definition at line 170 of file BaseActivity.php.

BaseActivity::setIsInteractive (  $  is  )

Sets if the activity is interactive Definition at line 160 of file BaseActivity.php.

BaseActivity::setName (  $  name  )

Sets the name for the activity Definition at line 130 of file BaseActivity.php.

BaseActivity::setNormalizedName (  $  name  )

Sets normalized name for the activity Definition at line 125 of file BaseActivity.php.

BaseActivity::setProcessId (  $  pid  )

Sets the processId for this activity Definition at line 180 of file BaseActivity.php.

BaseActivity::setRoles (  $  roles  )

Sets roles for this activities, shoule receive an array of roleIds Definition at line 206 of file BaseActivity.php.

BaseActivity::setType (  $  type  )

Sets the type for the activity - this does NOT allow you to change the actual type Definition at line 150 of file BaseActivity.php.

---

The documentation for this class was generated from the following file:

• BaseActivity.php

---