ActionCode class

Represents a full Action Code within the system.

Available extensions

Constructors

ActionCode({String? entityUuid, EmployeeMetadata? metadata, ApprovalMetadata? approvalMetadata, STANDARD_LIFECYCLE_STATUS? status, Iterable<LogbookLogConciseSLC>? logs, String? name, String? code, String? fgColor, String? bgColor, Int64? parentActionCodeId, bool? isLeaf, String? description})
factory
ActionCode.fromBuffer(List<int> data, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory
ActionCode.fromJson(String json, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory

Properties

approvalMetadata ↔ ApprovalMetadata
@description Detailed approval workflow state (Approver ID, Role, and Timestamps).
getter/setter pair
bgColor ↔ String
@description The Hexadecimal background color for UI rendering. Used to visually distinguish codes in dashboards or lists.
getter/setter pair
code ↔ String
@description The unique alphanumeric identifier used for system classification. This is typically a short string or mnemonic used in logic and filtering.
getter/setter pair
description ↔ String
@description Detailed explanation of what this action code represents and when it should be used.
getter/setter pair
entityUuid ↔ String
@description The organization's globally unique identifier.
getter/setter pair
fgColor ↔ String
@description The Hexadecimal foreground (text) color for UI rendering. Used to visually distinguish codes in dashboards or lists.
getter/setter pair
hashCode → int
Calculates a hash code based on the contents of the protobuf.
no setterinherited
info_ → BuilderInfo
no setter
isFrozen → bool
Returns true if this message is marked read-only. Otherwise false.
no setterinherited
isLeaf ↔ bool
@description Indicates whether this code is a terminal "leaf" node. If true, no further sub-codes can be nested under this entry.
getter/setter pair
logs → PbList<LogbookLogConciseSLC>
@description Comprehensive audit trail of every operation performed on this record.
no setter
metadata ↔ EmployeeMetadata
@description Standard employee and record metadata including timestamps.
getter/setter pair
name ↔ String
@description The display name of the action code.
getter/setter pair
parentActionCodeId ↔ Int64
@description The ID of the associated non-leaf parent action code in the action code hierarchy. If 0, this is a top-level (root) action code.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
status ↔ STANDARD_LIFECYCLE_STATUS
@description The current lifecycle status (e.g., DRAFT, VERIFIED, STANDING).
getter/setter pair
unknownFields → UnknownFieldSet
no setterinherited

Methods

addExtension(Extension extension, Object? value) → void
Adds an extension field value to a repeated field.
inherited
check() → void
Throws a StateError if the message has required fields without a value.
inherited
clear() → void
Clears all data that was set in this message.
inherited
clearApprovalMetadata() → void
clearBgColor() → void
clearCode() → void
clearDescription() → void
clearEntityUuid() → void
clearExtension(Extension extension) → void
Clears an extension field and also removes the extension.
inherited
clearFgColor() → void
clearField(int tagNumber) → void
Clears the contents of a given field.
inherited
clearIsLeaf() → void
clearMetadata() → void
clearName() → void
clearParentActionCodeId() → void
clearStatus() → void
clone() → ActionCode
Creates a deep copy of the fields in this message.
copyWith(void updates(ActionCode)) → ActionCode
Apply updates to a copy of this message.
createEmptyInstance() → ActionCode
Creates an empty instance of the same message type as this.
deepCopy() → T

Available on T, provided by the GeneratedMessageGenericExtensions extension

Returns a writable deep copy of this message.
ensureApprovalMetadata() → ApprovalMetadata
ensureMetadata() → EmployeeMetadata
extensionsAreInitialized() → bool
inherited
freeze() → GeneratedMessage
Make this message read-only.
inherited
getDefaultForField(int tagNumber) → dynamic
Returns the default value for the given field.
inherited
getExtension(Extension extension) → dynamic
Returns the value of extension.
inherited
getField(int tagNumber) → dynamic
Returns the value of the field associated with tagNumber, or the default value if it is not set.
inherited
getFieldOrNull(int tagNumber) → dynamic
Returns the value of a field, ignoring any defaults.
inherited
getTagNumber(String fieldName) → int?
inherited
hasApprovalMetadata() → bool
hasBgColor() → bool
hasCode() → bool
hasDescription() → bool
hasEntityUuid() → bool
hasExtension(Extension extension) → bool
Returns true if a value of extension is present.
inherited
hasFgColor() → bool
hasField(int tagNumber) → bool
Whether this message has a field associated with tagNumber.
inherited
hasIsLeaf() → bool
hasMetadata() → bool
hasName() → bool
hasParentActionCodeId() → bool
hasRequiredFields() → bool
Whether the message has required fields.
inherited
hasStatus() → bool
isInitialized() → bool
Whether all required fields in the message and embedded messages are set.
inherited
mergeFromBuffer(List<int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges serialized protocol buffer data into this message.
inherited
mergeFromCodedBufferReader(CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Same as mergeFromBuffer, but takes a CodedBufferReader input.
inherited
mergeFromJson(String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from data, a JSON object, encoded as described by GeneratedMessage.writeToJson.
inherited
mergeFromJsonMap(Map<String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from a JSON object represented as a Dart map.
inherited
mergeFromMessage(GeneratedMessage other) → void
Merges the contents of the other into this message.
inherited
mergeFromProto3Json(Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void
Merges field values from json, a JSON object using proto3 encoding.
inherited
mergeUnknownFields(UnknownFieldSet unknownFieldSet) → void
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(void updates(T)) → T

Available on T, provided by the GeneratedMessageGenericExtensions extension

Apply updates to a copy of this message.
setExtension(Extension extension, Object value) → void
Sets the value of a non-repeated extension field to value.
inherited
setField(int tagNumber, Object value) → void
Sets the value of a field by its tagNumber.
inherited
toBuilder() → GeneratedMessage
Creates a writable, shallow copy of this message.
inherited
toDebugString() → String
Returns a String representation of this message.
inherited
toProto3Json({TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object?
Returns an Object representing Proto3 JSON serialization of this.
inherited
toString() → String
Returns a String representation of this message.
inherited
writeToBuffer() → Uint8List
Serialize the message as the protobuf binary format.
inherited
writeToCodedBufferWriter(CodedBufferWriter output) → void
Same as writeToBuffer, but serializes to the given CodedBufferWriter.
inherited
writeToJson() → String
Returns a JSON string that encodes this message.
inherited
writeToJsonMap() → Map<String, dynamic>
Returns the JSON encoding of this message as a Dart Map.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

create() → ActionCode
getDefault() → ActionCode