Difference between revisions of "Extensions.ExternalServiceProvider.PropertyFlag"
Jump to navigation
Jump to search
(Created by Ngoc Tran.) |
(Edited by Ngoc Tran. Fixed Order Relation, Literal, Core Conversion) |
||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:Data Type '''PropertyFlag'''}}[[Category:ExternalServiceProvider]][[Category:ExternalServiceProvider]] | {{DISPLAYTITLE:Data Type '''PropertyFlag'''}}[[Category:ExternalServiceProvider]][[Category:ExternalServiceProvider]] | ||
== Classification == | == Classification == | ||
| − | {{ClassificationDataType | PropertyFlag | Characteristics of values that access rights used in the ServiceProviderSignatures '''Properties''' | [[Core.DataTypes.SimpleDataType|Simple Data Type]] | [[Core.DataTypes.SimpleDataType.SimpleType|SimpleType]]| DefaultValue=READ-ONLY | Literal=Yes | SpecifiedBy={{OtxSpec4}} }} | + | {{ClassificationDataType | PropertyFlag | Characteristics of values that access rights used in the [[Extensions.ExternalServiceProvider.ServiceProviderSignatures|ServiceProviderSignatures]] '''Properties''' | [[Core.DataTypes.SimpleDataType|Simple Data Type]] | [[Core.DataTypes.SimpleDataType.SimpleType|SimpleType]]| DefaultValue=READ-ONLY | Literal=Yes | SpecifiedBy={{OtxSpec4}} }} |
== Description == | == Description == | ||
| − | + | [[Extensions.ExternalServiceProvider.PropertyFlag|PropertyFlags]] is an enumeration type describing access rights used in the [[Extensions.ExternalServiceProvider.ServiceProviderSignatures|ServiceProviderSignatures]] '''Properties'''. | |
The list of allowed enumeration values is defined as follows: | The list of allowed enumeration values is defined as follows: | ||
| Line 12: | Line 12: | ||
| '''Value''' || '''[[Literals|<span style="color:white;">Literal</span>]]''' || '''Description''' | | '''Value''' || '''[[Literals|<span style="color:white;">Literal</span>]]''' || '''Description''' | ||
|- {{TableRow1}} | |- {{TableRow1}} | ||
| − | | '''READ-ONLY''' || @PropertyFlag:READ-ONLY || The property value, defined in [[Extensions.ExternalServiceProvider.PropertySignature|PropertySignature]], is read only. This is the default access right if the <init> of the | + | | '''READ-ONLY''' || @PropertyFlag:READ-ONLY || The property value, defined in [[Extensions.ExternalServiceProvider.PropertySignature|PropertySignature]], is read only. This is the default access right if the <init> of the [[Extensions.ExternalServiceProvider.PropertyFlag|PropertyFlags]] variable is not defined. |
|- {{TableRow2}} | |- {{TableRow2}} | ||
| '''WRITE-ONLY''' || @PropertyFlag:WRITE-ONLY || The property value, defined in [[Extensions.ExternalServiceProvider.PropertySignature|PropertySignature]], is only writable. | | '''WRITE-ONLY''' || @PropertyFlag:WRITE-ONLY || The property value, defined in [[Extensions.ExternalServiceProvider.PropertySignature|PropertySignature]], is only writable. | ||
| Line 20: | Line 20: | ||
==Order Relation== | ==Order Relation== | ||
| − | PropertyFlag values may occur as operands of comparisons (cf. Part 2 of ISO 13209, relational operations). For this case, the following order relation will apply: | + | [[Extensions.ExternalServiceProvider.PropertyFlag|PropertyFlags]] values may occur as operands of comparisons (cf. Part 2 of ISO 13209, relational operations). For this case, the following order relation will apply: |
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
READ-ONLY < WRITE-ONLY < READ-WRITE | READ-ONLY < WRITE-ONLY < READ-WRITE | ||
| Line 30: | Line 30: | ||
@PropertyFlag:READ-ONLY|WRITE-ONLY|READ-WRITE | @PropertyFlag:READ-ONLY|WRITE-ONLY|READ-WRITE | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | |||
| − | |||
| − | |||
{{ConversionTable | | {{ConversionTable | | ||
| − | Integer= | + | Integer=Return the index of the value in the [[Extensions.ExternalServiceProvider.PropertyFlag|PropertyFlags]] enumeration (smallest index is 0) | IntegerSample=<tt>Integer val = ToInteger(@PropertyFlag:READ-WRITE); // Returns 2</tt> | |
| − | String= | + | String=Resulting string will be the name of the enumeration value | StringSample=<tt>String s = ToString(@PropertyFlag:READ-WRITE); // Returns "READ-WRITE"</tt> |
}} | }} | ||
==Sample== | ==Sample== | ||
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | + | ExternalServiceProvider.PropertyFlag PropertyFlag1 = @PropertyFlag:READ-ONLY; | |
</syntaxhighlight> | </syntaxhighlight> | ||
Revision as of 01:46, 13 November 2019
Classification
| Name | PropertyFlag |
| Short Description | Characteristics of values that access rights used in the ServiceProviderSignatures Properties |
| Class | Simple Data Type |
| Base Data Type | SimpleType |
| Default Value | READ-ONLY |
| Provide a Literal | Yes |
| SpecifiedBy | ISO 13209-4 |
| Standard Compliant | Yes |
Description
PropertyFlags is an enumeration type describing access rights used in the ServiceProviderSignatures Properties.
The list of allowed enumeration values is defined as follows:
| Value | Literal | Description |
| READ-ONLY | @PropertyFlag:READ-ONLY | The property value, defined in PropertySignature, is read only. This is the default access right if the <init> of the PropertyFlags variable is not defined. |
| WRITE-ONLY | @PropertyFlag:WRITE-ONLY | The property value, defined in PropertySignature, is only writable. |
| READ-WRITE | @PropertyFlag:READ-WRITE | The property value, defined in PropertySignature, is readable as well writable. |
Order Relation
PropertyFlags values may occur as operands of comparisons (cf. Part 2 of ISO 13209, relational operations). For this case, the following order relation will apply:
READ-ONLY < WRITE-ONLY < READ-WRITELiteral
The syntax for Literals for complex data types will be used, where the member value is one of the values in the list.
@PropertyFlag:READ-ONLY|WRITE-ONLY|READ-WRITECore Conversion
The following table shows the rules for conversion to another data type:
| Conversion | Result | Sample |
| ToBoolean | Undefined (should not be used) | |
| ToInteger | Return the index of the value in the PropertyFlags enumeration (smallest index is 0) | Integer val = ToInteger(@PropertyFlag:READ-WRITE); // Returns 2 |
| ToFloat | Undefined (should not be used) | |
| ToString | Resulting string will be the name of the enumeration value | String s = ToString(@PropertyFlag:READ-WRITE); // Returns "READ-WRITE" |
| ToByteField | Undefined (should not be used) |
Sample
ExternalServiceProvider.PropertyFlag PropertyFlag1 = @PropertyFlag:READ-ONLY;