Table of Contents

Class SurveyAggregate

Namespace
InSite.Domain.Surveys.Forms
Assembly
Shift.Sdk.dll
public class SurveyAggregate : AggregateRoot
Inheritance
SurveyAggregate
Inherited Members
Extension Methods

Constructors

SurveyAggregate() 

public SurveyAggregate()

Properties

Data 

public SurveyState Data { get; }

Property Value

SurveyState

Methods

AddSurveyBranch(Guid, Guid?) 

public void AddSurveyBranch(Guid fromOption, Guid? toQuestion)

Parameters

fromOption Guid
toQuestion Guid?

AddSurveyCondition(Guid, Guid[]) 

public void AddSurveyCondition(Guid maskingItem, Guid[] maskedQuestions)

Parameters

maskingItem Guid
maskedQuestions Guid[]

AddSurveyFormMessage(SurveyMessage) 

public void AddSurveyFormMessage(SurveyMessage message)

Parameters

message SurveyMessage

AddSurveyOptionItem(Guid, Guid) 

public void AddSurveyOptionItem(Guid list, Guid item)

Parameters

list Guid
item Guid

AddSurveyOptionList(Guid, Guid) 

public void AddSurveyOptionList(Guid question, Guid list)

Parameters

question Guid
list Guid

AddSurveyQuestion(Guid, SurveyQuestionType, string, string, string) 

public void AddSurveyQuestion(Guid question, SurveyQuestionType type, string code, string indicator, string source)

Parameters

question Guid
type SurveyQuestionType
code string
indicator string
source string

AddSurveyRespondents(Guid[]) 

public void AddSurveyRespondents(Guid[] respondents)

Parameters

respondents Guid[]

AttributeSurveyQuestion(Guid, string) 

public void AttributeSurveyQuestion(Guid question, string attribute)

Parameters

question Guid
attribute string

ChangeSurveyDisplaySummaryChart(bool) 

public void ChangeSurveyDisplaySummaryChart(bool displaySummaryChart)

Parameters

displaySummaryChart bool

ChangeSurveyFormAsset(int) 

public void ChangeSurveyFormAsset(int asset)

Parameters

asset int

ChangeSurveyFormContent(ContentContainer) 

public void ChangeSurveyFormContent(ContentContainer content)

Parameters

content ContentContainer

ChangeSurveyFormLanguages(string, string[]) 

public void ChangeSurveyFormLanguages(string language, string[] translations)

Parameters

language string
translations string[]

ChangeSurveyFormMessages(SurveyMessage[]) 

public void ChangeSurveyFormMessages(SurveyMessage[] messages)

Parameters

messages SurveyMessage[]

ChangeSurveyFormSchedule(DateTimeOffset?, DateTimeOffset?) 

public void ChangeSurveyFormSchedule(DateTimeOffset? opened, DateTimeOffset? closed)

Parameters

opened DateTimeOffset?
closed DateTimeOffset?

ChangeSurveyFormSettings(UserFeedbackType, bool, bool, int?, int?, bool) 

public void ChangeSurveyFormSettings(UserFeedbackType userFeedback, bool requireUserIdentification, bool requireUserAuthentication, int? responseLimitPerUser, int? durationMinutes, bool enableUserConfidentiality)

Parameters

userFeedback UserFeedbackType
requireUserIdentification bool
requireUserAuthentication bool
responseLimitPerUser int?
durationMinutes int?
enableUserConfidentiality bool

ChangeSurveyFormStatus(SurveyFormStatus) 

public void ChangeSurveyFormStatus(SurveyFormStatus status)

Parameters

status SurveyFormStatus

ChangeSurveyHook(string) 

public void ChangeSurveyHook(string hook)

Parameters

hook string

ChangeSurveyOptionItemContent(Guid, ContentContainer) 

public void ChangeSurveyOptionItemContent(Guid item, ContentContainer content)

Parameters

item Guid
content ContentContainer

ChangeSurveyOptionItemSettings(Guid, string, decimal) 

public void ChangeSurveyOptionItemSettings(Guid item, string category, decimal points)

Parameters

item Guid
category string
points decimal

ChangeSurveyOptionListContent(Guid, ContentContainer, string) 

public void ChangeSurveyOptionListContent(Guid list, ContentContainer content, string category)

Parameters

list Guid
content ContentContainer
category string

ChangeSurveyQuestionContent(Guid, ContentContainer) 

public void ChangeSurveyQuestionContent(Guid question, ContentContainer content)

Parameters

question Guid
content ContentContainer

ChangeSurveyQuestionSettings(Guid, bool, bool, bool, string, bool, bool, bool, bool, bool, int?, int?, bool, bool, Guid[], bool, SurveyQuestionListSelectionRange, bool) 

public void ChangeSurveyQuestionSettings(Guid question, bool isHidden, bool isRequired, bool isNested, string likertAnalysis, bool listEnableRandomization, bool listEnableOtherText, bool listEnableBranch, bool listEnableGroupMembership, bool disableColumnHeadingWrap, int? textLineCount, int? textCharacterLimit, bool numberEnableStatistics, bool numberEnableAutoCalc, Guid[] numberAutoCalcQuestions, bool numberEnableNotApplicable, SurveyQuestionListSelectionRange listSelectionRange, bool enableCreateCase)

Parameters

question Guid
isHidden bool
isRequired bool
isNested bool
likertAnalysis string
listEnableRandomization bool
listEnableOtherText bool
listEnableBranch bool
listEnableGroupMembership bool
disableColumnHeadingWrap bool
textLineCount int?
textCharacterLimit int?
numberEnableStatistics bool
numberEnableAutoCalc bool
numberAutoCalcQuestions Guid[]
numberEnableNotApplicable bool
listSelectionRange SurveyQuestionListSelectionRange
enableCreateCase bool

ChangeSurveyScale(Guid, SurveyScale) 

public void ChangeSurveyScale(Guid question, SurveyScale scale)

Parameters

question Guid
scale SurveyScale

ConfigureSurveyWorkflow(SurveyWorkflowConfiguration) 

public void ConfigureSurveyWorkflow(SurveyWorkflowConfiguration configuration)

Parameters

configuration SurveyWorkflowConfiguration

CreateState()

Every aggregate must override this method to create the object that holds its current state.

public override AggregateState CreateState()

Returns

AggregateState

CreateSurveyForm(string, Guid, int, string, SurveyFormStatus, string) 

public void CreateSurveyForm(string source, Guid organization, int asset, string name, SurveyFormStatus status, string language)

Parameters

source string
organization Guid
asset int
name string
status SurveyFormStatus
language string

DeleteSurveyBranch(Guid, Guid?) 

public void DeleteSurveyBranch(Guid fromItem, Guid? toQuestion)

Parameters

fromItem Guid
toQuestion Guid?

DeleteSurveyComment(Guid) 

public void DeleteSurveyComment(Guid comment)

Parameters

comment Guid

DeleteSurveyCondition(Guid, Guid[]) 

public void DeleteSurveyCondition(Guid maskingItem, Guid[] maskedQuestions)

Parameters

maskingItem Guid
maskedQuestions Guid[]

DeleteSurveyForm() 

public void DeleteSurveyForm()

DeleteSurveyOptionItem(Guid) 

public void DeleteSurveyOptionItem(Guid item)

Parameters

item Guid

DeleteSurveyOptionList(Guid) 

public void DeleteSurveyOptionList(Guid list)

Parameters

list Guid

DeleteSurveyQuestion(Guid) 

public void DeleteSurveyQuestion(Guid question)

Parameters

question Guid

DeleteSurveyRespondents(Guid[]) 

public void DeleteSurveyRespondents(Guid[] respondents)

Parameters

respondents Guid[]

LockSurveyForm(DateTimeOffset) 

public void LockSurveyForm(DateTimeOffset locked)

Parameters

locked DateTimeOffset

ModifySurveyComment(Guid, string, FlagType?, DateTimeOffset?) 

public void ModifySurveyComment(Guid comment, string text, FlagType? flag, DateTimeOffset? resolved)

Parameters

comment Guid
text string
flag FlagType?
resolved DateTimeOffset?

PostSurveyComment(Guid, string, FlagType?, DateTimeOffset?) 

public void PostSurveyComment(Guid comment, string text, FlagType? flag, DateTimeOffset? resolved)

Parameters

comment Guid
text string
flag FlagType?
resolved DateTimeOffset?

RecodeSurveyQuestion(Guid, string, string) 

public void RecodeSurveyQuestion(Guid question, string code, string indicator)

Parameters

question Guid
code string
indicator string

RenameSurveyForm(string) 

public void RenameSurveyForm(string name)

Parameters

name string

ReorderSurveyOptionItems(Guid, Dictionary<Guid, int>) 

public void ReorderSurveyOptionItems(Guid list, Dictionary<Guid, int> sequences)

Parameters

list Guid
sequences Dictionary<Guid, int>

ReorderSurveyOptionLists(Guid, Dictionary<Guid, int>) 

public void ReorderSurveyOptionLists(Guid question, Dictionary<Guid, int> sequences)

Parameters

question Guid
sequences Dictionary<Guid, int>

ReorderSurveyQuestions(Dictionary<Guid, int>) 

public void ReorderSurveyQuestions(Dictionary<Guid, int> sequences)

Parameters

sequences Dictionary<Guid, int>

UnlockSurveyForm(DateTimeOffset) 

public void UnlockSurveyForm(DateTimeOffset unlocked)

Parameters

unlocked DateTimeOffset