QuestionnaireSectionsServiceClient class

The QuestionnaireSectionsService manages the full lifecycle of questionnaire section records. It provides standard CRUD operations alongside a robust state machine for verification, manager approval, and completion.

Annotations

• @GrpcServiceName.new('Scailo.QuestionnaireSectionsService')

Constructors

QuestionnaireSectionsServiceClient(ClientChannel channel, {CallOptions? options, Iterable<ClientInterceptor>? interceptors})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

$createCall<Q, R>(ClientMethod<Q, R> method, Stream<Q> requests, {CallOptions? options}) → ClientCall<Q, R>

inherited

$createStreamingCall<Q, R>(ClientMethod<Q, R> method, Stream<Q> requests, {CallOptions? options}) → ResponseStream<R>

inherited

$createUnaryCall<Q, R>(ClientMethod<Q, R> method, Q request, {CallOptions? options}) → ResponseFuture<R>

inherited

approve(IdentifierUUIDWithUserComment request, {CallOptions? options}) → ResponseFuture<IdentifierResponse>

Officially approves the record.

attachVaultFolder(VaultFolderAttachRequest request, {CallOptions? options}) → ResponseFuture<IdentifierResponse>

Attaches a specified folder directly to a record without requiring a full revision workflow.

commentAdd(IdentifierUUIDWithUserComment request, {CallOptions? options}) → ResponseFuture<IdentifierResponse>

Adds an audit comment to the record's history without changing its current lifecycle status.

complete(IdentifierUUIDWithUserComment request, {CallOptions? options}) → ResponseFuture<IdentifierResponse>

Marks the record as finalized and fully processed.

count(QuestionnaireSectionsServiceCountReq request, {CallOptions? options}) → ResponseFuture<CountResponse>

Returns the total count of records matching the given complex filter criteria.

countInStatus(CountInSLCStatusRequest request, {CallOptions? options}) → ResponseFuture<CountResponse>

Returns the total number of records currently in a specific lifecycle status.

create(QuestionnaireSectionsServiceCreateRequest request, {CallOptions? options}) → ResponseFuture<IdentifierResponse>

Creates a new record and immediately moves it to the verification workflow.

discard(IdentifierUUIDWithUserComment request, {CallOptions? options}) → ResponseFuture<IdentifierResponse>

Permanently cancels the record.

downloadAsCSV(QuestionnaireSectionsServiceFilterReq request, {CallOptions? options}) → ResponseFuture<StandardFile>

CSV operations Download the CSV file that consists of the list of records according to the given filter request. The same file could also be used as a section for uploading records

downloadImportTemplate(Empty request, {CallOptions? options}) → ResponseFuture<StandardFile>

Download the CSV section that could be used to upload records

draft(QuestionnaireSectionsServiceCreateRequest request, {CallOptions? options}) → ResponseFuture<IdentifierResponse>

Saves a new record as a draft without triggering side effects.

draftUpdate(QuestionnaireSectionsServiceUpdateRequest request, {CallOptions? options}) → ResponseFuture<IdentifierResponse>

Updates an existing record that is currently in DRAFT status.

filter(QuestionnaireSectionsServiceFilterReq request, {CallOptions? options}) → ResponseFuture<QuestionnaireSectionsList>

Performs a high-granularity search based on multiple specific field filters.

halt(IdentifierUUIDWithUserComment request, {CallOptions? options}) → ResponseFuture<IdentifierResponse>

Temporarily halts processing of the record.

importFromCSV(StandardFile request, {CallOptions? options}) → ResponseFuture<IdentifierUUIDsList>

Bulk imports records from a provided CSV file. Behavior:

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

reopen(IdentifierUUIDWithUserComment request, {CallOptions? options}) → ResponseFuture<IdentifierResponse>

Reopens a finalized or closed record for further modifications.

repeat(IdentifierUUIDWithUserComment request, {CallOptions? options}) → ResponseFuture<IdentifierResponse>

Creates a new record based on an existing one (cloning).

restore(IdentifierUUIDWithUserComment request, {CallOptions? options}) → ResponseFuture<IdentifierResponse>

Restores a previously DISCARDED or HALTED record.

revisionUpdate(QuestionnaireSectionsServiceUpdateRequest request, {CallOptions? options}) → ResponseFuture<IdentifierResponse>

Updates a record that has been sent back for REVISION.

searchAll(QuestionnaireSectionsServiceSearchAllReq request, {CallOptions? options}) → ResponseFuture<QuestionnaireSectionsList>

Performs a free-text search across records using a search key.

sendEmail(IdentifierWithEmailAttributes request, {CallOptions? options}) → ResponseFuture<IdentifierResponse>

Triggers an automated email notification related to the record.

sendForRevision(IdentifierUUIDWithUserComment request, {CallOptions? options}) → ResponseFuture<IdentifierResponse>

Sends the record back to the creator for corrections.

sendForVerification(IdentifierUUIDWithUserComment request, {CallOptions? options}) → ResponseFuture<IdentifierResponse>

Submits a record in DRAFT or REVISION status for verification.

toString() → String

A string representation of this object.

inherited

verify(IdentifierUUIDWithUserComment request, {CallOptions? options}) → ResponseFuture<IdentifierResponse>

Marks a record as verified, signaling that it is ready for final approval.

viewAll(ActiveStatus request, {CallOptions? options}) → ResponseFuture<QuestionnaireSectionsList>

Returns all records filtered by their active status.

viewAllForEntityUUID(IdentifierUUID request, {CallOptions? options}) → ResponseFuture<QuestionnaireSectionsList>

Returns all records belonging to a specific organization/entity UUID.

viewByID(Identifier request, {CallOptions? options}) → ResponseFuture<QuestionnaireSection>

Retrieves a single record by its internal numeric ID. This operation is optimized for high-performance internal system logic and backend-to-backend communication

viewByReferenceID(SimpleSearchReq request, {CallOptions? options}) → ResponseFuture<QuestionnaireSection>

Retrieves a single record based on its user-defined, external reference ID.

viewByUUID(IdentifierUUID request, {CallOptions? options}) → ResponseFuture<QuestionnaireSection>

Retrieves a single record by its globally unique UUID. This is intended for public-facing interfaces, since record identifiers aren't sequential and thus cannot be predicted.

viewEssentialByID(Identifier request, {CallOptions? options}) → ResponseFuture<QuestionnaireSection>

Retrieves a record by ID excluding high-volume fields like logs for performance. This operation is optimized for high-performance internal system logic and backend-to-backend communication

viewEssentialByUUID(IdentifierUUID request, {CallOptions? options}) → ResponseFuture<QuestionnaireSection>

Retrieves a record by UUID excluding high-volume fields like logs. This is intended for public-facing interfaces, since record identifiers aren't sequential and thus cannot be predicted.

viewFromIDs(IdentifiersList request, {CallOptions? options}) → ResponseFuture<QuestionnaireSectionsList>

Retrieves a list of records matching the provided array of internal IDs.

viewWithPagination(QuestionnaireSectionsServicePaginationReq request, {CallOptions? options}) → ResponseFuture<QuestionnaireSectionsServicePaginationResponse>

Retrieves a paginated list of records based on status, sort keys, and offsets.

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

defaultHost → const String

The hostname for this service.

oauthScopes → const List<String>

OAuth scopes needed for the client.