import Executable from 'devapt-core-common/js/base/executable.js'

public class | source

Executable

Extends:

Loggable → Errorable → Executable

Executable base class.

Constructor Summary

Public Constructor
public	constructor(arg_log_context: string \| undefined, arg_logger_manager: LoggerManager): nothing Create an Executable base class.

Member Summary

Public Members
public	is_executable: boolean Class type flag.

Private Members
private	_name: string This object name.

Method Summary

Public Methods
public abstract	exec_ack(): nothing On execution success (todo).
public abstract	exec_fail(): nothing On execution failure (todo).
public abstract	execute(arg_data: object): object Execution with contextual informations.
public abstract	finish(): nothing Finish (todo).
public abstract	prepare(arg_settings: object): nothing Prepare an execution with contextual informations.

Inherited Summary

From class Loggable
public	$context: string Log context.
public	is_loggable: boolean Class type flag.
public	is_trace_enabled: boolean Trace is enabled for this flag.
private	_logger_manager: LoggerManager Logger manager instance (default undefined)
public	debug(args: string \| array): nothing Trace DEBUG formatted message.
public	disable_trace(): nothing Disable traces.
public	enable_trace(): nothing Enable traces.
public	enter_group(arg_group: string): nothing Trace INFO message on "enter trace group".
public	error(args: string \| array): nothing Trace ERROR formatted message.
public	get_class(): string Define get class name method for non Instance classes.
public	get_context(): string Get instance context.
public	get_logger_manager(): LoggerManager Get logger manager.
public	get_name(): string Define get instance name method for non Instance classes.
public	get_trace(): boolean Get trace flag.
public	info(args: string \| array): nothing Trace INFO formatted message.
public	leave_group(arg_group: string): nothing Trace INFO message on "leave trace group".
public	separate_level_1(): nothing Trace INFO trace level 1 separator.
public	separate_level_2(): nothing Trace INFO trace level 2 separator.
public	separate_level_3(): nothing Trace INFO trace level 3 separator.
public	set_trace(arg_value: boolean): nothing Set trace flag.
public	should_trace(arg_traces_cfg: object): boolean Calculate should trace flag.
public	should_trace_class(arg_traces_cfg: object): boolean Calculate should trace flag for classes.
public	should_trace_collection_item(arg_traces_cfg: object, arg_collection_name: string, arg_this_item_accessor: string): boolean Calculate should trace flag for given collection of names or patterns.
public	should_trace_module(arg_traces_cfg: object): boolean Calculate should trace flag for modules.
public	should_trace_name(arg_traces_cfg: object): boolean Calculate should trace flag for instances names.
public	toggle_trace(): boolean Toggle trace flag.
public	update_trace_enabled(): nothing Update trace enabled flag.
public	warn(args: string \| array): nothing Trace WARN formatted message.

From class Errorable
private	_error_msg: string Error text (default null).
private	_has_error: boolean Has error flag (default false).
public	error(arg_msg: string): nothing Set an error.
public	error_not_implemented() Default helper for "not implemented" error.
public	get_error_msg(): string Get error message.
public	has_error(): boolean Test is an error is set.

Public Constructors

public constructor(arg_log_context: string | undefined, arg_logger_manager: LoggerManager): nothing source

Create an Executable base class.

Override:

Errorable#constructor

Params:

Name	Type	Attribute	Description
arg_log_context	string \| undefined		(optional).
arg_logger_manager	LoggerManager		logger manager object (optional).

Return:

nothing

Public Members

public is_executable: boolean source

Class type flag.

Private Members

private _name: string source

This object name.

Public Methods

public abstract exec_ack(): nothing source

On execution success (todo).

Return:

nothing

public abstract exec_fail(): nothing source

On execution failure (todo).

Return:

nothing

public abstract execute(arg_data: object): object source

Execution with contextual informations.

Params:

Name	Type	Attribute	Description
arg_data	object		execution datas.

Return:

object

promise

public abstract finish(): nothing source

Finish (todo).

Return:

nothing

public abstract prepare(arg_settings: object): nothing source

Prepare an execution with contextual informations.

Params:

Name	Type	Attribute	Description
arg_settings	object		execution settings.

Return:

nothing