Difference between revisions of "Extensions.Flash.GetListOfValidFlashSessions"

From emotive
Jump to navigation Jump to search
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
[[Category:Flash]]
+
{{DISPLAYTITLE:  '''GetListOfValidFlashSessions'''}}[[Category:Flash]]
 
== Classification ==
 
== Classification ==
−
{{ClassificationActivity | GetListOfValidFlashSessions | Returns a list of valid flash sessions | [[Term]] | [[Flash|OTX Flash extension]] | [[Flash session related terms]] | - | - }}
+
{{ClassificationActivity | GetListOfValidFlashSessions | Returns a list of valid flash sessions | [[Term]] | [[Extensions.Flash|OTX Flash extension]] | [[Extensions.Flash#Terms|Flash session related terms]] | - | - }}
  
 
== OTL Syntax ==
 
== OTL Syntax ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
−
ListTerm = Flash.GetListOfValidFlashSessions(Audience, ComChannelTerm, Direction);
+
ListTerm Flash.GetListOfValidFlashSessions(ComChannelTerm comChannel, AudienceTerm audience, Directions direction);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== Description ==
 
== Description ==
−
The '''GetListOfValidFlashSessions''' term is a list of strings to the valid '''FlashSessions''' identified.
+
The '''GetListOfValidFlashSessions''' term will return an '''otx:List''' of [[Core.DataTypes.SimpleDataType.String|otx:String]] items which identify the '''FlashSessions''' that are valid. The validity of a '''FlashSession''' will be defined by rules which exist in the respective technological environment.
  
−
{{TermReturnValue| [[List]] | List of valid FlashSessions.}}
+
{{Important|''GetListOfValidFlashSessions'' will return the flash sessions in the order of their session priority. The highest-ranking ''FlashSession'' will be the first item in the resulting List whereas the lowest-ranking will be the last. For equally-ranked ''FlashSessions'' the order is unspecified.}}
 +
 
 +
{{TermReturnValue| [[Core.DataTypes.ComplexDataType.List|List]] | List of valid '''FlashSessions'''.}}
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
−
{{TableRowPropertie1| ComChannel | [[ComChannel]] | [[Term]] | - | [1] | Communication Channel.}}
+
{{TableRowPropertie2| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Term]] | - | [1] | This element defines a communication channel which is associated to the flash sessions.}}
−
{{TableRowPropertie2| Audience | [[Audience]] | [[Value]] | @Audience:SUPPLIER | [0..1] | <nowiki>This optional attribute defines a filter to a special audience. Only Flash sessions with the specified audience will be returned. When the attribute is not set, no filtering is performed. Audiences = {SUPPLIER|DEVELOPMENT|MANUFACTURING|AFTER SALES|AFTERMARKET}.</nowiki>}}
+
{{TableRowPropertie1| Audience | [[Extensions.Flash.Audience|Audience]] | [[Term]] | @Audience:SUPPLIER | [0..1] | <nowiki>This optional element defines a filter on a special audience. Only flash sessions with the given audience will be returned. If the attribute is omitted, no audience filtering will be done. Audiences = {SUPPLIER|DEVELOPMENT|MANUFACTURING|AFTER SALES|AFTERMARKET}.</nowiki>}}
−
{{TableRowPropertie1| Direction | [[Direction]] | [[Value]] | UPLOAD | [0..1] | <nowiki>This attribute defines the type of Flash sessions is returned. Directions = {UPLOAD|DOWNLOAD}.</nowiki>}}
+
{{TableRowPropertie2| Direction | [[Directions]] | [[Value]] | UPLOAD |[1] | <nowiki>This attribute defines which kind of '''FlashSessions''' will be returned. Directions = {UPLOAD|DOWNLOAD}.</nowiki>}}
 
|}
 
|}
  
 
== OTL Examples ==
 
== OTL Examples ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 +
/// Local Declarations
 +
 
DiagCom.ComChannel ComChannel1;
 
DiagCom.ComChannel ComChannel1;
 
List<String> List1;
 
List<String> List1;
  
−
ComChannel1 = DiagCom.GetComChannel("DiagnosticsCan_ECU_1", null, false);
+
/// Flow
−
List1 = Flash.GetListOfValidFlashSessions(@Directions:DOWNLOAD, ComChannel1, @Audiences:SUPPLIER);
+
 
 +
ComChannel1 = DiagCom.GetComChannel("SCHEINWERFER", "SCHEINWERFER_1", false);
 +
List1 = Flash.GetListOfValidFlashSessions(ComChannel1, @Audience:SUPPLIER, @Directions:DOWNLOAD);
 
</syntaxhighlight>
 
</syntaxhighlight>
 
== See also ==
 
== See also ==
−
[[GetFlashSession]] <br/>
+
<!--[[Extensions.Flash.GetListOfValidFlashSessions|GetListOfValidFlashSessions]] <br/>-->
−
[[GetSessionID]] <br/>
+
[[Extensions.Flash.GetFlashSession|GetFlashSession]]<br/>
−
[[GetSessionPriority]] <br/>
+
[[Extensions.Flash.GetSessionID|GetSessionID]]<br/>
−
[[GetNumberOfBlocks]] <br/>
+
[[Extensions.Flash.GetFlashKey|GetFlashKey]]<br/>
−
[[IsDownloadSession]] <br/>
+
[[Extensions.Flash.GetSessionPriority|GetSessionPriority]]<br/>
−
[[GetFlashKey]]
+
[[Extensions.Flash.GetNumberOfBlocks|GetNumberOfBlocks]]<br/>
 +
[[Extensions.Flash.IsDownloadSession|IsDownloadSession]]<br/>
 +
[[Extensions.DiagCom.GetComChannel|GetComChannel]]<br/>

Latest revision as of 01:42, 13 September 2019

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 will return an otx:List of otx:String items which identify the FlashSessions that are valid. The validity of a FlashSession will be defined by rules which exist in the respective technological environment.

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

Return Value

The Term returns the value, see table below.

Icons Note.png 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 will be returned. If the attribute is omitted, no audience filtering will be done. Audiences = {SUPPLIER|DEVELOPMENT|MANUFACTURING|AFTER SALES|AFTERMARKET}.
Direction Directions Value UPLOAD [1] This attribute defines which kind of '''FlashSessions''' will 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

Retrieved from "http://emotive.de/wiki/index.php?title=Extensions.Flash.GetListOfValidFlashSessions&oldid=9731"