Packageat.containers
Classpublic class PreCallBase
InheritancePreCallBase Inheritance mx.containers.VBox
SubclassesPreCallModule

The PreCallBase is the basis for the PreCallModule.

The component handles most of the data parsing and retrieval for the PreCallModule. It also handles the saving of the data for calls manipulated in the PreCallModule back into the database.

See also

at.modules.PreCallModule


Public Properties
 PropertyDefined by
  allChangesCommitted : Boolean
[read-only] Value will be false if any bookmarks or Call items have been changed but not yet committed to the database.
PreCallBase
  bookmarkChangesCommitted : Boolean
[read-only] Returns false if any bookmark items have been changed but the items have not yet been committed to the database, otherwise true
PreCallBase
  brandID : int
[read-only] The current brand id.
PreCallBase
  callChangesCommitted : Boolean
[read-only] Returns false if a change has been made to any call slides but not yet committed to the database, otherwise true.
PreCallBase
  callID : int
Returns the id of the current call
PreCallBase
  clearCurrentBookmarkComponent : UIComponent
Returns the currently specified UIComponent for the clearCurrentBookmark() method.
PreCallBase
  clearCurrentCallAndBookmarkComponent : UIComponent
Returns the currently specified UIComponent for the clearCurrentCallAndBookmark() method.
PreCallBase
  clearCurrentCallComponent : UIComponent
Returns the currently specified UIComponent for the clearCurrentCall() method.
PreCallBase
  control : PreCallControl
Control contains routine helper functions and helper events for saving, reseting and clearing items in the PreCallModule.
PreCallBase
  currentBookmark : XML
[read-only] The current bookmark in the currently selected call.
PreCallBase
  currentBookmarkEditable : Boolean
[read-only] Value is true if the current bookmark is editable.
PreCallBase
  currentBookmarkItems : XMLList
The list of items belonging to the current bookmark.
PreCallBase
  currentBookmarks : XML
[read-only] The bookmarks belonging to the all of the calls in the current indication.
PreCallBase
  currentBrandID : int
[read-only] The id of the current Brand.
PreCallBase
  currentBrandTitle : String
[read-only] The title of the current Brand.
PreCallBase
  currentCall : XMLList
The current call in the component.
PreCallBase
  currentCallEditable : Boolean
[read-only] Determines if the current call is editible (true) or not.
PreCallBase
  currentCallID : int
[read-only] The id of the current call.
PreCallBase
  currentCallIndex : int
The index of the current call of the current indication.
PreCallBase
  currentCalls : XMLList
[read-only] All calls for the current indication.
PreCallBase
  currentCallSlides : XMLList
The child slides of the current call.
PreCallBase
  currentCallTitle : String
[read-only] The title of the current call.
PreCallBase
  currentCallTitleAbbreviation : String
[read-only] The title abbreviation of the current call from the titleAbbr property.
PreCallBase
  currentIndicationID : int
[read-only] The id of the current indication.
PreCallBase
  currentIndicationSlides : XMLList
[read-only] All of the slides in the current indication.
PreCallBase
  currentIndicationTitle : String
[read-only] Returns the title of the current indication.
PreCallBase
  currentSection : XMLList
The currently selected Section.
PreCallBase
  currentSectionIndex : int
The index of the current Section within available in the current Indication.
PreCallBase
  currentSections : XMLList
[read-only] All of the sections in the current indication.
PreCallBase
  currentSectionSlideList : XMLList
[read-only] The slide list belonging to the current Section.
PreCallBase
  customCalls : XMLList
[read-only] All calls for the current indication having a type attribute value of custom.
PreCallBase
  debugMode : Boolean = false
Outputs useful information for debugging this component for developers when true.
PreCallBase
  defaultCallID : int
This is the default call that is loaded to edit if one is not specified.
PreCallBase
  defaultCalls : XMLList
[read-only] All calls for the current indication having a type attribute value of default.
PreCallBase
  indicationID : int
The current indication id.
PreCallBase
  renameCurrentCallComponent : UIComponent
Returns the currently specified UIComponent for the renameCurrentCall() method.
PreCallBase
  resetPrecallComponent : UIComponent
Returns the currently specified UIComponent for the resetPrecall() method.
PreCallBase
  saveAllComponent : UIComponent
Returns the currently specified UIComponent for the saveAll() method.
PreCallBase
  saveBookmarksComponent : UIComponent
Returns the currently specified UIComponent for the saveBookmarks() method.
PreCallBase
  saveCallsComponent : UIComponent
Returns the currently specified UIComponent for the saveCall() method.
PreCallBase
  saveCurrentCallAsQuickstartComponent : UIComponent
Returns the currently specified UIComponent for the saveCurrentCallAsQuickstart() method.
PreCallBase
Protected Properties
 PropertyDefined by
  callSyncPropertyChanges : DBUpdateChanges
The data that has changed in the database after a remote database synchronization.
PreCallBase
  overlayWindow : OverlayWindow
The window that pops up messages and the database commit progress.
PreCallBase
  progressBar : ProgressBar
The visual display of the progress of transactions occuring with the database.
PreCallBase
Public Methods
 MethodDefined by
  
Constructor.
PreCallBase
  
commitAllCalls():CallTransaction
Saves uncommitted [customized] calls in memory to the database on disk.
PreCallBase
  
commitBookmarks():BookmarkTransaction
Saves the bookmarks in memory to the database on disk.
PreCallBase
  
deleteBookmarkSlideByIndex(bookmark:XML, index:int):void
Removes the slide at the specfied index from the given boomark
PreCallBase
  
Deletes an bookmark from the current bookmark list at the index provided.
PreCallBase
  
Forces an update to internal currentCall bindable variable setting it's children to the current value of currentCallSlides.
PreCallBase
  
getAllBookmarks():XMLList
Returns a list of all bookmarks associated with an Indication.
PreCallBase
  
getAllCalls():XMLList
Returns all Calls for the current Indication.
PreCallBase
  
getBookmarkByCallID(callID:int):XML
Returns a bookmark associated with a Call based on the callID provided.
PreCallBase
  
getCall(callID:int):XML
Returns the Call of the current Indication based on the id provided.
PreCallBase
  
getCallChangesCommitted(queryDatabase:Boolean = false):Boolean
Returns false if a change has been made to any call slides but not yet committed to the database, otherwise true
PreCallBase
  
getCallChildren(callID:int):XMLList
Returns a list of slides from the specified call.
PreCallBase
  
Returns all bookmarks that have the type attribute set to custom.
PreCallBase
  
Returns all Calls that have the type attribute set to custom.
PreCallBase
  
Returns all bookmarks that have the type attribute set to default.
PreCallBase
  
getDefaultCalls():XMLList
Returns all Calls that have the type atribute set to default.
PreCallBase
  
getIndications(brandID:int):XMLList
The list of Indications belonging to a brand.
PreCallBase
  
getUncommittedBookmarks(queryDatabase:Boolean = false, byReference:Boolean = false):XMLListCollection
Returns a XMLListCollection of of bookmarks that have changed since last committed to the database.
PreCallBase
  
getUncommittedCalls(queryDatabase:Boolean = false):XMLListCollection
Returns a XMLListCollection of of calls that have changed since last committed to the database.
PreCallBase
  
handleCallValidationError(message:String, dispatchValidationResultEvent:Boolean = false):ValidationResult
Handles call validation errors.
PreCallBase
  
isCall(callID:int):Boolean
Ensures the specified callID is in the current indication's list of Calls
PreCallBase
  
isValidCall(callSlides:XMLList = null, optimized__returnsFirstErrorOnly:Boolean = true, dispatchValidationResultEvent:Boolean = false):ValidationResult
Checks the specified call slide list for proper Slide ordering and ensures the correct Slides are in the list.
PreCallBase
  
loadState(state:Object):void
PreCallBase
  
renameCall(callID:int, title:String = null, titleAbbreviation:String = null):Boolean
Changes the title and title abbreviation (titleAbbr in the database) to the corresponding values provided of the Call with the specified callID.
PreCallBase
  
reset():void
Reloads the PreCallModule with bookmarks and calls last saved to the database on disk.
PreCallBase
  
saveState():Object
PreCallBase
  
setBookmarkItems(bookmark:XML, items:XMLList):void
Sets all of bookmark data of the given bookmark
PreCallBase
  
setCurrentCallByID(callID:int):void
Sets the current Call to the Call with the id provided.
PreCallBase
  
setCurrentIndication(brandID:int, indicationID:int, onLoadComplete:Function = null, forceReload:Boolean = false):void
Sets the current indication for the pre-call module and updates all dataproviders.
PreCallBase
Protected Methods
 MethodDefined by
  
PreCallBase
  
Handles teh event when the bookmark changes.
PreCallBase
  
onCurrentCallChanged(e:Event):void
Handles teh event when the Call changes.
PreCallBase
  
Handles the event when the Indication changes.
PreCallBase
  
Handles the event when the Section changes.
PreCallBase
  
PreCallBase
  
PreCallBase
  
onProgress(e:ProgressEvent):void
Handles the progress of the commit to the database.
PreCallBase
  
onProgressComplete(e:Event):void
PreCallBase
  
saveAllClickHandler(e:Event):void
PreCallBase
  
saveCallsClickHandler(e:Event):void
PreCallBase
  
setCurrentCallIndex(index:int):void
Changes the current Call to the index provided.
PreCallBase
  
showProgressBar(source:Object, title:String = "Progress"):void
Shows the progressBar in an overlay window letting the user know the progress of the save to the database.
PreCallBase
Events
 EventSummaryDefined by
   PreCall control event dispatched before bookmarks are saved if they in fact do need to be saved.PreCallBase
   Dispatched when all of the current calls have been changed or loaded.PreCallBase
   PreCall control event dispatched when the Clearing of the currently selected call has completed.PreCallBase
   PreCall control event dispatched before calls are saved if they in fact do need to be saved.PreCallBase
   PreCall control event dispatched when the Clearing of the currently selected call has completed.PreCallBase
   PreCall control event dispatched when the clearing of the currently selected call and it's bookmarks has completed.PreCallBase
   PreCall control event dispatched when the clearing of the currently selected call's bookmarks has completed.PreCallBase
   PreCall control event dispatched when the clearing of the currently selected call has completed.PreCallBase
   Dispatched when the current bookmarks have changed.PreCallBase
   Dispatched when the current call has changed.PreCallBase
   Dispatched when the current indication has changed.PreCallBase
   Dispatched when the current section has changed.PreCallBase
   Dispatched when the default call has changed.PreCallBase
   PreCall control event dispatched when the Clearing of the currently selected call has completed.PreCallBase
   PreCall control event dispatched when PreCallControl.saveAll() is fired and PreCallBase
   PreCall control event dispatched when the Clearing of the currently selected call has completed.PreCallBase
   PreCall control event dispatched when the Clearing of the currently selected call has completed.PreCallBase
   PreCall control event dispatched when the Clearing of the currently selected call has completed.PreCallBase
   PreCall control event dispatched when saving all calls and bookmarks has completed.PreCallBase
   PreCall control event dispatched when saving all bookmarks has completed.PreCallBase
   PreCall control event dispatched when saving all calls has completed.PreCallBase
   PreCall control event dispatched when the Clearing of the currently selected call has completed.PreCallBase
   PreCall control event dispatched when the Clearing of the currently selected call has completed.PreCallBase
Styles
 StyleDescriptionDefined by
  
overlayWindowStyleName
Type: String   CSS Inheritance: no
The styleName of the TitleWindow component that is popped up when the progress bar or Alert is displayed. The default value is "overlayWindowStyle".
PreCallBase
  
overlayWindowTitleStyleName
Type: String   CSS Inheritance: no
The titleStyleName property of the overlayWindowStyleName for the TitleWindow component that is popped up when the progress bar or Alert is displayed. The default value is "overlayWindowTitleStyle".
PreCallBase
  
progressBarStyleName
Type: String   CSS Inheritance: no
The styleName of the ProgressBar component that is displayed during database saves. The default value is "progressBarStyle".
PreCallBase
Property detail
allChangesCommittedproperty
allChangesCommitted:Boolean  [read-only]

Value will be false if any bookmarks or Call items have been changed but not yet committed to the database.

Implementation
    public function get allChangesCommitted():Boolean
bookmarkChangesCommittedproperty 
bookmarkChangesCommitted:Boolean  [read-only]

Returns false if any bookmark items have been changed but the items have not yet been committed to the database, otherwise true

Implementation
    public function get bookmarkChangesCommitted():Boolean
brandIDproperty 
brandID:int  [read-only]

The current brand id. To set the brandID, call the setCurrentIndication() method along with the brand's indicationID.

This property can be used as the source for data binding.

Implementation
    public function get brandID():int
callChangesCommittedproperty 
callChangesCommitted:Boolean  [read-only]

Returns false if a change has been made to any call slides but not yet committed to the database, otherwise true. This method checks against a copy in memory of the last database change for performance reasons. If checking against the database is desired, use the getCallChangesCommitted method with the queryDatabase parameter set to true.

Implementation
    public function get callChangesCommitted():Boolean
callIDproperty 
callID:int  [read-write]

Returns the id of the current call

Implementation
    public function get callID():int
    public function set callID(value:int):void
callSyncPropertyChangesproperty 
callSyncPropertyChanges:DBUpdateChanges  [read-write]

The data that has changed in the database after a remote database synchronization.

Implementation
    protected function get callSyncPropertyChanges():DBUpdateChanges
    protected function set callSyncPropertyChanges(value:DBUpdateChanges):void

See also

at.data.DBUpdateChanges
clearCurrentBookmarkComponentproperty 
clearCurrentBookmarkComponent:UIComponent  [read-write]

Returns the currently specified UIComponent for the clearCurrentBookmark() method.

Implementation
    public function get clearCurrentBookmarkComponent():UIComponent
    public function set clearCurrentBookmarkComponent(value:UIComponent):void
clearCurrentCallAndBookmarkComponentproperty 
clearCurrentCallAndBookmarkComponent:UIComponent  [read-write]

Returns the currently specified UIComponent for the clearCurrentCallAndBookmark() method.

Implementation
    public function get clearCurrentCallAndBookmarkComponent():UIComponent
    public function set clearCurrentCallAndBookmarkComponent(value:UIComponent):void
clearCurrentCallComponentproperty 
clearCurrentCallComponent:UIComponent  [read-write]

Returns the currently specified UIComponent for the clearCurrentCall() method.

Implementation
    public function get clearCurrentCallComponent():UIComponent
    public function set clearCurrentCallComponent(value:UIComponent):void
controlproperty 
public var control:PreCallControl

Control contains routine helper functions and helper events for saving, reseting and clearing items in the PreCallModule.

This property can be used as the source for data binding.

See also

currentBookmarkproperty 
currentBookmark:XML  [read-only]

The current bookmark in the currently selected call.

This property can be used as the source for data binding.

Implementation
    public function get currentBookmark():XML
currentBookmarkEditableproperty 
currentBookmarkEditable:Boolean  [read-only]

Value is true if the current bookmark is editable.

This property can be used as the source for data binding.

Implementation
    public function get currentBookmarkEditable():Boolean
currentBookmarkItemsproperty 
currentBookmarkItems:XMLList  [read-write]

The list of items belonging to the current bookmark.

This property can be used as the source for data binding.

Implementation
    public function get currentBookmarkItems():XMLList
    public function set currentBookmarkItems(value:XMLList):void
currentBookmarksproperty 
currentBookmarks:XML  [read-only]

The bookmarks belonging to the all of the calls in the current indication.

This property can be used as the source for data binding.

Implementation
    public function get currentBookmarks():XML
currentBrandIDproperty 
currentBrandID:int  [read-only]

The id of the current Brand.

This property can be used as the source for data binding.

Implementation
    public function get currentBrandID():int
currentBrandTitleproperty 
currentBrandTitle:String  [read-only]

The title of the current Brand.

This property can be used as the source for data binding.

Implementation
    public function get currentBrandTitle():String
currentCallproperty 
currentCall:XMLList  [read-write]

The current call in the component.

This property can be used as the source for data binding.

Implementation
    public function get currentCall():XMLList
    public function set currentCall(value:XMLList):void
currentCallEditableproperty 
currentCallEditable:Boolean  [read-only]

Determines if the current call is editible (true) or not.

This property can be used as the source for data binding.

Implementation
    public function get currentCallEditable():Boolean
currentCallIDproperty 
currentCallID:int  [read-only]

The id of the current call.

This property can be used as the source for data binding.

Implementation
    public function get currentCallID():int
currentCallIndexproperty 
currentCallIndex:int  [read-write]

The index of the current call of the current indication.

The index is based on all calls for the indication regardless of it's type.

This property can be used as the source for data binding.

Implementation
    public function get currentCallIndex():int
    public function set currentCallIndex(value:int):void
currentCallsproperty 
currentCalls:XMLList  [read-only]

All calls for the current indication.

This property can be used as the source for data binding.

Implementation
    public function get currentCalls():XMLList
currentCallSlidesproperty 
currentCallSlides:XMLList  [read-write]

The child slides of the current call.

This property can be used as the source for data binding.

Implementation
    public function get currentCallSlides():XMLList
    public function set currentCallSlides(value:XMLList):void
currentCallTitleproperty 
currentCallTitle:String  [read-only]

The title of the current call.

This property can be used as the source for data binding.

Implementation
    public function get currentCallTitle():String
currentCallTitleAbbreviationproperty 
currentCallTitleAbbreviation:String  [read-only]

The title abbreviation of the current call from the titleAbbr property.

This property can be used as the source for data binding.

Implementation
    public function get currentCallTitleAbbreviation():String
currentIndicationIDproperty 
currentIndicationID:int  [read-only]

The id of the current indication.

This property can be used as the source for data binding.

Implementation
    public function get currentIndicationID():int
currentIndicationSlidesproperty 
currentIndicationSlides:XMLList  [read-only]

All of the slides in the current indication.

This property can be used as the source for data binding.

Implementation
    public function get currentIndicationSlides():XMLList
currentIndicationTitleproperty 
currentIndicationTitle:String  [read-only]

Returns the title of the current indication.

This property can be used as the source for data binding.

Implementation
    public function get currentIndicationTitle():String
currentSectionproperty 
currentSection:XMLList  [read-write]

The currently selected Section.

This property can be used as the source for data binding.

Implementation
    public function get currentSection():XMLList
    public function set currentSection(value:XMLList):void
currentSectionIndexproperty 
currentSectionIndex:int  [read-write]

The index of the current Section within available in the current Indication.

This property can be used as the source for data binding.

Implementation
    public function get currentSectionIndex():int
    public function set currentSectionIndex(value:int):void
currentSectionsproperty 
currentSections:XMLList  [read-only]

All of the sections in the current indication.

This property can be used as the source for data binding.

Implementation
    public function get currentSections():XMLList
currentSectionSlideListproperty 
currentSectionSlideList:XMLList  [read-only]

The slide list belonging to the current Section.

This property can be used as the source for data binding.

Implementation
    public function get currentSectionSlideList():XMLList
customCallsproperty 
customCalls:XMLList  [read-only]

All calls for the current indication having a type attribute value of custom.

This property can be used as the source for data binding.

Implementation
    public function get customCalls():XMLList
debugModeproperty 
public var debugMode:Boolean = false

Outputs useful information for debugging this component for developers when true.

The output is typically in the form of trace statements and Alerts.

The default value is false.

defaultCallIDproperty 
defaultCallID:int  [read-write]

This is the default call that is loaded to edit if one is not specified.

This is the "Quick Start" call id that will be loaded first in the PresentationModule.

This property can be used as the source for data binding.

Implementation
    public function get defaultCallID():int
    public function set defaultCallID(value:int):void

See also

defaultCallsproperty 
defaultCalls:XMLList  [read-only]

All calls for the current indication having a type attribute value of default.

This property can be used as the source for data binding.

Implementation
    public function get defaultCalls():XMLList
indicationIDproperty 
indicationID:int  [read-write]

The current indication id. To set the indicationID, call the setCurrentIndication() method.

This property can be used as the source for data binding.

Implementation
    public function get indicationID():int
    public function set indicationID(value:int):void
overlayWindowproperty 
protected var overlayWindow:OverlayWindow

The window that pops up messages and the database commit progress.

progressBarproperty 
protected var progressBar:ProgressBar

The visual display of the progress of transactions occuring with the database.

renameCurrentCallComponentproperty 
renameCurrentCallComponent:UIComponent  [read-write]

Returns the currently specified UIComponent for the renameCurrentCall() method.

Implementation
    public function get renameCurrentCallComponent():UIComponent
    public function set renameCurrentCallComponent(value:UIComponent):void
resetPrecallComponentproperty 
resetPrecallComponent:UIComponent  [read-write]

Returns the currently specified UIComponent for the resetPrecall() method.

Implementation
    public function get resetPrecallComponent():UIComponent
    public function set resetPrecallComponent(value:UIComponent):void
saveAllComponentproperty 
saveAllComponent:UIComponent  [read-write]

Returns the currently specified UIComponent for the saveAll() method.

Implementation
    public function get saveAllComponent():UIComponent
    public function set saveAllComponent(value:UIComponent):void
saveBookmarksComponentproperty 
saveBookmarksComponent:UIComponent  [read-write]

Returns the currently specified UIComponent for the saveBookmarks() method.

Implementation
    public function get saveBookmarksComponent():UIComponent
    public function set saveBookmarksComponent(value:UIComponent):void
saveCallsComponentproperty 
saveCallsComponent:UIComponent  [read-write]

Returns the currently specified UIComponent for the saveCall() method.

Implementation
    public function get saveCallsComponent():UIComponent
    public function set saveCallsComponent(value:UIComponent):void
saveCurrentCallAsQuickstartComponentproperty 
saveCurrentCallAsQuickstartComponent:UIComponent  [read-write]

Returns the currently specified UIComponent for the saveCurrentCallAsQuickstart() method.

Implementation
    public function get saveCurrentCallAsQuickstartComponent():UIComponent
    public function set saveCurrentCallAsQuickstartComponent(value:UIComponent):void
Constructor detail
PreCallBase()constructor
public function PreCallBase()

Constructor.

Method detail
attachController()method
protected function attachController():void

commitAllCalls()method 
public function commitAllCalls():CallTransaction

Saves uncommitted [customized] calls in memory to the database on disk.

Returns
CallTransaction — The result of the commit method being run
commitBookmarks()method 
public function commitBookmarks():BookmarkTransaction

Saves the bookmarks in memory to the database on disk.

Returns
BookmarkTransaction — The result of the bookmark save
deleteBookmarkSlideByIndex()method 
public function deleteBookmarkSlideByIndex(bookmark:XML, index:int):void

Removes the slide at the specfied index from the given boomark

Parameters
bookmark:XML
 
index:int
deleteCurrentBookmarkSlideByIndex()method 
public function deleteCurrentBookmarkSlideByIndex(index:int):void

Deletes an bookmark from the current bookmark list at the index provided.

Parameters
index:int — index of the bookmark to remove
forceSynchronizeCurrentCallSlidesWithCurrentCall()method 
public function forceSynchronizeCurrentCallSlidesWithCurrentCall():void

Forces an update to internal currentCall bindable variable setting it's children to the current value of currentCallSlides.

getAllBookmarks()method 
public function getAllBookmarks():XMLList

Returns a list of all bookmarks associated with an Indication.

Returns
XMLList — The list of bookmarks for each Call in an Indication
getAllCalls()method 
public function getAllCalls():XMLList

Returns all Calls for the current Indication.

Returns
XMLList — The list of Calls
getBookmarkByCallID()method 
public function getBookmarkByCallID(callID:int):XML

Returns a bookmark associated with a Call based on the callID provided.

Parameters
callID:int

Returns
XML — The bookmark XML node
getCall()method 
public function getCall(callID:int):XML

Returns the Call of the current Indication based on the id provided.

Parameters
callID:int

Returns
XML — The Call XML
getCallChangesCommitted()method 
public function getCallChangesCommitted(queryDatabase:Boolean = false):Boolean

Returns false if a change has been made to any call slides but not yet committed to the database, otherwise true

Parameters
queryDatabase:Boolean (default = false)

Returns
Boolean
getCallChildren()method 
public function getCallChildren(callID:int):XMLList

Returns a list of slides from the specified call.

Parameters
callID:int — The id of the call to get slides for

Returns
XMLList — List of slides in XMLList format
getCustomizedBookmarks()method 
public function getCustomizedBookmarks():XMLList

Returns all bookmarks that have the type attribute set to custom.

Returns
XMLList — The list of custom bookmarks
getCustomizedCalls()method 
public function getCustomizedCalls():XMLList

Returns all Calls that have the type attribute set to custom.

Returns
XMLList — The custom Call list
getDefaultBookmarks()method 
public function getDefaultBookmarks():XMLList

Returns all bookmarks that have the type attribute set to default.

Returns
XMLList — The list of default bookmarks
getDefaultCalls()method 
public function getDefaultCalls():XMLList

Returns all Calls that have the type atribute set to default.

Returns
XMLList — The list of default Calls
getIndications()method 
public function getIndications(brandID:int):XMLList

The list of Indications belonging to a brand.

Parameters
brandID:int — The id to get a list of indications for

Returns
XMLList — The list of indications
getUncommittedBookmarks()method 
public function getUncommittedBookmarks(queryDatabase:Boolean = false, byReference:Boolean = false):XMLListCollection

Returns a XMLListCollection of of bookmarks that have changed since last committed to the database.

Parameters
queryDatabase:Boolean (default = false) — Gets the list of bookmars from the database if true otherwise it uses the existing data.
 
byReference:Boolean (default = false) — If set to true, referenced data will be used, otherwise a copy will be used.

Returns
XMLListCollection — The list of uncommitted bookmarks
getUncommittedCalls()method 
public function getUncommittedCalls(queryDatabase:Boolean = false):XMLListCollection

Returns a XMLListCollection of of calls that have changed since last committed to the database.

Parameters
queryDatabase:Boolean (default = false)

Returns
XMLListCollection
handleCallValidationError()method 
public function handleCallValidationError(message:String, dispatchValidationResultEvent:Boolean = false):ValidationResult

Handles call validation errors.

Parameters
message:String
 
dispatchValidationResultEvent:Boolean (default = false)

Returns
ValidationResult
isCall()method 
public function isCall(callID:int):Boolean

Ensures the specified callID is in the current indication's list of Calls

Parameters
callID:int

Returns
Boolean
isValidCall()method 
public function isValidCall(callSlides:XMLList = null, optimized__returnsFirstErrorOnly:Boolean = true, dispatchValidationResultEvent:Boolean = false):ValidationResult

Checks the specified call slide list for proper Slide ordering and ensures the correct Slides are in the list.

This is a quick check to be sure that no business rules have been violated for the slides provided.

Parameters
callSlides:XMLList (default = null) — The list of slides to validate
 
optimized__returnsFirstErrorOnly:Boolean (default = true)
 
dispatchValidationResultEvent:Boolean (default = false)

Returns
ValidationResult
loadState()method 
public function loadState(state:Object):voidParameters
state:Object
onCurrentBookmarkChanged()method 
protected function onCurrentBookmarkChanged(e:Event):void

Handles teh event when the bookmark changes.

Parameters
e:Event
onCurrentCallChanged()method 
protected function onCurrentCallChanged(e:Event):void

Handles teh event when the Call changes.

Parameters
e:Event
onCurrentIndicationChanged()method 
protected function onCurrentIndicationChanged(e:Event):void

Handles the event when the Indication changes.

Parameters
e:Event
onCurrentSectionChanged()method 
protected function onCurrentSectionChanged(e:Event):void

Handles the event when the Section changes.

Parameters
e:Event
onCustomizedBookmarksComplete()method 
protected function onCustomizedBookmarksComplete(e:Event):void

Parameters
e:Event
onCustomizedCallsComplete()method 
protected function onCustomizedCallsComplete(e:Event):void

Parameters
e:Event
onProgress()method 
protected function onProgress(e:ProgressEvent):void

Handles the progress of the commit to the database.

This will only trace data if debugMode is true.

Parameters
e:ProgressEvent — The progress event
onProgressComplete()method 
protected function onProgressComplete(e:Event):void

Parameters
e:Event
renameCall()method 
public function renameCall(callID:int, title:String = null, titleAbbreviation:String = null):Boolean

Changes the title and title abbreviation (titleAbbr in the database) to the corresponding values provided of the Call with the specified callID.

Parameters
callID:int — The id of the Call to change
 
title:String (default = null) — The new title
 
titleAbbreviation:String (default = null) — The new abbreviation of the title

Returns
Boolean — Returns true on success
reset()method 
public function reset():void

Reloads the PreCallModule with bookmarks and calls last saved to the database on disk.

saveAllClickHandler()method 
protected function saveAllClickHandler(e:Event):voidParameters
e:Event
saveCallsClickHandler()method 
protected function saveCallsClickHandler(e:Event):voidParameters
e:Event
saveState()method 
public function saveState():Object

Returns
Object
setBookmarkItems()method 
public function setBookmarkItems(bookmark:XML, items:XMLList):void

Sets all of bookmark data of the given bookmark

Parameters
bookmark:XML
 
items:XMLList
setCurrentCallByID()method 
public function setCurrentCallByID(callID:int):void

Sets the current Call to the Call with the id provided.

Parameters
callID:int — The Call id
setCurrentCallIndex()method 
protected function setCurrentCallIndex(index:int):void

Changes the current Call to the index provided.

Parameters
index:int — The Call index
setCurrentIndication()method 
public function setCurrentIndication(brandID:int, indicationID:int, onLoadComplete:Function = null, forceReload:Boolean = false):void

Sets the current indication for the pre-call module and updates all dataproviders.

Parameters
brandID:int — The database unique identifier for the brand
 
indicationID:int — The database unique identifier for the indication
 
onLoadComplete:Function (default = null) — The function that is called once data is loaded
 
forceReload:Boolean (default = false) — Setting to true forces reloading of the indication data from the database even if the indicationID and brandID haven't changed
showProgressBar()method 
protected function showProgressBar(source:Object, title:String = "Progress"):void

Shows the progressBar in an overlay window letting the user know the progress of the save to the database.

Parameters
source:Object — The source object
 
title:String (default = "Progress") — The title of the window
Event detail
bookmarksNotSavedevent 
Event object type: at.events.PreCallControlEvent

PreCall control event dispatched before bookmarks are saved if they in fact do need to be saved.

callDataChangedevent  
Event object type: at.events.PreCallModuleEvent
PreCallModuleEvent.type property = at.events.PreCallModuleEvent.CALL_DATA_CHANGED

Dispatched when all of the current calls have been changed or loaded.

Dispatched when all of the call data has been changed.

callRenamedCompleteevent  
Event object type: at.events.PreCallControlEvent

PreCall control event dispatched when the Clearing of the currently selected call has completed.

callsNotSavedevent  
Event object type: at.events.PreCallControlEvent

PreCall control event dispatched before calls are saved if they in fact do need to be saved.

cancelCompleteevent  
Event object type: at.events.PreCallControlEvent

PreCall control event dispatched when the Clearing of the currently selected call has completed.

clearAllCompleteevent  
Event object type: at.events.PreCallControlEvent

PreCall control event dispatched when the clearing of the currently selected call and it's bookmarks has completed.

clearBookmarkCompleteevent  
Event object type: at.events.PreCallControlEvent

PreCall control event dispatched when the clearing of the currently selected call's bookmarks has completed.

clearCallCompleteevent  
Event object type: at.events.PreCallControlEvent

PreCall control event dispatched when the clearing of the currently selected call has completed.

currentBookmarkChangedevent  
Event object type: at.events.PreCallModuleEvent
PreCallModuleEvent.type property = at.events.PreCallModuleEvent.CURRENT_BOOKMARK_CHANGED

Dispatched when the current bookmarks have changed.

Dispatched when the current bookmark set has changed.

currentCallChangedevent  
Event object type: at.events.PreCallModuleEvent
PreCallModuleEvent.type property = at.events.PreCallModuleEvent.CURRENT_CALL_CHANGED

Dispatched when the current call has changed.

Dispatched when the currently selected call has changed.

currentIndicationChangedevent  
Event object type: at.events.PreCallModuleEvent
PreCallModuleEvent.type property = at.events.PreCallModuleEvent.CURRENT_INDICATION_CHANGED

Dispatched when the current indication has changed.

Dispatched when the current indication of the PreCallModule has changed.

currentSectionChangedevent  
Event object type: at.events.PreCallModuleEvent
PreCallModuleEvent.type property = at.events.PreCallModuleEvent.CURRENT_SECTION_CHANGED

Dispatched when the current section has changed.

Dispatched when the current section of slides has changed.

defaultCallChangedevent  
Event object type: at.events.PreCallModuleEvent
PreCallModuleEvent.type property = at.events.PreCallModuleEvent.DEFAULT_CALL_CHANGED

Dispatched when the default call has changed.

Dispatched when the default call has changed.

exitCompleteevent  
Event object type: at.events.PreCallControlEvent

PreCall control event dispatched when the Clearing of the currently selected call has completed.

needsSaveAllevent  
Event object type: at.events.PreCallControlEvent

PreCall control event dispatched when PreCallControl.saveAll() is fired and

needsSaveBookmarkevent  
Event object type: at.events.PreCallControlEvent

PreCall control event dispatched when the Clearing of the currently selected call has completed.

needsSaveCallevent  
Event object type: at.events.PreCallControlEvent

PreCall control event dispatched when the Clearing of the currently selected call has completed.

resetCompleteevent  
Event object type: at.events.PreCallControlEvent

PreCall control event dispatched when the Clearing of the currently selected call has completed.

saveAllCompleteevent  
Event object type: at.events.PreCallControlEvent

PreCall control event dispatched when saving all calls and bookmarks has completed.

saveBookmarksCompleteevent  
Event object type: at.events.PreCallControlEvent

PreCall control event dispatched when saving all bookmarks has completed.

saveCallsCompleteevent  
Event object type: at.events.PreCallControlEvent

PreCall control event dispatched when saving all calls has completed.

saveQuickstartCompleteevent  
Event object type: at.events.PreCallControlEvent

PreCall control event dispatched when the Clearing of the currently selected call has completed.

startCallCompleteevent  
Event object type: at.events.PreCallControlEvent

PreCall control event dispatched when the Clearing of the currently selected call has completed.