Difference between revisions of "Extensions.Flash.GetListOfValidFlashSessions"
Jump to navigation
Jump to search
| (3 intermediate revisions by one other user not shown) | |||
| Line 5: | Line 5: | ||
== OTL Syntax == | == OTL Syntax == | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | ListTerm | + | ListTerm Flash.GetListOfValidFlashSessions(ComChannelTerm comChannel, AudienceTerm audience, Directions direction); |
</syntaxhighlight> | </syntaxhighlight> | ||
== Description == | == Description == | ||
| − | The '''GetListOfValidFlashSessions''' term | + | 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. |
| − | {{Important|''GetListOfValidFlashSessions'' | + | {{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'''.}} | {{TermReturnValue| [[Core.DataTypes.ComplexDataType.List|List]] | List of valid '''FlashSessions'''.}} | ||
| Line 18: | Line 18: | ||
{| {{TableHeader}} | {| {{TableHeader}} | ||
{{TableRowPropertiesHeader}} | {{TableRowPropertiesHeader}} | ||
| − | {{ | + | {{TableRowPropertie2| ComChannel | [[Extensions.DiagCom.ComChannel|ComChannel]] | [[Term]] | - | [1] | This element defines a communication channel which is associated to the flash sessions.}} |
| − | {{ | + | {{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>}} |
| − | {{ | + | {{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; | ||
Latest revision as of 01:42, 13 September 2019
Contents
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.
|
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.
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
