SAP ABAP Class CL_SMI_SOCIALDATA (Social Data API class)
Hierarchy
☛
SAP_BS_FND (Software Component) SAP Business Suite Foundation
⤷
CA-EPT-SMI (Application Component) Social Media Intelligence Foundation
⤷
BS_SOMI_DATA_MODELS (Package) Datta Models for Social Media Intelligence
⤷
⤷
Properties
| Class | CL_SMI_SOCIALDATA | |
| Short Description | Social Data API class | |
| Super Class | ||
| Instantiability of a Class | 0 | Private |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | BS_SOMI_DATA_MODELS | Datta Models for Social Media Intelligence |
| Created | 20130228 | SAP |
| Last change | 20140121 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class CL_SMI_SOCIALDATA has no forward declaration.
Interfaces
Class CL_SMI_SOCIALDATA has no interface implemented.
Friends
Class CL_SMI_SOCIALDATA has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Static Attribute | Private | Object reference (TYPE REF TO) | CL_SMI_SOCIALDATA | Social Post Data | 20130228 | |||
| 2 | Static Attribute | Private | Type reference (TYPE) | SMI_T_SOCIALDATA_BUFFER | Buffer Table Type for Social Data | 20130228 | |||
| 3 | Static Attribute | Protected | Type reference (TYPE) | SMI_T_SOCIALDATA_LOCK | Table type for lock mode | 20130228 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | Dequeue the lock and clear the buffer | 20130709 | |
| 2 | Instance method | Public | Method | Refresh the buffers | 20130228 | |
| 3 | Instance method | Public | Method | Create a social post | 20130228 | |
| 4 | Instance method | Public | Method | Delete Social Post Data | 20130228 | |
| 5 | Instance method | Public | Method | Deletes Social post data from the DB table and the buffer | 20130627 | |
| 6 | Instance method | Private | Method | Dequeues the lock | 20130228 | |
| 7 | Static method | Public | Method | Returns singleton instance | 20130228 | |
| 8 | Instance method | Public | Method | Get a Social Post | 20130228 | |
| 9 | Instance method | Public | Method | Get all Social Posts | 20130228 | |
| 10 | Instance method | Public | Method | Lock record during DB commit | 20130228 | |
| 11 | Instance method | Public | Method | Mark Social Post Absolute | 20131113 | |
| 12 | Instance method | Public | Method | Query social data by range | 20130228 | |
| 13 | Instance method | Public | Method | Query social data | 20130228 | |
| 14 | Instance method | Public | Method | Save to DB | 20130228 | |
| 15 | Instance method | Public | Method | Save Social Post data to DB | 20130627 | |
| 16 | Instance method | Public | Method | Update a social post | 20130228 |
Events
Class CL_SMI_SOCIALDATA has no event.
Types
Class CL_SMI_SOCIALDATA has no local type.
Method Signatures
Method CANCEL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_SOCIALDATAUUID | Call by reference | Type reference (TYPE) | SMI_SOCIALDATAUUID | Social Data Identifier | 20130709 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Social Media Exception | 20130709 |
Method CLEANUP Signature
Method CLEANUP on class CL_SMI_SOCIALDATA has no parameter.
Method CLEANUP on class CL_SMI_SOCIALDATA has no exception.
Method CREATE_SOCIAL_POST_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_SOCIAL_POST_DATA | Call by reference | Type reference (TYPE) | SOCIALDATA | Social Post Information of the Social Media Channel | 20130228 | |||
| 2 | IV_SOCIALDATAUUID | Call by reference | Type reference (TYPE) | SMI_SOCIALDATAUUID | Social Data Identifier | 20130709 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Social Media Exception | 20130228 | ||
| 2 | Error Class for UUID Processing Errors | 20130304 |
Method DELETE_FROM_BUFFER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_SOCIAL_POST_DATA | Call by reference | Type reference (TYPE) | SMI_S_SOCIALDATA | Social Post Information of the Social Media Channel | 20130228 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Social Media Exception | 20130228 |
Method DELETE_SOCIAL_POST_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_SOCIALDATAUUID | Call by reference | Type reference (TYPE) | SMI_SOCIALDATAUUID | Structure for social data table | 20130627 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Social Media Exception | 20130627 |
Method DEQUEUE_LOCK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_SOCIAL_POST_UUID | Call by reference | Type reference (TYPE) | SMI_SOCIALDATAUUID | Social Data Identifier | 20130627 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Social Media Exception | 20130228 |
Method GET_INSTANCE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RO_INSTANCE | Value transfer | Object reference (TYPE REF TO) | CL_SMI_SOCIALDATA | Social Data | 20130228 |
Method GET_INSTANCE on class CL_SMI_SOCIALDATA has no exception.
Method GET_SOCIAL_POST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ES_SOCIAL_DATA | Call by reference | Type reference (TYPE) | SMI_S_SOCIALDATA | Social Post Data | 20130304 | |||
| 2 | IV_SOCIALUUID | Call by reference | Type reference (TYPE) | SMI_SOCIALDATAUUID | Social Post ID | 20130319 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Social Media Exception | 20130228 |
Method GET_SOCIAL_POSTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_SOCIAL_DATA | Call by reference | Type reference (TYPE) | SMI_T_SOCIALDATA | Social Post Data | 20130304 | |||
| 2 | IV_CHANNEL_ID | Call by reference | Type reference (TYPE) | SMI_SOCIALMEDIACHANNEL | Social Media Channel Code | 20130228 | |||
| 3 | IV_LANGUAGE | Call by reference | Type reference (TYPE) | SMI_LANGUAGE | Language | 20130304 | |||
| 4 | IV_SEARCHTERM | Call by reference | Type reference (TYPE) | SMI_SOCIALPOSTSEARCHTERMTEXT | Search Term | 20130319 | |||
| 5 | IV_SOCIAL_POST_ID | Call by reference | Type reference (TYPE) | SMI_SOCIALPOST | Social Post ID | 20130304 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20130228 |
Method LOCK_RECORD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_LOCK_MODE | Call by reference | Type reference (TYPE) | ENQMODE | 'X' | Lock mode | 20130228 | ||
| 2 | IV_SOCIALDATAUUID | Call by reference | Type reference (TYPE) | SOCIALDATA-SOCIALDATAUUID | Social Data Unidue Identifier | 20130304 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Social Media Exception | 20130228 |
Method MARK_SOCIAL_POST_OBSOLETE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_SOCIALUUID | Value transfer | Type reference (TYPE) | SMI_SOCIALDATAUUID | Social Data Identifier | 20131113 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Social Media Exception | 20131113 |
Method QUERY_POST_DATA_BY_RANGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ES_MESSAGE | Call by reference | Type reference (TYPE) | BAPIRET2 | Return Parameter | 20130708 | |||
| 2 | ET_SOCIAL_DATA | Call by reference | Type reference (TYPE) | SMI_T_SOCIALDATA | Social Post Data | 20130304 | |||
| 3 | IT_ADVANCE_SEARCH | Call by reference | Type reference (TYPE) | SMI_T_ADVANCE_SEARCH | Search help Table for Advance Search | 20130627 | |||
| 4 | IT_CHANNEL | Call by reference | Type reference (TYPE) | SMI_T_SOCIALMEDIACHANNEL_RANGE | Range Table for channel | 20130228 | |||
| 5 | IT_CREATED_BY_USER | Call by reference | Type reference (TYPE) | SMI_T_SOCIALUSER_RANGE | Search Help User range table | 20130304 | |||
| 6 | IT_CREATION_DATETIME | Call by reference | Type reference (TYPE) | SMI_T_CREATIONDATETIME_RANGE | Search help Creation date time range table | 20130228 | |||
| 7 | IT_CREATION_USER_NAME | Call by reference | Type reference (TYPE) | SMI_T_CREATIONUSERNAME_RANGE | Search Help table for Social Post Creation User Name | 20130304 | |||
| 8 | IT_LANGUAGE | Call by reference | Type reference (TYPE) | SMI_T_LANGUAGE | Search Help Social Post Language | 20130304 | |||
| 9 | IT_ORDERED_BY | Call by reference | Type reference (TYPE) | SMI_T_ORDER_BY | Table type for Order By | 20130627 | |||
| 10 | IT_SOCIAL_POST_LINK | Call by reference | Type reference (TYPE) | SMI_T_SOCIALPOSTLINK_RANGE | Search Help table for Social post link | 20130304 | |||
| 11 | IT_SOCIAL_POST_TYPE | Call by reference | Type reference (TYPE) | SMI_T_SOCIALPOSTTYPE_RANGE | Search Help Social Post Type Range Tab | 20130304 | |||
| 12 | IV_MAX_HIT_NUMBER | Call by reference | Type reference (TYPE) | SMI_MAX_HIT_NUMBER | Maximum number of records retrieved | 20130627 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Social Media Exception | 20130228 |
Method QUERY_SOCIAL_POST_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ES_MESSAGE | Call by reference | Type reference (TYPE) | BAPIRET2 | Return Parameter | 20130708 | |||
| 2 | ET_SOCIAL_DATA | Call by reference | Type reference (TYPE) | SMI_T_SOCIALDATA | Table type for Social Post Data | 20130304 | |||
| 3 | IT_ADVN_SNGL_SRCH | Call by reference | Type reference (TYPE) | SMI_T_ADV_SNGL_SRCH | Table type for search for advance search | 20130627 | |||
| 4 | IT_ORDERED_BY | Call by reference | Type reference (TYPE) | SMI_T_ORDER_BY | Table type for Order By | 20130627 | |||
| 5 | IV_CHANNEL | Call by reference | Type reference (TYPE) | SMI_SOCIALMEDIACHANNEL | Social Media Channel Code | 20130228 | |||
| 6 | IV_CREATED_BY_USER | Call by reference | Type reference (TYPE) | SMI_SOCIALUSER | Social Post creation User ID | 20130304 | |||
| 7 | IV_CREATION_DATETIME | Call by reference | Type reference (TYPE) | SMI_CREATIONDATETIME | Post Creation Timestamp | 20130228 | |||
| 8 | IV_CREATION_USER_NAME | Call by reference | Type reference (TYPE) | SMI_CREATIONUSERNAME | Social Post Creation user name | 20130304 | |||
| 9 | IV_LANGUAGE | Call by reference | Type reference (TYPE) | SMI_LANGUAGE | Social Post Language | 20130304 | |||
| 10 | IV_MAX_HIT_NUMBER | Call by reference | Type reference (TYPE) | SMI_MAX_HIT_NUMBER | Maximum number of records retrieved | 20130627 | |||
| 11 | IV_SOCIAL_POST_LINK | Call by reference | Type reference (TYPE) | SMI_SOCIALPOSTLINK | Social Post Link | 20130304 | |||
| 12 | IV_SOCIAL_POST_TYPE | Call by reference | Type reference (TYPE) | SMI_SOCIALPOSTTYPE | Social Post Type | 20130304 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Social Media Exception | 20130228 |
Method SAVE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_NO_COMMIT | Call by reference | Type reference (TYPE) | BOOLE_D | Commit changes to DB | 20130228 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Social Media Exception | 20130228 |
Method SAVE_SOCIAL_POST_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_NO_COMMIT | Call by reference | Type reference (TYPE) | BOOLE_D | Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') | 20130627 | |||
| 2 | IV_SOCIALDATAUUID | Call by reference | Type reference (TYPE) | SMI_SOCIALDATAUUID | Structure for social data table | 20130708 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Social Media Exception | 20130627 |
Method UPDATE_SOCIAL_POST_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_SOCIAL_POST_DATA | Call by reference | Type reference (TYPE) | SOCIALDATA | Social Data of the Social Media Channel | 20130304 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Social Media Exception | 20130228 |
History
| Last changed by/on | SAP | 20140121 |
| SAP Release Created in | 747 |