WorkSession Properties
The WorkSession type exposes the following members.
Properties

  NameDescription
Public propertyAnswerCollection
Returns the collection of answers pertaining to the current work item.
Public propertyCurrentWorkItem
This is the one that's next in line to be completed. In the case of interview work items, an interview is current both before and after it has been presented to the user, all the way up until FinishInterview is called, at which time whatever work item that follows becomes current. If the current work item is a document, AssembleDocuments() should be called, which will complete that document (and any that follow it), advancing CurrentWorkItem as it goes.
Public propertyDefaultAssemblySettings
When you create a WorkSession, a copy of the application-wide default assembly settings (as specified in web.config) is made and assigned to this property of the AnswerCollection. If the host app customizes these DefaultAssemblyOptions, each subsequent document generated in the WorkSession will inherit those customized settings.
Public propertyDefaultInterviewSettings
The intent with DefaultInterviewOptions was to work much like DefaultAssemblyOptions. When you create a WorkSession, a copy of the application-wide default interview settings (as specified in web.config) is made and assigned to this property of the AnswerCollection. If the host app customizes these DefaultInterviewOptions, each subsequent interview in the WorkSession will inherit those customized settings. HOWEVER, this doesn't work currently because InterviewWorkItems do not carry a reference to the WorkSession, and therefore don't have access to this property. TODO: figure out how this should work. One possibility would be for the WorkSession class to expose the GetInterview method (and maybe also FinishInterview) rather than having those on the InterviewWorkItem class. However, this would mean WorkSession would expose a GetInterview method all the time, but it is only callable some of the time (i.e. when the CurrentWorkItem is an interview).
Public propertyIsCompleted
returns true when all work items in the session have been completed, i.e. CurrentWorkItem == null.
Public propertyService
Returns the IServices object for the current work session.
Public propertyWorkItems
Exposees a list of interview and document work items, both already completed and pending, as suitable for presentation in a host application (for example, to show progress through the work session).
Back to Top
See Also