SAP ABAP Class IF_STW_API (StreamWork Application API (Compatibility Mode in SAP Jam))
Properties
| Class | IF_STW_API | |
| Short Description | StreamWork Application API (Compatibility Mode in SAP Jam) | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | ||
| Created | 20110801 | SAP |
| Last change | 20140121 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 |  ABAP |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
| 2 | IF_STW_ACTIVITY |
Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
| 3 | IF_STW_API |
Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
| 4 | IF_STW_BO |
Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
| 5 | IF_STW_FEED_GW |
Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
| 6 | IF_STW_ITEM |
Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
| 7 | IF_STW_TOPIC |
Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
| 8 | IF_STW_USER |
Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
Interfaces
Class IF_STW_API has no interface implemented.
Friends
Class IF_STW_API has no friend class.
Attributes
Class IF_STW_API has no attribute.
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CREATE_ACTIVITY |
Instance method | Public | Method | Create an Activity in StreamWork | 20110801 |
| 2 | CREATE_FEED_FILTER |
Instance method | Public | Method | Create a Feed Filter | 20110801 |
| 3 | CREATE_TOPIC |
Instance method | Public | Method | Create a Topic in StreamWork | 20111021 |
| 4 | GET_ACTIVITY |
Instance method | Public | Method | Get a StreamWork Activity by the Activity ID | 20110801 |
| 5 | GET_ACTIVITY_QUERY |
Instance method | Public | Method | Get the API for Activity Queries | 20111006 |
| 6 | GET_APPLICATION_ID |
Instance method | Public | Method | Get the Application ID of the Current Instance | 20110801 |
| 7 | GET_CURRENT_USER |
Instance method | Public | Method | Get the API for Information on the Current User | 20110808 |
| 8 | GET_GW_CHANNEL |
Instance method | Public | Method | Get the Gateway Layer Wrapper | 20120621 |
| 9 | GET_ITEM |
Instance method | Public | Method | Get the API for a StreamWork Item | 20111101 |
| 10 | GET_SINGLE_USE_TOKEN |
Instance method | Public | Method | 20121112 | |
| 11 | GET_TASK |
Instance method | Public | Method | Get Task by ID | 20120719 |
| 12 | GET_TOPIC |
Instance method | Public | Method | Get the API for a StreamWork Feed Topic | 20111020 |
| 13 | GET_USER |
Instance method | Public | Method | Get the API for Information on a StreamWork User | 20110811 |
| 14 | SET_SCOPE |
Instance method | Public | Method | Set the Scope for the Following API Calls | 20120524 |
Events
Class IF_STW_API has no event.
Types
Class IF_STW_API has no local type.
Method Signatures
Method CREATE_ACTIVITY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IV_DUE_DATE | Call by reference | Type reference (TYPE) | IF_STW_ACTIVITY=>TV_ACTIVITY_DUE_DATE | 20120703 | |||
| 2 | Importing |
IV_NAME | Call by reference | Type reference (TYPE) | IF_STW_ACTIVITY=>TV_ACTIVITY_NAME | 20110801 | |||
| 3 | Importing |
IV_PRIVACY | Call by reference | Type reference (TYPE) | IF_STW_ACTIVITY=>TV_ACTIVITY_PRIVACY | 20110804 | |||
| 4 | Importing |
IV_PURPOSE | Call by reference | Type reference (TYPE) | IF_STW_ACTIVITY=>TV_ACTIVITY_PURPOSE | 20110803 | |||
| 5 | Importing |
IV_REMINDER | Call by reference | Type reference (TYPE) | IF_STW_ACTIVITY=>TV_ACTIVITY_REMINDER | 20120703 | |||
| 6 | Importing |
IV_SHARING | Call by reference | Type reference (TYPE) | IF_STW_ACTIVITY=>TV_ACTIVITY_SHARING | 20110801 | |||
| 7 | Importing |
IV_TEMPLATE_ID | Call by reference | Type reference (TYPE) | IF_STW_ACTIVITY=>TV_ACTIVITY_TEMPLATE_ID | 20110801 | |||
| 8 |  Returning |
RO_ACTIVITY | Value transfer | Object reference (TYPE REF TO) | IF_STW_ACTIVITY | 20110801 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_STW_ACTIVITY |
StreamWork Activity exceptions | 20110805 |
Method CREATE_FEED_FILTER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RO_FEED_FILTER | Value transfer | Object reference (TYPE REF TO) | IF_STW_FEED_FILTER | StreamWork Feed Filter | 20110801 |
Method CREATE_FEED_FILTER on class IF_STW_API has no exception.
Method CREATE_TOPIC Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_TOPIC_DESCRIPTION | Call by reference | Type reference (TYPE) | STW_TOPIC_DESCRIPTION | 20120526 | |||
| 2 | Importing |
IV_TOPIC_EXT_ENT_ID | Call by reference | Type reference (TYPE) | STW_TOPIC_EXT_ENT_ID | 20120526 | |||
| 3 | Importing |
IV_TOPIC_EXT_ENT_LINKBACK_URL | Call by reference | Type reference (TYPE) | STW_TOPIC_EXT_ENT_LINKBACK_URL | 20120526 | |||
| 4 | Returning |
RO_TOPIC | Value transfer | Object reference (TYPE REF TO) | IF_STW_TOPIC | ABAP representation of StreamWork topic | 20111021 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_STW_FEED |
20111206 |
Method GET_ACTIVITY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_ACTIVITY_ID | Call by reference | Type reference (TYPE) | STW_ACTIVITY_ID | StreamWork Activity ID | 20110801 | ||
| 2 | Returning |
RO_ACTIVITY | Value transfer | Object reference (TYPE REF TO) | IF_STW_ACTIVITY | 20110801 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_STW_ACTIVITY |
StreamWork Activity exceptions | 20110809 |
Method GET_ACTIVITY_QUERY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RO_ACTIVITY_QUERY | Value transfer | Object reference (TYPE REF TO) | IF_STW_ACTIVITY_QUERY | 20111006 |
Method GET_ACTIVITY_QUERY on class IF_STW_API has no exception.
Method GET_APPLICATION_ID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RV_APPLICATION_ID | Value transfer | Type reference (TYPE) | CLB_APPLICATION_ID | Collaboration: Application ID | 20110801 |
Method GET_APPLICATION_ID on class IF_STW_API has no exception.
Method GET_CURRENT_USER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RO_SW_USER | Value transfer | Object reference (TYPE REF TO) | IF_STW_CURRENT_USER | StreamWork current user | 20110808 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_STW_USER |
20110901 |
Method GET_GW_CHANNEL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RO_INSTANCE | Value transfer | Object reference (TYPE REF TO) | IF_STW_FEED_GW | Feed Representation at Gateway (Notification) | 20120621 |
Method GET_GW_CHANNEL on class IF_STW_API has no exception.
Method GET_ITEM Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_ITEM_ID | Call by reference | Type reference (TYPE) | IF_STW_ITEM=>TV_ITEM_ID | StreamWork Item ID | 20111101 | ||
| 2 | Returning |
RO_ITEM | Value transfer | Object reference (TYPE REF TO) | IF_STW_ITEM | StreamWork Item (generic) | 20111101 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_STW_ITEM |
StreamWork Item exceptions | 20111109 |
Method GET_SINGLE_USE_TOKEN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RV_TOKEN | Value transfer | Type reference (TYPE) | STRING | 20121112 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_STW_TECHNICAL |
20121112 |
Method GET_TASK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_TASK_ID | Call by reference | Type reference (TYPE) | STW_TASK_ID | 20120719 | |||
| 2 | Returning |
RO_TASK | Value transfer | Object reference (TYPE REF TO) | IF_STW_TASK | 20120719 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_STW_TASK |
20120719 |
Method GET_TOPIC Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_TOPIC_ID | Call by reference | Type reference (TYPE) | STW_TOPIC_ID | 20111020 | |||
| 2 | Returning |
RO_TOPIC | Value transfer | Object reference (TYPE REF TO) | IF_STW_TOPIC | ABAP representation of StreamWork topic | 20111020 |
Method GET_TOPIC on class IF_STW_API has no exception.
Method GET_USER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_BACKEND_USER_ID | Call by reference | Type reference (TYPE) | IF_STW_USER=>TV_BACKEND_USER_ID | User Name | 20110811 | ||
| 2 | Importing |
IV_SW_USER_EMAIL | Call by reference | Type reference (TYPE) | IF_STW_USER=>TV_SW_USER_EMAIL | StreamWork email address | 20110811 | ||
| 3 | Importing |
IV_SW_USER_ID | Call by reference | Type reference (TYPE) | STW_USER_SW_ID | StreamWork user id | 20110811 | ||
| 4 | Returning |
RO_SW_USER | Value transfer | Object reference (TYPE REF TO) | IF_STW_USER | StreamWork user | 20110811 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_STW_USER |
StreamWork User exceptions | 20110811 |
Method SET_SCOPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_SCOPE | Call by reference | Type reference (TYPE) | CLB_APPL_CONTEXT | Application Context for Collaboration | 20120524 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_STW_TECHNICAL |
technical error | 20120920 |
History
| Last changed by/on | SAP | 20140121 |
| SAP Release Created in |
