PerlDoc

See PublishedAPI for packages intended to be used by Plugin and Contrib authors, or browse all packages.
See also Developing plugins, Developer's Bible, Technical Overview

Perl Module:

---

Parent package: Foswiki::Plugins::QMPlugin
Child packages:

More ...Less ...

internal package Foswiki::Plugins::QMPlugin::Role

implements a role concept for workflows

ClassProperty PROPS

definition of all mandatory properties of a class of its kind; node, edge and role classes each refine this list

ClassMethod new() → $core

constructor for a role object

ObjectMethod render($format, $params) → $string

render this node given the specified format string params is a hash reference with default values for properties not defined

ObjectMethod isMember($idOrUser) → $boolean

returns true if $idOrUser (default current user) is member of this role

ObjectMethod getMembers($expand) → @members

returns the list of members that have this role assigned

ObjectMethod getEmails() → @emails

returns the list of emails of this role. this is either the list of users as per "notify" property or of all members otherwise.