SAP ABAP Class IF_ICI_CCS_DB_CHAT (CCS CHAT DB access layer interface)
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_ICI_CCS_DB_CHAT | CCS CHAT DB access class | 20051215 |
Properties
| Class | IF_ICI_CCS_DB_CHAT | |
| Short Description | CCS CHAT DB access layer interface | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | ||
| Created | 20051214 | SAP |
| Last change | 20081007 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class IF_ICI_CCS_DB_CHAT has no interface implemented.
Friends
Class IF_ICI_CCS_DB_CHAT has no friend class.
Attributes
Class IF_ICI_CCS_DB_CHAT has no attribute.
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | chat changed event | 20051214 | |
| 2 | Instance method | Public | Method | chat new posting event | 20051214 | |
| 3 | Instance method | Public | Method | verifies if a chatline is busy | 20060407 | |
| 4 | Instance method | Public | Method | verifies if a chatline participats in a given session | 20051214 | |
| 5 | Instance method | Public | Method | looks for discrepencies between users- and chat table | 20051214 | |
| 6 | Instance method | Public | Method | to enhance a session | 20051214 | |
| 7 | Instance method | Public | Method | to create a session | 20051214 | |
| 8 | Instance method | Public | Method | finds participants for a given session | 20051214 | |
| 9 | Instance method | Public | Method | finds user to chatline, session and optional status | 20051214 | |
| 10 | Instance method | Public | Method | user to chatline | 20051214 | |
| 11 | Instance method | Public | Method | attributes of a session | 20051214 | |
| 12 | Instance method | Public | Method | all postings of a session | 20051214 | |
| 13 | Instance method | Public | Method | attributes for all sessions of a chatline | 20051214 | |
| 14 | Instance method | Public | Method | to go to wrapup mode | 20051214 | |
| 15 | Instance method | Public | Method | to join a session | 20051214 | |
| 16 | Instance method | Public | Method | to leave a session | 20051214 | |
| 17 | Instance method | Public | Method | to post a message | 20051214 | |
| 18 | Instance method | Public | Method | to update the participants list | 20051214 |
Events
Class IF_ICI_CCS_DB_CHAT has no event.
Types
Class IF_ICI_CCS_DB_CHAT has no local type.
Method Signatures
Method CHAT_CHANGED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CHAT_SESSION_ID | Call by reference | Type reference (TYPE) | STRING | 20051214 | ||||
| 2 | TASKID | Call by reference | Type reference (TYPE) | STRING | 20051214 | ||||
| 3 | USERID | Call by reference | Type reference (TYPE) | CHAR32 | Character field, length 32 | 20051214 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CCS Exceptions | 20051215 |
Method CHAT_NEW_POSTING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | APP_IDS | Call by reference | Type reference (TYPE) | ICI_CCS_APPLICATION_ID_T | transfer structure: table of application IDs | 20051214 | |||
| 2 | CHAT_CONTRIBUTION | Call by reference | Type reference (TYPE) | ICI_CCS_CHAT_POSTING | ICI specification: description of a chat session | 20051214 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CCS Exceptions | 20051215 |
Method CHECK_LINE_BUSY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | BUSY | Value transfer | Type reference (TYPE) | FLAG | General Flag | 20060407 | |||
| 2 | BUSY_EXC_DESIRED | Call by reference | Type reference (TYPE) | FLAG | General Flag | 20060407 | |||
| 3 | CHAT_LINE_ID | Call by reference | Type reference (TYPE) | STRING | 20060407 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CCS Exceptions | 20060407 |
Method CHECK_LINE_CONNECTED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CHAT_LINE_ID | Call by reference | Type reference (TYPE) | STRING | 20051214 | ||||
| 2 | CHAT_SESSION_ID | Call by reference | Type reference (TYPE) | STRING | 20051214 | ||||
| 3 | STATUS | Value transfer | Type reference (TYPE) | CHAR32 | Character field, length 32 | 20051214 | |||
| 4 | USERID | Call by reference | Type reference (TYPE) | CHAR32 | Character field, length 32 | 20051214 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CCS Exceptions | 20051215 |
Method CHECK_TABLE_CONSISTENCY Signature
Method CHECK_TABLE_CONSISTENCY on class IF_ICI_CCS_DB_CHAT has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CCS Exceptions | 20060113 |
Method CONFERENCE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CHAT_LINE_ID | Call by reference | Type reference (TYPE) | STRING | 20051214 | ||||
| 2 | CHAT_SESSION_ID | Call by reference | Type reference (TYPE) | STRING | 20051214 | ||||
| 3 | CHECK_INITIATOR | Call by reference | Type reference (TYPE) | FLAG | 'X' | General Flag | 20051214 | ||
| 4 | NEW_CHAT_LINE_ID | Call by reference | Type reference (TYPE) | STRING | 20051214 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CCS Exceptions | 20051215 |
Method CREATE_SESSION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CHAT_LINE_ID | Call by reference | Type reference (TYPE) | STRING | 20051214 | ||||
| 2 | CHAT_SESSION_ID | Call by reference | Type reference (TYPE) | STRING | 20051214 | ||||
| 3 | NEW_CHAT_LINE_ID | Call by reference | Type reference (TYPE) | STRING | 20051214 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CCS Exceptions | 20051215 |
Method FIND_CHAT_PARTICIPANTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CHAT_SESSION_ID | Call by reference | Type reference (TYPE) | STRING | 20051214 | ||||
| 2 | CHAT_STATUS | Call by reference | Type reference (TYPE) | STRING | '' | if required: chat status | 20060131 | ||
| 3 | PARTICIPANTS | Value transfer | Type reference (TYPE) | ICI_CCS_PARTICIPANT_T | transfer structure: table of participants | 20051214 | |||
| 4 | PROC_STATUS | Call by reference | Type reference (TYPE) | STRING | if required: processing status | 20060131 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CCS Exceptions | 20060113 |
Method FIND_CREATED_CHAT_USER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CHAT_LINE_ID | Call by reference | Type reference (TYPE) | STRING | 20051214 | ||||
| 2 | CHAT_SESSION_ID | Call by reference | Type reference (TYPE) | STRING | 20051214 | ||||
| 3 | CHAT_STATUS | Call by reference | Type reference (TYPE) | STRING | '' | only if required chat status | 20051214 | ||
| 4 | PROCESSING_STATUS | Call by reference | Type reference (TYPE) | STRING | '' | if only if required processing status | 20051214 | ||
| 5 | RETURN_VALUE | Value transfer | Type reference (TYPE) | STRING | 20051214 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CCS Exceptions | 20060113 |
Method FIND_USERID_TO_CHATLINE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CHAT_LINE_ID | Call by reference | Type reference (TYPE) | STRING | 20051214 | ||||
| 2 | FLAG_WORKMODE_READY | Call by reference | Type reference (TYPE) | FLAG | 'X' | General Flag | 20051214 | ||
| 3 | USER_ID | Value transfer | Type reference (TYPE) | STRING | 20051214 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CCS Exceptions | 20060113 |
Method GET_ATTRIBUTES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CHAT_LINE_ID | Call by reference | Type reference (TYPE) | STRING | chat line ID (container, e.g. mail address) | 20051214 | |||
| 2 | CHAT_SESSION_ID | Call by reference | Type reference (TYPE) | STRING | chat session ID (GUID) | 20051214 | |||
| 3 | SESSION_ATTRIBUTE | Value transfer | Type reference (TYPE) | ICI_CCS_CHAT_SESSION | transfer table: chat sessions | 20051214 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CCS Exceptions | 20051215 |
Method GET_DIALOG Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CHAT_SESSION_ID | Call by reference | Type reference (TYPE) | STRING | Character field, length 32 | 20051214 | |||
| 2 | RESPONSE | Value transfer | Type reference (TYPE) | ICI_CCS_CHAT_POSTING_T | transfer table: chat posting | 20051214 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CCS Exceptions | 20051215 |
Method GET_SESSIONS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CHAT_LINE_ID | Call by reference | Type reference (TYPE) | STRING | chat line ID (container, e.g. email address) | 20051214 | |||
| 2 | CHAT_SESSIONS | Call by reference | Type reference (TYPE) | ICI_CCS_CHAT_SESSION_T | transfer table: chat sessions | 20051214 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CCS Exceptions | 20051215 |
Method GOTO_WRAPUP Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CHAT_SESSION_ID | Call by reference | Type reference (TYPE) | STRING | 20051214 | ||||
| 2 | RESULT | Value transfer | Type reference (TYPE) | FLAG | General Flag | 20051214 | |||
| 3 | USERID | Call by reference | Type reference (TYPE) | CHAR32 | Character field, length 32 | 20051214 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CCS Exceptions | 20051215 |
Method JOIN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CHAT_LINE_ID | Call by reference | Type reference (TYPE) | STRING | 20051214 | ||||
| 2 | CHAT_SESSION_ID | Call by reference | Type reference (TYPE) | STRING | 20051214 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CCS Exceptions | 20051215 |
Method LEAVE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CHAT_LINE_ID | Call by reference | Type reference (TYPE) | STRING | 20051214 | ||||
| 2 | CHAT_SESSION_ID | Call by reference | Type reference (TYPE) | STRING | 20051214 | ||||
| 3 | CLEANTABLE | Call by reference | Type reference (TYPE) | FLAG | 'X' | General Flag | 20051214 | ||
| 4 | FORCED_LEAVE | Call by reference | Type reference (TYPE) | FLAG | '' | General Flag | 20051214 | ||
| 5 | USERID | Call by reference | Type reference (TYPE) | CHAR32 | Character field, length 32 | 20051214 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CCS Exceptions | 20051215 |
Method POST_MESSAGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CHAT_LINE_ID | Call by reference | Type reference (TYPE) | STRING | 20051214 | ||||
| 2 | CHAT_SESSION_ID | Call by reference | Type reference (TYPE) | STRING | 20051214 | ||||
| 3 | CONTENT_TEXT | Call by reference | Type reference (TYPE) | STRING | 20051214 | ||||
| 4 | FLAG_FILLMODE | Call by reference | Type reference (TYPE) | FLAG | '' | General Flag | 20051214 | ||
| 5 | USERID | Call by reference | Type reference (TYPE) | CHAR32 | Character field, length 32 | 20051214 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CCS Exceptions | 20051215 |
Method UPDATE_PARTICIPANTS_LIST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CHAT_SESSION_ID | Call by reference | Type reference (TYPE) | STRING | 20051214 | ||||
| 2 | USERID | Call by reference | Type reference (TYPE) | CHAR32 | Character field, length 32 | 20051214 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CCS Exceptions | 20060113 |
History
| Last changed by/on | SAP | 20081007 |
| SAP Release Created in |