ActionsCodesServiceClient class

The ActionsCodesService manages the full lifecycle of action code records. It provides standard CRUD operations alongside a robust state machine for classification of specific activities, events, or status changes within the system, often organized in a hierarchical (tree) structure.

Annotations

@GrpcServiceName.new('Scailo.ActionsCodesService')

Constructors

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

Properties

hashCode → int: The hash code for this object.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

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.
commentAdd(IdentifierUUIDWithUserComment request, {CallOptions? options}) → ResponseFuture<IdentifierResponse>: Adds an audit comment to the record's history without changing its current lifecycle status.
count(ActionsCodesServiceCountReq 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(ActionsCodesServiceCreateRequest 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(ActionsCodesServiceFilterReq request, {CallOptions? options}) → ResponseFuture<StandardFile>: Generates and returns a CSV file containing records matching the filter criteria. Ideal for generating monthly reports or data backups. The same file could also be used as a template for uploading records.
draft(ActionsCodesServiceCreateRequest request, {CallOptions? options}) → ResponseFuture<IdentifierResponse>: Saves a new record as a draft without triggering side effects.
draftUpdate(ActionsCodesServiceUpdateRequest request, {CallOptions? options}) → ResponseFuture<IdentifierResponse>: Updates an existing record that is currently in DRAFT status.
filter(ActionsCodesServiceFilterReq request, {CallOptions? options}) → ResponseFuture<ActionsCodesList>: 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
restore(IdentifierUUIDWithUserComment request, {CallOptions? options}) → ResponseFuture<IdentifierResponse>: Restores a previously DISCARDED or HALTED record.
revisionUpdate(ActionsCodesServiceUpdateRequest request, {CallOptions? options}) → ResponseFuture<IdentifierResponse>: Updates a record that has been sent back for REVISION.
searchAll(ActionsCodesServiceSearchAllReq request, {CallOptions? options}) → ResponseFuture<ActionsCodesList>: Performs a free-text search across records using a search key.
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<ActionsCodesList>: Returns all records filtered by their active status.
viewAllForEntityUUID(IdentifierUUID request, {CallOptions? options}) → ResponseFuture<ActionsCodesList>: Returns all records belonging to a specific organization/entity UUID.
viewByID(Identifier request, {CallOptions? options}) → ResponseFuture<ActionCode>: Retrieves a single record by its internal numeric ID. This operation is optimized for high-performance internal system logic and backend-to-backend communication
viewByUUID(IdentifierUUID request, {CallOptions? options}) → ResponseFuture<ActionCode>: 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<ActionCode>: 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<ActionCode>: 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<ActionsCodesList>: Retrieves a list of records matching the provided array of internal IDs.
viewWithPagination(ActionsCodesServicePaginationReq request, {CallOptions? options}) → ResponseFuture<ActionsCodesServicePaginationResponse>: 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.