C# Class RusticiSoftware.TinCanAPILibrary.Model.TinCan090.Statement

Inheritance: IValidatable

Public Methods

Method	Description
GetVerbAsEnum ( ) : StatementVerb	Returns the statement verb in its internal enum format
HandleSpecialVerbs ( ) : void	Handles verbs with special requirements
Statement ( ) : System	Empty constructor
Statement ( Actor actor, StatementVerb verb, StatementTarget statementTarget ) : System	Creates a Statement with the minimum suggested properties
Validate ( bool earlyReturnOnFailure ) : IEnumerable	Validates the statement, ensuring required fields are used and any necessary information (such as a result for specific verbs) is provided and valid.

Method	Description
VerifyCompletionValue ( System.Result result, string verb, bool expectedCompletion ) : void	Validates expected completion values
VerifySuccessAndCompletionValues ( System.Result result, string verb, bool expectedSuccess, bool expectedCompletion ) : void	Validates both success and completion
VerifySuccessValue ( System.Result result, string verb, bool expectedSuccess ) : void	Validates expect success values

Returns the statement verb in its internal enum format

public GetVerbAsEnum ( ) : StatementVerb
return	StatementVerb

Handles verbs with special requirements

public HandleSpecialVerbs ( ) : void
return	void

Empty constructor

public Statement ( ) : System
return	System

Creates a Statement with the minimum suggested properties

public Statement ( Actor actor, StatementVerb verb, StatementTarget statementTarget ) : System
actor	Actor	The actor in this statement
verb	StatementVerb	The verb in this statement
statementTarget	StatementTarget	The target of this statement
return	System

Validates the statement, ensuring required fields are used and any necessary information (such as a result for specific verbs) is provided and valid.

public Validate ( bool earlyReturnOnFailure ) : IEnumerable
earlyReturnOnFailure	bool
return	IEnumerable

Validates expected completion values

protected VerifyCompletionValue ( System.Result result, string verb, bool expectedCompletion ) : void
result	System.Result	The result object
verb	string	The statement verb
expectedCompletion	bool	What value the completion should be
return	void

Validates both success and completion

protected VerifySuccessAndCompletionValues ( System.Result result, string verb, bool expectedSuccess, bool expectedCompletion ) : void
result	System.Result	The result object
verb	string	The statement verb
expectedSuccess	bool	The expected success value
expectedCompletion	bool	The expected completion value
return	void

Validates expect success values

protected VerifySuccessValue ( System.Result result, string verb, bool expectedSuccess ) : void
result	System.Result	The result object
verb	string	The verb for the statement
expectedSuccess	bool	What value the success should be
return	void