VEGAS JS

Class: ObjectDefinitionContainer

system.ioc. ObjectDefinitionContainer

new ObjectDefinitionContainer()

Creates a container to register all the Object define by the corresponding ObjectDefinition objects.

Extends

Members

<constant> changeIt :system.signals.Signal

The signal emit when the task is changed.

Type:
Inherited From:

<constant> clearIt :system.signals.Signal

The signal emit when the task is cleared.

Type:
Inherited From:

<constant> finishIt :system.signals.Signal

This signal emit when the action is finished.

Type:
Inherited From:

<constant> infoIt :system.signals.Signal

The signal emit when the task emit a message.

Type:
Inherited From:

looping :boolean

The flag to determinate if the task must be looped.

Type:
  • boolean
Inherited From:
Default Value:
  • false

<constant> loopIt :system.signals.Signal

The signal emit when the task is looped.

Type:
Inherited From:

<readonly> numObjectDefinition

Indicates the numbers of object definitions registered in the container.

<constant> pauseIt :system.signals.Signal

The signal emit when the task is paused.

Type:
Inherited From:

<readonly> phase :string

Indicates the current phase.

Type:
  • string
Inherited From:
See:

<constant> progressIt :system.signals.Signal

The signal emit when the task is in progress.

Type:
Inherited From:

<constant> resumeIt :system.signals.Signal

The signal emit when the task is resumed.

Type:
Inherited From:

<readonly> running :boolean

Indicates action is running.

Type:
  • boolean
Inherited From:

<constant> startIt :system.signals.Signal

This signal emit when the action is started.

Type:
Inherited From:

<constant> stopIt :system.signals.Signal

This signal emit when the task is stopped.

Type:
Inherited From:

<constant> timeoutIt :system.signals.Signal

The signal emit when the task is out of time.

Type:
Inherited From:

Methods

addObjectDefinition(definition)

Registers a new object definition in the container.

Parameters:
Name Type Description
definition

The Identifiable ObjectDefinition reference to register in the container.
Throws:

ArgumentError If the specified object definition is null or if this id attribut is null.

clearObjectDefinition()

Removes all the object definitions register in the container.

clone()

Returns a shallow copy of this object.

Overrides:
Returns:

a shallow copy of this object.

getObjectDefinition(id)

Returns the ObjectDefinition object register in the container with the specified id.

Parameters:
Name Type Description
id string

The id name of the ObjectDefinition to return.
Throws:

ArgumentError If the specified object definition don't exist in the container.

Returns:

the ObjectDefinition object register in the container with the specified id.

hasObjectDefinition(id)

Returns true if the object defines with the specified id is register in the container.

Parameters:
Name Type Description
id string

The id of the ObjectDefinition to search.
Returns:

true if the object defines with the specified id is register in the container.

isLocked()

Returns true if the object is locked.

Inherited From:
Implements:
Returns:

true if the object is locked.

lock()

Locks the object.

Inherited From:
Implements:

notifyChanged()

Notify when the process is changed.

Inherited From:

notifyCleared()

Notify when the process is cleared.

Inherited From:

notifyFinished()

Notify when the process is finished.

Inherited From:

notifyInfo()

Notify a specific information when the process is changed.

Inherited From:

notifyLooped()

Notify when the process is looped.

Inherited From:

notifyPaused()

Notify when the process is paused.

Inherited From:

notifyProgress()

Notify when the process is progress.

Inherited From:

notifyResumed()

Notify when the process is resumed.

Inherited From:

notifyStarted()

Notify when the process is started.

Inherited From:

notifyStopped()

Notify when the process is stopped.

Inherited From:

notifyTimeout()

Notify when the process is out of time.

Inherited From:

removeObjectDefinition(id)

Unregisters an object definition in the container.

Parameters:
Name Type Description
id

The id of the object definition to remove.
Throws:

ArgumentError If the specified object definition don't exist in the container.

reset()

Resets the task.

Inherited From:
Implements:

resume()

Resumes the task.

Inherited From:

run()

Run the command.

Inherited From:

start()

Starts the task.

Inherited From:
Implements:

stop()

Starts the process.

Inherited From:
Implements:

unlock()

Unlocks the object.

Inherited From:
Implements: