Skip to main content
Pentaho Documentation

RejectedChange

pentaho.type.events.RejectedChange

This event is emitted when changes in complex or list values are rejected.

Extends

Mixes In

Constructor

Name Description
new RejectedChange(source, changeset, error)

Creates a RejectedChange event.

Members

Name Description
cancelReason : Error

Gets the reason why the event was canceled, if any, or null.

changeset : pentaho.type.changes.Changeset

Gets the object that describes the set of changes.

error : Error | pentaho.lang.UserError

Gets the error that caused the ActionResult to be rejected.

isCancelable : boolean

Gets a value that indicates if the event can be canceled.

isCanceled : boolean

Gets a value that indicates if the event has been canceled.

source : pentaho.lang.IEventSource

Gets the source of the event.

type : nonEmptyString

Gets the type of the event.

Methods

Name Description
_initChangeset(changeset)
 
Protected

Initializes the mixin.

_initError(errorObj)
 
Protected

Initializes the mixin.

cancel(reason)

Cancels the event.

clone() : pentaho.lang.Event

Creates a clone of the event object.

Constructor Details

new RejectedChange(source, changeset, error)

Creates a RejectedChange event.

Source: javascript/web/pentaho/type/events/RejectedChange.js, line 23

Parameters:
Name Default Value Summary
source : pentaho.type.Complex

The object which is emitting the event.

changeset : pentaho.type.changes.Changeset

The changeset.

error : Error | pentaho.lang.UserError

The error of a rejected ActionResult.

Members Details

cancelReason: Error

Gets the reason why the event was canceled, if any, or null.

Source: javascript/web/pentaho/lang/Event.js, line 116

Inherited From: pentaho.lang.Event#cancelReason

Mixes In:
changeset: pentaho.type.changes.Changeset

Gets the object that describes the set of changes.

Source: javascript/web/pentaho/type/mixins/_mixinChangeset.js, line 46

Mixes In:
error: Error | pentaho.lang.UserError

Gets the error that caused the ActionResult to be rejected.

Source: javascript/web/pentaho/type/mixins/mixinError.js, line 46

isCancelable: boolean

Gets a value that indicates if the event can be canceled.

Source: javascript/web/pentaho/lang/Event.js, line 106

Inherited From: pentaho.lang.Event#isCancelable

isCanceled: boolean

Gets a value that indicates if the event has been canceled.

Source: javascript/web/pentaho/lang/Event.js, line 152

Inherited From: pentaho.lang.Event#isCanceled

source: pentaho.lang.IEventSource

Gets the source of the event.

Source: javascript/web/pentaho/lang/Event.js, line 96

Inherited From: pentaho.lang.Event#source

type: nonEmptyString

Gets the type of the event.

Source: javascript/web/pentaho/lang/Event.js, line 86

Inherited From: pentaho.lang.Event#type

Methods Details

Mixes In:
_initChangeset(changeset)
 
Protected

Initializes the mixin.

Source: javascript/web/pentaho/type/mixins/_mixinChangeset.js, line 35

Parameters:
Name Default Value Summary
changeset : pentaho.type.changes.Changeset

An object that describes a set of changes.

Mixes In:
_initError(errorObj)
 
Protected

Initializes the mixin.

Source: javascript/web/pentaho/type/mixins/mixinError.js, line 35

Parameters:
Name Default Value Summary
errorObj : Error | pentaho.lang.UserError

The error of a rejected ActionResult.

cancel(reason)

Cancels the event.

This method has no effect if the event is not cancelable or has already been canceled.

Source: javascript/web/pentaho/lang/Event.js, line 131

Inherited From: pentaho.lang.Event#cancel

Parameters:
Name Default Value Summary
reason : string | Error
 
Optional
"canceled"

The reason why the event is being canceled.

See also:  pentaho.lang.Event#isCancelable , pentaho.lang.Event#isCanceled , pentaho.lang.Event#cancelReason

clone() : pentaho.lang.Event

Creates a clone of the event object.

Source: javascript/web/pentaho/lang/Event.js, line 161

Inherited From: pentaho.lang.Event#clone

Returns:
Name Description
pentaho.lang.Event

The cloned event object.