SAP ABAP Interface IF_CLB2_GW_SUBSCRIPTION (SAIL: Subscription for Gateway Notifications)
Hierarchy
☛
SAP_UI (Software Component) User Interface Technology
⤷
CA-UI2-AR-SM (Application Component) SAP UI Integration - Social Media Collaboration Enablement
⤷
CLB2_NOTIFY (Package) Subscription and Notification Scenarios
SAP_UI (Software Component) User Interface Technology⤷
CA-UI2-AR-SM (Application Component) SAP UI Integration - Social Media Collaboration Enablement⤷
CLB2_NOTIFY (Package) Subscription and Notification Scenarios
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_CLB2_GW_SUBSCRIPTION | Collaboration: API for Gateway Subscriptions | 20130516 |
Properties
| Interface | IF_CLB2_GW_SUBSCRIPTION | |
| Short Description | SAIL: Subscription for Gateway Notifications |
General Data
| Package | CLB2_NOTIFY | Subscription and Notification Scenarios |
| Created | 20130516 | SAP |
| Last changed | 20141120 | |
| Unicode checks active |
Forward declarations
Interface IF_CLB2_GW_SUBSCRIPTION has no forward declaration.
Interfaces
Interface IF_CLB2_GW_SUBSCRIPTION has no interface.
Friends
Interface IF_CLB2_GW_SUBSCRIPTION has no friend.
Attributes
Interface IF_CLB2_GW_SUBSCRIPTION has no attribute.
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | BUILD_ODATA_KEY |
Instance method | Public | Method | 20140411 | |
| 2 | CREATE_SUBSCRIPTION |
Instance method | Public | Method | Create a Subscription for a User | 20130516 |
| 3 | CREATE_SUBSCRIPTION_S |
Instance method | Public | Method | Create a Subscription for a User; Different Parameter Struc. | 20130516 |
| 4 | DELETE_SUBSCRIPTION |
Instance method | Public | Method | Delete a Subscription for a User | 20130516 |
| 5 | GET_LIST |
Instance method | Public | Method | Get the List of Subscriptions for a User | 20130516 |
| 6 | GET_SUBSCRIPTION |
Instance method | Public | Method | Get Details of a Subscription | 20130516 |
| 7 | UPDATE_SUBSCRIPTION_S |
Instance method | Public | Method | Updates a Subscription | 20131220 |
Events
Interface IF_CLB2_GW_SUBSCRIPTION has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TTY_KEY | Public | See coding | 20140411 | tty_key TYPE STANDARD TABLE OF ty_key WITH DEFAULT KEY
|
||
| 2 | TTY_SUBSCRIPTION | Public | See coding | 20130516 | tty_subscription TYPE STANDARD TABLE OF ty_subscription
|
||
| 3 | TY_CHAR255 | Public | See coding | 20130516 | ty_char255 TYPE c LENGTH 255
|
||
| 4 | TY_KEY | Public | See coding | 20140411 | BEGIN OF ty_key,
name TYPE string,
type TYPE string, "optional: per default string is assumed
value TYPE string,
END OF ty_key
|
||
| 5 | TY_SUBSCRIPTION | Public | See coding | 20130516 | BEGIN OF ty_subscription,
id TYPE c LENGTH 32,
language TYPE langu,
group_tech_name TYPE c LENGTH 35,
group_version TYPE n LENGTH 4,
username TYPE syuname,
title TYPE c LENGTH 255,
source_system_id TYPE sysysid,
source_client TYPE mandt,
delivery_address TYPE string,
persist_notif TYPE c LENGTH 1,
base_url TYPE string,
collection_name TYPE c LENGTH 40,
filter_parameter TYPE string,
select_parameter TYPE c LENGTH 255,
change_type TYPE c LENGTH 30,
role_id TYPE c LENGTH 30,
created_by TYPE syuname,
system_alias TYPE c LENGTH 16,
notif_format TYPE c LENGTH 10,
service_root TYPE icfname, "not used since not in /IWBEP/IF_MGW_SUB_UTIL, but already transported
END OF ty_subscription
|
Method Signatures
Method BUILD_ODATA_KEY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IT_KEY_ELEMENTS | Call by reference | Type reference (TYPE) | TTY_KEY | 20140411 | |||
| 2 |  Returning |
RV_VALUE | Value transfer | Type reference (TYPE) | STRING | 20140411 |
Method BUILD_ODATA_KEY on Interface IF_CLB2_GW_SUBSCRIPTION has no exception.
Method CREATE_SUBSCRIPTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_BASE_URL | Call by reference | Type reference (TYPE) | STRING | Name of a Service in Internet Communication Framework | 20130516 | ||
| 2 | Importing |
IV_COLLECTION_NAME | Call by reference | Type reference (TYPE) | CHAR40 | Character field of length 40 | 20130516 | ||
| 3 | Importing |
IV_FILTER_PARAMETER | Call by reference | Type reference (TYPE) | STRING | Subscription Filter | 20131220 | ||
| 4 | Importing |
IV_GROUP_TECH_NAME | Call by reference | Type reference (TYPE) | CHAR35 | Data Element Type CHAR Length 35 | 20130516 | ||
| 5 | Importing |
IV_GROUP_VERSION | Call by reference | Type reference (TYPE) | NUMC4 | '0001' | Count parameters | 20130516 | |
| 6 | Importing |
IV_LANGUAGE | Call by reference | Type reference (TYPE) | LANGU | SY-LANGU | Language Key | 20130516 | |
| 7 | Importing |
IV_SOURCE_CLIENT | Call by reference | Type reference (TYPE) | MANDT | SY-MANDT | Client | 20130516 | |
| 8 | Importing |
IV_SOURCE_SYSTEM | Call by reference | Type reference (TYPE) | SYSYSID | SY-SYSID | Name of the SAP System | 20130516 | |
| 9 | Importing |
IV_TITLE | Call by reference | Type reference (TYPE) | TY_CHAR255 | Char255 | 20130516 | ||
| 10 | Importing |
IV_USER_NAME | Call by reference | Type reference (TYPE) | SYUNAME | SY-UNAME | User Name | 20130516 | |
| 11 | Returning |
RV_SUBSCRIPTION_ID | Value transfer | Type reference (TYPE) | CHAR32 | Subscription ID | 20130516 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_CLB2_PROCESS |
SAIL: Process layer exception | 20130516 |
Method CREATE_SUBSCRIPTION_S Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IS_SUBSCRIPTION | Call by reference | Type reference (TYPE) | TY_SUBSCRIPTION | 20130516 | |||
| 2 | Returning |
RV_SUBSCRIPTION_ID | Value transfer | Type reference (TYPE) | CHAR32 | 20130516 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_CLB2_PROCESS |
SAIL: Process layer exception | 20130516 |
Method DELETE_SUBSCRIPTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_SUBSCRIPTION_ID | Call by reference | Type reference (TYPE) | CHAR32 | Character field, length 32 | 20130516 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_CLB2_PROCESS |
SAIL: Process layer exception | 20130516 |
Method GET_LIST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ET_SUBSCRIPTIONS | Call by reference | Type reference (TYPE) | TTY_SUBSCRIPTION | 20130516 | |||
| 2 | Importing |
IV_USER | Call by reference | Type reference (TYPE) | SYUNAME | SY-UNAME | 20130516 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_CLB2_PROCESS |
20130516 |
Method GET_SUBSCRIPTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_SUBSCRIPTION_ID | Call by reference | Type reference (TYPE) | CHAR32 | 20130516 | |||
| 2 | Returning |
RS_SUBSCRIPTION | Value transfer | Type reference (TYPE) | TY_SUBSCRIPTION | 20130516 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_CLB2_PROCESS |
20130516 |
Method UPDATE_SUBSCRIPTION_S Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IS_SUBSCRIPTION | Call by reference | Type reference (TYPE) | TY_SUBSCRIPTION | 20131220 | |||
| 2 | Returning |
RV_SUBSCRIPTION_ID | Value transfer | Type reference (TYPE) | CHAR32 | Character field, length 32 | 20131220 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_CLB2_PROCESS |
SAIL: Process layer exception | 20131220 |
History
| Last changed by/on | SAP | 20141120 |
| SAP Release Created in | 100 |
