SAP ABAP Interface /AIN/IF_TAG_FORMAT (Auto-ID Tag Format Descriptor Interface)
Hierarchy
☛
AIN (Software Component) AIN 710: Add-On Installation
⤷
AIE-AII (Application Component) Infrastructure
⤷
/AIN/TAGUTIL (Package) Auto-ID Tag Encoding Utilities for Mobile Readers
⤷
⤷
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | /AIN/CL_TAG_FORMAT | Tag Format Descriptor | 20050221 |
Properties
| Interface | /AIN/IF_TAG_FORMAT | |
| Short Description | Auto-ID Tag Format Descriptor Interface |
General Data
| Package | /AIN/TAGUTIL | Auto-ID Tag Encoding Utilities for Mobile Readers |
| Created | 20050221 | SAP |
| Last changed | 20141109 | SAP |
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | /AIN/CL_TYPES | Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
| 2 | ABAP | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Interface /AIN/IF_TAG_FORMAT has no interface.
Friends
Interface /AIN/IF_TAG_FORMAT has no friend.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | C_ID_USAGE | Constant | Public | Type reference (TYPE) | /AIN/TU_DE_TAG_FIELD_USAGE | 02 | Data element: tag field usage | 20050524 | |
| 2 | C_TDATA_USAGE | Constant | Public | Type reference (TYPE) | /AIN/TU_DE_TAG_FIELD_USAGE | 03 | Data element: tag field usage | 20050524 | |
| 3 | C_TIID_USAGE | Constant | Public | Type reference (TYPE) | /AIN/TU_DE_TAG_FIELD_USAGE | 01 | Data element: tag field usage | 20050524 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | Collects field definitions | 20050221 | |
| 2 | Instance method | Public | Method | Retrieves a number of collected fields | 20050221 | |
| 3 | Instance method | Public | Method | Retrieves a format of a field by index | 20050221 | |
| 4 | Instance method | Public | Method | Retrieves a format of a field by field name | 20050221 | |
| 5 | Instance method | Public | Method | Retrieves a format of a field by field usage | 20050524 | |
| 6 | Instance method | Public | Method | 20050316 | ||
| 7 | Instance method | Public | Method | Retrieve tag format | 20050307 | |
| 8 | Instance method | Public | Method | Checks is field defined in format | 20050315 | |
| 9 | Instance method | Public | Method | Checks is tag ID defined in format | 20050524 | |
| 10 | Instance method | Public | Method | Checks is tag data defined in format | 20050524 | |
| 11 | Instance method | Public | Method | Checks is tag killing supported | 20050524 | |
| 12 | Instance method | Public | Method | Checks is tag internal ID defined in format | 20050524 | |
| 13 | Instance method | Public | Method | Checks is field with specific usage defined in format | 20050524 |
Events
Interface /AIN/IF_TAG_FORMAT has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TY_FIELD_NAMES_LIST | Public | Object reference (TYPE REF TO) | /AIN/CL_TAG_FIELD_NAME_LIST | Tag Format Initial Values List | 20050316 | |
Method Signatures
Method ADD_FIELD_FORMAT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_FIELD_FORMAT | Call by reference | Object reference (TYPE REF TO) | /AIN/IF_TAG_FIELD_FORMAT | Auto_ID Tag Encoding, Decoding Utilities For Mobile Readers | 20050222 |
Method ADD_FIELD_FORMAT on Interface /AIN/IF_TAG_FORMAT has no exception.
Method GET_FIELDS_COUNT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RE_FIELD_COUNT | Value transfer | Type reference (TYPE) | /AIN/CL_TYPES=>TY_INDEX | 20050221 |
Method GET_FIELDS_COUNT on Interface /AIN/IF_TAG_FORMAT has no exception.
Method GET_FIELD_FORMAT_BY_INDEX Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_INDEX | Call by reference | Type reference (TYPE) | /AIN/CL_TYPES=>TY_INDEX | Index of a filed in a list:must be from 0 upto a size of the | 20050222 | |||
| 2 | RE_FIELD_FORMAT | Value transfer | Object reference (TYPE REF TO) | /AIN/IF_TAG_FIELD_FORMAT | Auto_ID Tag Encoding, Decoding Utilities For Mobile Readers | 20050221 |
Method GET_FIELD_FORMAT_BY_INDEX on Interface /AIN/IF_TAG_FORMAT has no exception.
Method GET_FIELD_FORMAT_BY_NAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_FIELD_NAME | Call by reference | Type reference (TYPE) | /AIN/TU_DE_TAG_FIELD_NAME | AutoID Tag Field Name | 20050222 | |||
| 2 | RE_FIELD_FORMAT | Value transfer | Object reference (TYPE REF TO) | /AIN/IF_TAG_FIELD_FORMAT | Auto_ID Tag Encoding, Decoding Utilities For Mobile Readers | 20050221 |
Method GET_FIELD_FORMAT_BY_NAME on Interface /AIN/IF_TAG_FORMAT has no exception.
Method GET_FIELD_FORMAT_BY_USAGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_USAGE | Call by reference | Type reference (TYPE) | /AIN/TU_DE_TAG_FIELD_USAGE | Data element: tag field usage | 20050524 | |||
| 2 | RE_FIELD_FORMAT | Value transfer | Object reference (TYPE REF TO) | /AIN/IF_TAG_FIELD_FORMAT | Auto-ID Tag Field Format Descriptor | 20050524 |
Method GET_FIELD_FORMAT_BY_USAGE on Interface /AIN/IF_TAG_FORMAT has no exception.
Method GET_FIELD_FORMAT_LIST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_FIELD_NAME_LIST | Call by reference | Object reference (TYPE REF TO) | /AIN/CL_TAG_FIELD_NAME_LIST | Tag Format Initial Values List | 20050316 | |||
| 2 | RE_LIST | Value transfer | Type reference (TYPE) | /AIN/CL_TYPES=>TY_FIELD_FORMAT_LIST | 20050316 |
Method GET_FIELD_FORMAT_LIST on Interface /AIN/IF_TAG_FORMAT has no exception.
Method GET_TAG_FORMAT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RE_TAG_FORMAT | Value transfer | Type reference (TYPE) | /AIN/TU_DE_TAG_FORMAT | AutoID Tag Format | 20050307 |
Method GET_TAG_FORMAT on Interface /AIN/IF_TAG_FORMAT has no exception.
Method IS_FIELD_EXIST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_FIELD_NAME | Call by reference | Type reference (TYPE) | /AIN/TU_DE_TAG_FIELD_NAME | AutoID Tag Field Name | 20050315 | |||
| 2 | RE_CHECK_VALUE | Value transfer | Type reference (TYPE) | ABAP_BOOL | Boolean value | 20050315 |
Method IS_FIELD_EXIST on Interface /AIN/IF_TAG_FORMAT has no exception.
Method IS_ID_SUPPORTED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RE_CHECK_VALUE | Value transfer | Type reference (TYPE) | ABAP_BOOL | Boolean value | 20050524 |
Method IS_ID_SUPPORTED on Interface /AIN/IF_TAG_FORMAT has no exception.
Method IS_TAG_DATA_SUPPORTED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RE_CHECK_VALUE | Value transfer | Type reference (TYPE) | ABAP_BOOL | Boolean value | 20050524 |
Method IS_TAG_DATA_SUPPORTED on Interface /AIN/IF_TAG_FORMAT has no exception.
Method IS_TAG_KILL_SUPPORTED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RE_CHECK_VALUE | Value transfer | Type reference (TYPE) | ABAP_BOOL | Boolean value | 20050524 |
Method IS_TAG_KILL_SUPPORTED on Interface /AIN/IF_TAG_FORMAT has no exception.
Method IS_TIID_SUPPORTED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RE_CHECK_VALUE | Value transfer | Type reference (TYPE) | ABAP_BOOL | Boolean value | 20050524 |
Method IS_TIID_SUPPORTED on Interface /AIN/IF_TAG_FORMAT has no exception.
Method IS_USAGE_EXIST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_USAGE | Call by reference | Type reference (TYPE) | /AIN/TU_DE_TAG_FIELD_USAGE | Data element: tag field usage | 20050524 | |||
| 2 | RE_CHECK_VALUE | Value transfer | Type reference (TYPE) | ABAP_BOOL | Boolean value | 20050524 |
Method IS_USAGE_EXIST on Interface /AIN/IF_TAG_FORMAT has no exception.
History
| Last changed by/on | SAP | 20141109 |
| SAP Release Created in | 300 |