Extensions.Flash.GetListOfValidFlashSessions

Classification

Name	GetListOfValidFlashSessions
Short Description	Returns a list of valid flash sessions
Class	Term
Extension	OTX Flash extension
Group	Flash session related terms
Exceptions	-
Checker Rules	-
Standard Compliant	Yes

OTL Syntax

ListTerm Flash.GetListOfValidFlashSessions(ComChannelTerm comChannel, AudienceTerm audience, Directions direction);

Description

The GetListOfValidFlashSessions term shall return an otx:List of otx:String items which identify the FlashSessions that are valid. The validity of a FlashSession shall be defined by rules which exist in the respective technological environment.

Important: GetListOfValidFlashSessions shall return the flash sessions in the order of their session priority. The highest-ranking FlashSession shall be the first item in the resulting List whereas the lowest-ranking shall be the last. For equally-ranked FlashSessions the order is unspecified.

Return Value

The Term returns the value, see table below.

In OTX, Terms are categorized according to its return data type!

Data Type	Description
List	List of valid FlashSessions.

Properties

Name	Data Type	Class	Default	Cardinality	Description
ComChannel	ComChannel	Term	-	[1]	This element defines a communication channel which is associated to the flash sessions.
Audience	Audience	Term	@Audience:SUPPLIER	[0..1]	This optional element defines a filter on a special audience. Only flash sessions with the given audience shall be returned. If the attribute is omitted, no audience filtering shall be done. Audiences = {SUPPLIER|DEVELOPMENT|MANUFACTURING|AFTER SALES|AFTERMARKET}.
Direction	Directions	Value	UPLOAD	[1]	This attribute defines which kind of '''FlashSessions''' shall be returned. Directions = {UPLOAD|DOWNLOAD}.

OTL Examples

/// Local Declarations

DiagCom.ComChannel ComChannel1;
List<String> List1;

/// Flow

ComChannel1 = DiagCom.GetComChannel("SCHEINWERFER", "SCHEINWERFER_1", false);
List1 = Flash.GetListOfValidFlashSessions(ComChannel1, @Audience:SUPPLIER, @Directions:DOWNLOAD);

See also

GetFlashSession
GetSessionID
GetFlashKey
GetSessionPriority
GetNumberOfBlocks
IsDownloadSession
GetComChannel