Packageat.datacollection
Classpublic class DataItemGeneric
ImplementsIDataItemDescription
SubclassesDataItemCall, DataItemForm, DataItemOverlay, DataItemPrecall, DataItemSlide, DataItemVideo

This is the generic DataCollection item for the eVE DataCollection Module. All other DataCollection items are based upon this class. If a Data Item Descripton class does not exist in the eVE DataCollecton Module you may use this class to add custom functionality to your eVE Application.



Public Properties
 PropertyDefined by
  bookEnd : BookEndRow
The Book End for this data collection element per the IDataItem implementation
DataItemGeneric
  bookEndTime : Date
Internal variable to store the Book End date for this item.
DataItemGeneric
  bookStart : BookStartRow
The Book Start for this data collection element per the IDataItem implementation
DataItemGeneric
  bookStartTime : Date
Internal variable to store the Book Start date for this item.
DataItemGeneric
  dataWorkerOptions : uint
An unsigned integer (uint) that disables various elements of the data collection to be stored into the database
DataItemGeneric
  endEvent : String
The event that will dispatch signaling the end of data collection of the generic item.
DataItemGeneric
  friendlyName : String
A human readable name for your generic item
DataItemGeneric
  itemType : String
[read-only] The item type for this data collection element per the IDataItem implementation
DataItemGeneric
  properties : Array
An array of string that correlate to public properties of the Target object.
DataItemGeneric
  removeOnEndEvent : Boolean
A boolean to tell the data item worker to remove it from it's internal list once it has been pushed to the database.
DataItemGeneric
  startEvent : String
The event that will dispatch signaling the beginning of data collection
DataItemGeneric
  target : *
This will be the object responsible for providing values for the properties and dispatching the begin and end data collection events.
DataItemGeneric
Public Methods
 MethodDefined by
  
DataItemGeneric(target:*, type:String, friendlyName:String, dataWorkerOptions:uint, removeOnEndEvent:Boolean, startEvent:String, endEvent:String, properties:Array)
DataItemGeneric
  
addBookEndSlotData(args:Array):void
Pushes an array of data to be stored into the data collection database.
DataItemGeneric
  
addBookEndSlotDataSingle(args:Array):void
Similar to the addBookEndSlotData it will add data to the data slots, however, it will store an unlimited amount to the database.
DataItemGeneric
  
addBookStartSlotData(args:Array):void
Pushes an array of data to be stored into the DataCollection database.
DataItemGeneric
  
addBookStartSlotDataSingle(args:Array):void
Similar to the addBookStartSlotData it will add data to the data slots, however, it will store an unlimited amount to the database.
DataItemGeneric
Property detail
bookEndproperty
bookEnd:BookEndRow  [read-write]

The Book End for this data collection element per the IDataItem implementation

Implementation
    public function get bookEnd():BookEndRow
    public function set bookEnd(value:BookEndRow):void
bookEndTimeproperty 
bookEndTime:Date  [read-write]

Internal variable to store the Book End date for this item.

Implementation
    public function get bookEndTime():Date
    public function set bookEndTime(value:Date):void
bookStartproperty 
bookStart:BookStartRow  [read-write]

The Book Start for this data collection element per the IDataItem implementation

Implementation
    public function get bookStart():BookStartRow
    public function set bookStart(value:BookStartRow):void
bookStartTimeproperty 
bookStartTime:Date  [read-write]

Internal variable to store the Book Start date for this item.

Implementation
    public function get bookStartTime():Date
    public function set bookStartTime(value:Date):void
dataWorkerOptionsproperty 
dataWorkerOptions:uint  [read-write]

An unsigned integer (uint) that disables various elements of the data collection to be stored into the database

Implementation
    public function get dataWorkerOptions():uint
    public function set dataWorkerOptions(value:uint):void

See also

endEventproperty 
endEvent:String  [read-write]

The event that will dispatch signaling the end of data collection of the generic item. This event will push the item into the database.

Implementation
    public function get endEvent():String
    public function set endEvent(value:String):void
friendlyNameproperty 
friendlyName:String  [read-write]

A human readable name for your generic item

Implementation
    public function get friendlyName():String
    public function set friendlyName(value:String):void
itemTypeproperty 
itemType:String  [read-only]

The item type for this data collection element per the IDataItem implementation

Implementation
    public function get itemType():String

See also

at.datacollection.workers.DataWorkerGeneric.DATA_EXPECTED_TYPE
propertiesproperty 
properties:Array  [read-write]

An array of string that correlate to public properties of the Target object. When the Start or End event is dispatched the generic worker will pull these properties of the Target into the database.

Implementation
    public function get properties():Array
    public function set properties(value:Array):void
removeOnEndEventproperty 
removeOnEndEvent:Boolean  [read-write]

A boolean to tell the data item worker to remove it from it's internal list once it has been pushed to the database.

Implementation
    public function get removeOnEndEvent():Boolean
    public function set removeOnEndEvent(value:Boolean):void
startEventproperty 
startEvent:String  [read-write]

The event that will dispatch signaling the beginning of data collection

Implementation
    public function get startEvent():String
    public function set startEvent(value:String):void
targetproperty 
target:*  [read-write]

This will be the object responsible for providing values for the properties and dispatching the begin and end data collection events.

Implementation
    public function get target():*
    public function set target(value:*):void
Constructor detail
DataItemGeneric()constructor
public function DataItemGeneric(target:*, type:String, friendlyName:String, dataWorkerOptions:uint, removeOnEndEvent:Boolean, startEvent:String, endEvent:String, properties:Array)

Parameters
target:* — This will be the object responsible for providing values for the properties and dispatching the begin and end data collection events.
 
type:String — A short category name for your generic item
 
friendlyName:String — A human readable name for your generic item
 
dataWorkerOptions:uint — An unsigned integer (uint) that disables various elements of the data collection to be stored into the database
 
removeOnEndEvent:Boolean — A boolean to tell the DataCollection worker to remove it from it's internal list once it has been pushed to the database.
 
startEvent:String — The event that will dispatch signaling the beginning of data collection.
 
endEvent:String — The event that will dispatch signaling the end of data collection the generic item. This event will push the item into the database.
 
properties:Array — An array of string that correlate to public properties of the Target object. When the Start or End event is dispatched the generic worker will pull these properties of the Target into the DataCollection database.

See also

Method detail
addBookEndSlotData()method
public function addBookEndSlotData(args:Array):void

Pushes an array of data to be stored into the data collection database. This method supports up to the maximum alotted slot items at a time (one End Slot Data row per call).

Parameters
args:Array

See also

addBookEndSlotDataSingle()method 
public function addBookEndSlotDataSingle(args:Array):void

Similar to the addBookEndSlotData it will add data to the data slots, however, it will store an unlimited amount to the database. This method will add a single row for every value that is passed in.

Parameters
args:Array
addBookStartSlotData()method 
public function addBookStartSlotData(args:Array):void

Pushes an array of data to be stored into the DataCollection database. This method supports up to the maximum alotted slot items at a time (one Start Slot Data row per call).

Parameters
args:Array

See also

addBookStartSlotDataSingle()method 
public function addBookStartSlotDataSingle(args:Array):void

Similar to the addBookStartSlotData it will add data to the data slots, however, it will store an unlimited amount to the database. This method will add a single row for every value that is passed in.

Parameters
args:Array