Extensions.Flash.BlockIsValidForAudience

Classification

Name	BlockIsValidForAudience
Short Description	Checks whether a block is valid for a given audience or not.
Class	Term
Extension	OTX Flash extension
Group	Flash block related terms
Exceptions	OutOfBoundsException
Checker Rules	-
Standard Compliant	Yes

OTL Syntax

BooleanTerm Flash.BlockIsValidForAudience(FlashSessionTerm session, NumericTerm block, AudienceTerm audience);

Description

The BlockIsValidForAudience term returns true if and only if a block is valid for a given audience.

Return Value

The Term returns the value, see table below.

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

Data Type	Description
Boolean	Return true if a block is valid for a given audience.

Properties

Name	Data Type	Class	Default	Cardinality	Description
Session	FlashSession	Term	-	[1]	This element represents the FlashSession in which the block resides.
Block	Numeric	Term	-	[1]	This element represents the block number. Float values will be truncated..
Audience	Audience	Term	@Audience:SUPPLIER	[1]	This attribute defines which 'audience will be used for the check.

OTL Examples

/// Local Declarations

DiagCom.ComChannel ComChannel1;
Flash.FlashSession FlashSession1;
List<String> List1;
Boolean Boolean1 = false;

/// Flow

ComChannel1 = DiagCom.GetComChannel("SCHEINWERFER", "SCHEINWERFER_1", false);
List1 = Flash.GetListOfValidFlashSessions(ComChannel1, @Audience:SUPPLIER, @Directions:DOWNLOAD);
FlashSession1 = Flash.GetFlashSession(List1[2]);
Boolean1 = Flash.BlockIsValidForAudience(FlashSession1, 1, @Audience:DEVELOPMENT);

See also

GetNumberOfSegments
GetNumberOfOwnIdents
GetNumberOfSecurities
GetLogicalBlockID
GetCompressionEncryption
GetType
GetListOfValidFlashSessions
GetFlashSession
GetComChannel