Class PerformanceReport

Namespace

CSF.Screenplay.ReportModel

Assembly

CSF.Screenplay.dll

Model represents an IPerformance within a Screenplay report.

public class PerformanceReport

Inheritance

object

PerformanceReport

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Like many models in this namespace, this type mimicks a first-class part of the Screenplay architecture. This model type is intended for use with the serialization process to JSON. Many of the properties of these types will correspond directly with the same-named properties on the original Screenplay architecture types.

Properties

NamingHierarchy

Corresponds with NamingHierarchy.

public List<IdentifierAndNameModel> NamingHierarchy { get; set; }

Property Value

List<IdentifierAndNameModel>

Outcome

Corresponds with PerformanceState, showing the final outcome of the performance.

public string Outcome { get; set; }

Property Value

string

Remarks

This property contains the string representation of the value of PerformanceState. It is named 'Outcome' rather than 'PerformanceState' because the concept of state would refer to a current state, wheras a report is about something which happened in the past. Additionally, it is impossible for a report to indicate InProgress or NotStarted here. The state will always correspond to one of the three terminal states for a performance. Thus, this property indicates the final outcome of the performance, rather than where it is 'right now'.

Reportables

Gets or set an ordered collection of the reportable events which occurred in the current performance.

public List<ReportableModelBase> Reportables { get; set; }

Property Value

List<ReportableModelBase>