Packageat.data
Interfacepublic interface IDataInterface
ImplementorsDataInterface

This interface represents the methods used in the eVE DataInterface. Use this interface in your projects that require the eVE DataInterface in leiu of referencing the eVE Classes directly.


Example
 
  //once your component is loaded into the eVE Windowed Application
  var dataInterface:IDataInterface = IEveWindowed(Application.application).dataInterface;
  



Public Methods
 MethodDefined by
  
addEventListener(arg1:String, arg2:Function, arg3:Boolean = false, arg4:int = 0, arg5:Boolean = false):void
IDataInterface
  
dispatchEvent(arg1:Event):void
IDataInterface
  
getAllFromBrand(brandId:int):Array
Returns a single row from the Brand table.
IDataInterface
  
getAllFromCall(callId:int):Array
Returns a single row from the Call table.
IDataInterface
  
getAllFromIndication(indicationId:int):Array
Returns a single row from the Indication table.
IDataInterface
  
getBookmark(callID:int):XML
Returns the bookmark data in XML format for a single call
IDataInterface
  
getBookmarks(callID:int):XML
Returns the bookmark data in XML format for a single call
IDataInterface
  
getBrand(brandID:int, getCachedIfExists:Boolean = false):XML
Method for getting the data for a single brand from the data store with an id matching the brandID parameter.
IDataInterface
  
getBrandByIndicationID(indicationID:int, getCachedIfExists:Boolean = false):XML
Returns the brand of the specified indication.
IDataInterface
  
getBrands(getCachedIfExists:Boolean = false):XMLList
Method for getting all brands in the database.
IDataInterface
  
getBrandSlides(brandID:int, addDependencySlides:Boolean = false, getCachedIfExists:Boolean = false):XMLList
Returns an XMLList of all slides belonging to the specified brand.
IDataInterface
  
getCall(indicationID:int, addDependencySlides:Boolean = false, getCachedIfExists:Boolean = false):XML
Returns all calls belonging to an indication
IDataInterface
  
getCalls(indicationID:int, addDependencySlides:Boolean = false, getCachedIfExists:Boolean = false):XML
Returns all calls belonging to an indication
IDataInterface
  
getCallSectionData(callID:uint):XML
Returns XML with a childlist of section XML nodes of all sections represented by this call's slides.
IDataInterface
  
getIndication(indicationID:int, getCachedIfExists:Boolean = false):XML
Returns the data related to the specified indication in XML
IDataInterface
  
getIndicationByCallID(callID:int, getCachedIfExists:Boolean = false):XML
Returns the indication that a call belongs to.
IDataInterface
  
getIndications(brandID:int, getCachedIfExists:Boolean = false):XMLList
Returns the Indication data related to the specified Brand in an XMLList format.
IDataInterface
  
getIndicationSlideData(indicationID:int, getCachedIfExists:Boolean = false):XMLList
Returns an XMLList of all sections belonging to an indication each of which have a child list of slides that belong to the section (for the specified indication)
IDataInterface
  
getRepBag(indicationID:int, getCachedIfExists:Boolean = false):XMLList
Method for getting the rep bag data in XML format for an indication.
IDataInterface
  
removeEventListener(arg1:String, arg2:Function, arg3:Boolean = false):void
IDataInterface
  
updateCallTitleAttrib(callID:int, title:String, titleAbbr:String):void
Updates properties of the specified call.
IDataInterface
  
updateDefaultCallID(indicationID:int, callID:int):void
Sets the default call id for for the specified indication.
IDataInterface
Method detail
addEventListener()method
public function addEventListener(arg1:String, arg2:Function, arg3:Boolean = false, arg4:int = 0, arg5:Boolean = false):void

Parameters
arg1:String
 
arg2:Function
 
arg3:Boolean (default = false)
 
arg4:int (default = 0)
 
arg5:Boolean (default = false)

See also

flash.events.EventDispatcher
dispatchEvent()method 
public function dispatchEvent(arg1:Event):void

Parameters
arg1:Event

See also

flash.events.EventDispatcher
getAllFromBrand()method 
public function getAllFromBrand(brandId:int):Array

Returns a single row from the Brand table.

Parameters
brandId:int

Returns
Array
getAllFromCall()method 
public function getAllFromCall(callId:int):Array

Returns a single row from the Call table.

Parameters
callId:int

Returns
Array
getAllFromIndication()method 
public function getAllFromIndication(indicationId:int):Array

Returns a single row from the Indication table.

Parameters
indicationId:int

Returns
Array
getBookmark()method 
public function getBookmark(callID:int):XML

Returns the bookmark data in XML format for a single call

Parameters
callID:int — id of the call

Returns
XML
getBookmarks()method 
public function getBookmarks(callID:int):XML

Returns the bookmark data in XML format for a single call

Parameters
callID:int — id of the call

Returns
XML
getBrand()method 
public function getBrand(brandID:int, getCachedIfExists:Boolean = false):XML

Method for getting the data for a single brand from the data store with an id matching the brandID parameter.

Parameters
brandID:int — id of the brand to return from the database.
 
getCachedIfExists:Boolean (default = false) — returns the data from the previous call to this method (if the exact same parameters are sent).

Returns
XML — XML node representing a brand
getBrandByIndicationID()method 
public function getBrandByIndicationID(indicationID:int, getCachedIfExists:Boolean = false):XML

Returns the brand of the specified indication.

Parameters
indicationID:int — id of the indication.
 
getCachedIfExists:Boolean (default = false) — returns the data from the previous call to this method (if the exact same parameters are sent).

Returns
XML
getBrands()method 
public function getBrands(getCachedIfExists:Boolean = false):XMLList

Method for getting all brands in the database.

Parameters
getCachedIfExists:Boolean (default = false) — returns the data from the previous call to this method (if the exact same parameters are sent).

Returns
XMLList — XMLList of all brands in the database
getBrandSlides()method 
public function getBrandSlides(brandID:int, addDependencySlides:Boolean = false, getCachedIfExists:Boolean = false):XMLList

Returns an XMLList of all slides belonging to the specified brand.

Parameters
brandID:int — id of the brand
 
addDependencySlides:Boolean (default = false) — if true, adds child XML nodes to each slide in the returned list if the parent slide node has business rule dependencies. The child list will consist (in order) of mustPrecede children, a copy of the parent, then mustFollow children.
 
getCachedIfExists:Boolean (default = false) — returns the data from the previous call to this method (if the exact same parameters are sent).

Returns
XMLListXMLList of slide XML nodes.
getCall()method 
public function getCall(indicationID:int, addDependencySlides:Boolean = false, getCachedIfExists:Boolean = false):XML

Returns all calls belonging to an indication

Parameters
indicationID:int — id of the indication whose calls we want to retrieve
 
addDependencySlides:Boolean (default = false) — if true, adds child XML nodes to each slide in the returned list if the parent slide node has business rule dependencies. The child list will consist (in order) of mustPrecede children, a copy of the parent, then mustFollow children.
 
getCachedIfExists:Boolean (default = false) — returns the data from the previous call to this method (if the exact same parameters are sent).

Returns
XML — XMLList of all calls of the specified indication.
getCalls()method 
public function getCalls(indicationID:int, addDependencySlides:Boolean = false, getCachedIfExists:Boolean = false):XML

Returns all calls belonging to an indication

Parameters
indicationID:int — id of the indication whose calls we want to retrieve
 
addDependencySlides:Boolean (default = false) — if true, adds child XML nodes to each slide in the returned list if the parent slide node has business rule dependencies. The child list will consist (in order) of mustPrecede children, a copy of the parent, then mustFollow children.
 
getCachedIfExists:Boolean (default = false) — returns the data from the previous call to this method (if the exact same parameters are sent).

Returns
XML — XMLList of all calls of the specified indication.
getCallSectionData()method 
public function getCallSectionData(callID:uint):XML

Returns XML with a childlist of section XML nodes of all sections represented by this call's slides. If there is only one slide in a call, there will be only one section. If there are three slides in this call all belonging to the same section, then there will still only be one section in the result list. However, if five slides are in the call all belonging to a different section, then five sections will be in the result list.

NOTE: This does not return all sections for an indication or brand.

Parameters
callID:uint — id of the call

Returns
XML
getIndication()method 
public function getIndication(indicationID:int, getCachedIfExists:Boolean = false):XML

Returns the data related to the specified indication in XML

Parameters
indicationID:int — id of the indication
 
getCachedIfExists:Boolean (default = false) — returns the data from the previous call to this method (if the exact same parameters are sent).

Returns
XMLXML whose attributes are properties of the specified indication.
getIndicationByCallID()method 
public function getIndicationByCallID(callID:int, getCachedIfExists:Boolean = false):XML

Returns the indication that a call belongs to.

Parameters
callID:int — id of the call
 
getCachedIfExists:Boolean (default = false) — returns the data from the previous call to this method (if the exact same parameters are sent).

Returns
XMLXML whose attributes are properties of the specified indication.
getIndications()method 
public function getIndications(brandID:int, getCachedIfExists:Boolean = false):XMLList

Returns the Indication data related to the specified Brand in an XMLList format.

Parameters
brandID:int — id of the Brand
 
getCachedIfExists:Boolean (default = false) — returns the data from the previous call to this method (if the exact same parameters are sent).

Returns
XMLListXMLList whose attributes are properties of the specified Brand.
getIndicationSlideData()method 
public function getIndicationSlideData(indicationID:int, getCachedIfExists:Boolean = false):XMLList

Returns an XMLList of all sections belonging to an indication each of which have a child list of slides that belong to the section (for the specified indication)

Parameters
indicationID:int — id of the indication
 
getCachedIfExists:Boolean (default = false) — returns the data from the previous call to this method (if the exact same parameters are sent).

Returns
XMLList — an XMLList of sections (each with a childlist of slides)
getRepBag()method 
public function getRepBag(indicationID:int, getCachedIfExists:Boolean = false):XMLList

Method for getting the rep bag data in XML format for an indication.

Parameters
indicationID:int — id of the indication.
 
getCachedIfExists:Boolean (default = false) — returns the data from the previous call to this method (if the exact same parameters are sent).

Returns
XMLList
removeEventListener()method 
public function removeEventListener(arg1:String, arg2:Function, arg3:Boolean = false):void

Parameters
arg1:String
 
arg2:Function
 
arg3:Boolean (default = false)

See also

flash.events.EventDispatcher
updateCallTitleAttrib()method 
public function updateCallTitleAttrib(callID:int, title:String, titleAbbr:String):void

Updates properties of the specified call.

Parameters
callID:int — id of the call whose properties are being updated.
 
title:String — new title of the specified call.
 
titleAbbr:String — new title abbreviation of the specified call.
updateDefaultCallID()method 
public function updateDefaultCallID(indicationID:int, callID:int):void

Sets the default call id for for the specified indication.

Parameters
indicationID:int — id of the indication whose default call is being set
 
callID:int — id of the call that is now the default for the specified indication.