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::Review

a Review is part of a State and records the review in progress

ClassProperty TRACE

boolean toggle to enable debugging of this class

ClassProperty PROPS

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

ClassMethod new($web, $topic, $rev, $meta) → $state

constructor for a state object

ObjectMethod finish()

called when this object is destroyed

ObjectMethod getState() → $state

get the state this review is part of

ObjectMethod store($meta)

store the review object into a QMREVIEW meta data record

ObjectMethod props() → @props

get a list of all known Review properties

ObjectMethod prop($key, $val) → $val

getter/setter for a property of this class

ObjectMethod index() → $index

get the unique index of this object in a set of same objects part of a state

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

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

ObjectMethod expandValue($val) → $val

expand the given value in the context of a state this object is in

ObjectMethod stringify() → $string

returns a string representation of this object