SAP ABAP Class CL_WCF_UST_SHARE (CST Share)
Hierarchy
WEBCUIF (Software Component) SAP Web UI Framework
   CA-WUI-UI (Application Component) User Interface
     WCF_UST_CORE (Package) Central Sharing Tool - Core Objects
Properties
Class CL_WCF_UST_SHARE  
Short Description CST Share    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package WCF_UST_CORE   Central Sharing Tool - Core Objects 
Created 20090828   SAP 
Last change 20110908   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)
Interfaces
Class CL_WCF_UST_SHARE has no interface implemented.
Friends
Class CL_WCF_UST_SHARE has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 GC_MAX_ROLES_PER_USER_PARAM Constant Private Type reference (TYPE) INT1 5 Maximun number of role that can be assigned to support check 20091019
2 GT_CENTRAL_ITEMS Instance attribute Private Type reference (TYPE) LTY_T_CENTRAL_STATUS 20091014
3 GT_CHECK_RESULTS Instance attribute Private Type reference (TYPE) LTY_T_CHECK_RESULT 20091014
4 GT_ITEMS Instance attribute Private Type reference (TYPE) WCF_USTT_SHARABLE_ITEM Sharable items 20090828
5 GT_PREVIOUS_ITEMS Instance attribute Private Type reference (TYPE) WCF_USTT_SHARABLE_ITEM Sharable items 20091006
6 GT_PREVIOUS_RECIPIENTS Instance attribute Private Type reference (TYPE) WCF_USTT_RECIPIENT Share distribution list 20091006
7 GT_RECIPIENTS Instance attribute Private Type reference (TYPE) WCF_USTT_RECIPIENT Share distribution list 20090828
8 GV_MESSAGE Instance attribute Private Type reference (TYPE) WCF_UST_MESSAGE Sharing message 20090828
9 GV_SHARER Instance attribute Private Type reference (TYPE) WCF_UST_USER Sharer username 20090828
10 SR_CO Static Attribute Protected Object reference (TYPE REF TO) CL_WCF_UST_CONST UST Constants 20090828
11 SR_EXCEP Static Attribute Protected Object reference (TYPE REF TO) CL_WCF_EXCEPTION_REPORTER Services for raising exceptions 20090828
12 SR_FACTORY Static Attribute Protected Object reference (TYPE REF TO) CL_WCF_UST_FACTORY UST Factory 20090828
13 SR_PERSIST Static Attribute Protected Object reference (TYPE REF TO) CL_WCF_UST_PERSISTENCE UST Persistence 20090828
14 SR_SAVED_SEARCH_MANAGER Static Attribute Private Object reference (TYPE REF TO) CL_CRM_SHORTCUT_MANAGER Shortcut Manager 20091026
15 SR_SERVICES Static Attribute Protected Object reference (TYPE REF TO) CL_WCF_UST_SERVICES Services for UST 20090828
16 ST_CHECK_RESULTS Static Attribute Private Type reference (TYPE) LTY_T_CHECK_RESULT 20091016
17 SV_CHECKS_RUNNING Static Attribute Private Type reference (TYPE) BOOLEAN ABAP_FALSE Checks are running 20091016
18 SV_RFC_TASK Static Attribute Private Type reference (TYPE) CHAR8 '00000001' Character field, 8 characters long 20091013
Methods
# Method Level Visibility Method type Description Created on
1 ADD_ITEM Instance method Public Method Add a new item 20090828
2 ADD_ITEMS Instance method Public Method Add new items 20090828
3 ADD_ITEMS_TO_CENTRAL Instance method Private Method Adds items to central 20091026
4 ADD_RECIPIENT Instance method Public Method Add a new recipient 20090828
5 ADD_RECIPIENTS Instance method Public Method Add new recipients 20090828
6 CHECK Instance method Public Method Check share 20091014
7 CHECK_AUTH_ALL Instance method Private Method Checks if recipients has authorization to access share items 20091014
8 CHECK_AUTH_FOR_ITEM Instance method Private Method Triggers checks for an given item and all recipients 20091013
9 CHECK_AUTH_FOR_RECIPIENT Instance method Private Method Triggers checks for an given recipient and all items 20091013
10 CHECK_BEFORE_SHARING Instance method Public Method Check share 20091020
11 CHECK_ITEM_EXISTS Instance method Protected Method Checks if item exists 20091007
12 CHECK_RECIPIENT Instance method Private Method Checks in recipient is valid 20090828
13 CHECK_RECIPIENT_AUTH_RFC Instance method Private Method Triggers an Asynchronous RFC call to check recipent authorit 20091013
14 CLASS_CONSTRUCTOR Static method Public Constructor CLASS_CONSTRUCTOR 20090828
15 COLLECT_CHECK_RESULTS Static method Public Method Callback method for asyn call 20091013
16 COLLECT_SYN_CHECK_RESULTS Instance method Private Method Callback method for syn call 20091013
17 CONDENSE_CHECK_RESULTS Instance method Private Method Analyse the results and condense the result to fit the logic 20091014
18 CONSTRUCTOR Instance method Public Constructor CONSTRUCTOR 20090828
19 GET_ALL_ITEMS Instance method Public Method Returns shared item 20090831
20 GET_ITEM Instance method Public Method Returns a given item 20100224
21 GET_ITEMS Instance method Public Method Returns shared item 20090828
22 GET_MESSAGE Instance method Public Method Returns share message 20090828
23 GET_NEXT_TASK Instance method Private Method Return a new and yet unused task id for RFC 20091013
24 GET_RECENT_ITEMS Instance method Public Method Returns recent shared items 20091006
25 GET_RECENT_RECIPIENTS Instance method Public Method Returns recently used recipients 20091006
26 GET_RECIPIENTS Instance method Public Method Returns recipients 20090828
27 GET_SHARER Instance method Public Method Returns sharer username 20090828
28 LOAD_PREVIOUS_ITEMS Instance method Private Method Loads most recent items 20091016
29 ON_SEARCH_DELETED Instance method Private Event handling method Called when a Saved Search is deleted from Launcher 20100120
30 ON_SHAREBOX_SAVED Instance method Private Event handling method 20100125
31 PUSH_RECIPIENTS Instance method Protected Method Pushes recipients to all items 20090925
32 REMOVE_ITEM Instance method Public Method Removes an item from the share 20090828
33 REMOVE_RECIPIENT Instance method Public Method Removes a recipient from the list 20090828
34 RESET Instance method Public Method Reset share removing all elements 20091008
35 SAVE_DRAFT Instance method Public Method Saves items as Draft 20090828
36 SET_ITEM_CENTRAL_STATUS Instance method Public Method Sets item central status 20091014
37 SET_MESSAGE Instance method Public Method Sets share message 20090828
38 SHARE Instance method Public Method Share items 20090828
Events
# Event Type Visibility Description Created on
1 SAVED_DRAFT Instance Event
(0)
Public
(2)
New share is saved as Draft 20091005
2 SHARED Instance Event
(0)
Public
(2)
New share is saved 20091005
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 LTY_S_CENTRAL_STATUS Private See coding 20091014 BEGIN OF LTY_s_CENTRAL_STATUS, item TYPE wcf_ust_id, END OF LTY_s_CENTRAL_STATUS
2 LTY_S_CHECK_RESULT Private See coding 20091013 BEGIN OF LTY_S_CHECK_RESULT, role TYPE crmt_ui_profile, task TYPE string, item_id TYPE wcf_ust_id, type_id TYPE string, recipient TYPE wcf_usts_recipient, supported TYPE boolean, END OF LTY_S_CHECK_RESULT
3 LTY_T_CENTRAL_STATUS Private See coding 20091014 LTY_T_CENTRAL_STATUS TYPE STANDARD TABLE OF LTY_s_CENTRAL_STATUS
4 LTY_T_CHECK_RESULT Private See coding 20091013 LTY_T_CHECK_RESULT TYPE STANDARD TABLE OF LTY_S_CHECK_RESULT
Method Signatures

Method ADD_ITEM Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_ITEM Call by reference Object reference (TYPE REF TO) IF_WCF_UST_ITEM Item 20090925
# Exception Resumable Description Created on
1 CX_WCF_DATA_EXISTS Item already exists 20090828
2 CX_WCF_DATA_INVALID Provided item is invalid 20090828

Method ADD_ITEMS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_NEW_ITEMS Call by reference Type reference (TYPE) WCF_USTT_SHARABLE_ITEM Sharable items 20090828
# Exception Resumable Description Created on
1 CX_WCF_DATA_EXISTS One of the Items already exists 20090828
2 CX_WCF_DATA_INVALID Provided items are invalid 20090828

Method ADD_ITEMS_TO_CENTRAL Signature

Method ADD_ITEMS_TO_CENTRAL on class CL_WCF_UST_SHARE has no parameter.
Method ADD_ITEMS_TO_CENTRAL on class CL_WCF_UST_SHARE has no exception.

Method ADD_RECIPIENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_RECIPIENT Call by reference Type reference (TYPE) WCF_USTS_RECIPIENT Share distribution list 20090828
# Exception Resumable Description Created on
1 CX_WCF_DATA_EXISTS Recipient exists 20090828
2 CX_WCF_DATA_INVALID Provided recipient is invalid 20090828

Method ADD_RECIPIENTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_NEW_RECIPIENTS Call by reference Type reference (TYPE) WCF_USTT_RECIPIENT Share distribution list 20090828
# Exception Resumable Description Created on
1 CX_WCF_DATA_INVALID Provided recipients are invalid 20090828

Method CHECK Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_RECHECK Call by reference Type reference (TYPE) BOOLEAN ABAP_FALSE Re-run checks 20091014
# Exception Resumable Description Created on
1 CX_WCF_DATA_INVALID Invalid data 20091014

Method CHECK_AUTH_ALL Signature

Method CHECK_AUTH_ALL on class CL_WCF_UST_SHARE has no parameter.
# Exception Resumable Description Created on
1 CX_WCF_DATA_INVALID At least one recipient can accces to one share item 20091014

Method CHECK_AUTH_FOR_ITEM Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ITEM Call by reference Type reference (TYPE) WCF_UST_ID Central Sharing Tool ID 20091013

Method CHECK_AUTH_FOR_ITEM on class CL_WCF_UST_SHARE has no exception.

Method CHECK_AUTH_FOR_RECIPIENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_RECIPIENT Call by reference Type reference (TYPE) WCF_USTS_RECIPIENT 20091013

Method CHECK_AUTH_FOR_RECIPIENT on class CL_WCF_UST_SHARE has no exception.

Method CHECK_BEFORE_SHARING Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_RECHECK Call by reference Type reference (TYPE) BOOLEAN ABAP_FALSE Re-run checks 20091020
# Exception Resumable Description Created on
1 CX_WCF_DATA_INVALID Invalid data 20091020

Method CHECK_ITEM_EXISTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_ITEM Call by reference Object reference (TYPE REF TO) IF_WCF_UST_ITEM Share item 20091007
2 Importing IT_ITEMS Call by reference Type reference (TYPE) WCF_USTT_SHARABLE_ITEM Sharable items 20091007
# Exception Resumable Description Created on
1 CX_WCF_DATA_EXISTS Item exists 20091007

Method CHECK_RECIPIENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_RECIPIENT Call by reference Type reference (TYPE) WCF_USTS_RECIPIENT Share distribution list 20090828
# Exception Resumable Description Created on
1 CX_WCF_DATA_INVALID Provided recipient is invalid 20090828

Method CHECK_RECIPIENT_AUTH_RFC Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_RECIPIENT Call by reference Type reference (TYPE) WCF_USTS_RECIPIENT Share distribution list 20091014
2 Importing IT_ITEMS Call by reference Type reference (TYPE) WCF_USTT_SHARABLE_ITEM Sharable Item 20091013
3 Importing IT_ROLES Call by reference Type reference (TYPE) CRMT_UI_PROFILE_TAB Business Role 20091016

Method CHECK_RECIPIENT_AUTH_RFC on class CL_WCF_UST_SHARE has no exception.

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_WCF_UST_SHARE has no parameter.
Method CLASS_CONSTRUCTOR on class CL_WCF_UST_SHARE has no exception.

Method COLLECT_CHECK_RESULTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing P_TASK Call by reference Type reference (TYPE) CLIKE 20091013

Method COLLECT_CHECK_RESULTS on class CL_WCF_UST_SHARE has no exception.

Method COLLECT_SYN_CHECK_RESULTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_RESULTS Call by reference Type reference (TYPE) WCF_USTT_CHECK_RESULT Recipients check results 20091013

Method COLLECT_SYN_CHECK_RESULTS on class CL_WCF_UST_SHARE has no exception.

Method CONDENSE_CHECK_RESULTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing XT_RESULTS Call by reference Type reference (TYPE) LTY_T_CHECK_RESULT 20091019

Method CONDENSE_CHECK_RESULTS on class CL_WCF_UST_SHARE has no exception.

Method CONSTRUCTOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_ITEMS Call by reference Type reference (TYPE) WCF_USTT_SHARABLE_ITEM 20090828
2 Importing IT_RECIPIENTS Call by reference Type reference (TYPE) WCF_USTT_RECIPIENT Share distribution list 20090828
3 Importing IV_MESSAGE Call by reference Type reference (TYPE) WCF_UST_MESSAGE Sharing message 20090828
4 Importing IV_SHARER Call by reference Type reference (TYPE) WCF_UST_USER Sharer User Name 20090828

Method CONSTRUCTOR on class CL_WCF_UST_SHARE has no exception.

Method GET_ALL_ITEMS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RT_ITEMS Value transfer Type reference (TYPE) WCF_USTT_SHARABLE_ITEM Sharable items 20090831

Method GET_ALL_ITEMS on class CL_WCF_UST_SHARE has no exception.

Method GET_ITEM Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ID Call by reference Type reference (TYPE) WCF_UST_ID Central Sharing Tool ID 20100224
2 Returning RR_ITEM Value transfer Object reference (TYPE REF TO) IF_WCF_UST_ITEM Shared Item 20100224
# Exception Resumable Description Created on
1 CX_WCF_DATA_NOT_FOUND Item not found 20100224

Method GET_ITEMS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RT_ITEMS Value transfer Type reference (TYPE) WCF_USTT_SHARABLE_ITEM Sharable items 20090828

Method GET_ITEMS on class CL_WCF_UST_SHARE has no exception.

Method GET_MESSAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_MESSAGE Value transfer Type reference (TYPE) WCF_UST_MESSAGE Sharing message 20090828

Method GET_MESSAGE on class CL_WCF_UST_SHARE has no exception.

Method GET_NEXT_TASK Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_TASK Value transfer Type reference (TYPE) STRING 20091013

Method GET_NEXT_TASK on class CL_WCF_UST_SHARE has no exception.

Method GET_RECENT_ITEMS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_MAX_ITEMS Call by reference Type reference (TYPE) I 5 20091006
2 Returning RT_ITEMS Value transfer Type reference (TYPE) WCF_USTT_SHARABLE_ITEM Sharable items 20091006

Method GET_RECENT_ITEMS on class CL_WCF_UST_SHARE has no exception.

Method GET_RECENT_RECIPIENTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_MAX_RECIPIENTS Call by reference Type reference (TYPE) I 5 20091006
2 Returning RT_RECIPIENTS Value transfer Type reference (TYPE) WCF_USTT_RECIPIENT Share distribution list 20091006

Method GET_RECENT_RECIPIENTS on class CL_WCF_UST_SHARE has no exception.

Method GET_RECIPIENTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RT_RECIPIENTS Value transfer Type reference (TYPE) WCF_USTT_RECIPIENT Share distribution list 20090828

Method GET_RECIPIENTS on class CL_WCF_UST_SHARE has no exception.

Method GET_SHARER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_SHARER Value transfer Type reference (TYPE) WCF_UST_USER User Name 20090828

Method GET_SHARER on class CL_WCF_UST_SHARE has no exception.

Method LOAD_PREVIOUS_ITEMS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_SHARER Call by reference Type reference (TYPE) SYUNAME User Name 20091016

Method LOAD_PREVIOUS_ITEMS on class CL_WCF_UST_SHARE has no exception.

Method ON_SEARCH_DELETED Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing GUID Call by reference Attribute reference (LIKE) 20100120
2 Importing TYPE Call by reference Attribute reference (LIKE) 20100120

Method ON_SEARCH_DELETED on class CL_WCF_UST_SHARE has no exception.

Method ON_SHAREBOX_SAVED Signature

Method ON_SHAREBOX_SAVED on class CL_WCF_UST_SHARE has no parameter.
Method ON_SHAREBOX_SAVED on class CL_WCF_UST_SHARE has no exception.

Method PUSH_RECIPIENTS Signature

Method PUSH_RECIPIENTS on class CL_WCF_UST_SHARE has no parameter.
Method PUSH_RECIPIENTS on class CL_WCF_UST_SHARE has no exception.

Method REMOVE_ITEM Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_ITEM Call by reference Type reference (TYPE) WCF_USTS_SHARABLE_ITEM Share Item 20090828
# Exception Resumable Description Created on
1 CX_WCF_DATA_NOT_FOUND Item not found 20090828

Method REMOVE_RECIPIENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_RECIPIENT Call by reference Type reference (TYPE) WCF_USTS_RECIPIENT Share distribution list 20090828
# Exception Resumable Description Created on
1 CX_WCF_DATA_NOT_FOUND Data not found 20090828

Method RESET Signature

Method RESET on class CL_WCF_UST_SHARE has no parameter.
Method RESET on class CL_WCF_UST_SHARE has no exception.

Method SAVE_DRAFT Signature

Method SAVE_DRAFT on class CL_WCF_UST_SHARE has no parameter.
# Exception Resumable Description Created on
1 CX_WCF_OPERATION_FAILED Save failed 20090828

Method SET_ITEM_CENTRAL_STATUS 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) WCF_UST_ID Central Sharing Tool ID 20091014
2 Importing IV_NEW_STATUS Call by reference Type reference (TYPE) BOOLEAN New central status 20091014

Method SET_ITEM_CENTRAL_STATUS on class CL_WCF_UST_SHARE has no exception.

Method SET_MESSAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_MESSAGE Call by reference Type reference (TYPE) WCF_UST_MESSAGE Sharing message 20090828

Method SET_MESSAGE on class CL_WCF_UST_SHARE has no exception.

Method SHARE Signature

Method SHARE on class CL_WCF_UST_SHARE has no parameter.
# Exception Resumable Description Created on
1 CX_WCF_OPERATION_FAILED Share failed 20090828
Event Signatures

Event SAVED_DRAFT Signature
# Parameter Type Pass Value Optional Typing Method Associated Type Default value Description Created on
1 EV_ID Exporting Value transfer Type reference (TYPE) WCF_UST_ID Universal Sharing tool ID 20091005
2 EV_SHARER Exporting Value transfer Type reference (TYPE) SYUNAME User Name 20091005
3 EV_TYPE Exporting Value transfer Type reference (TYPE) WCF_UST_ITEM_TYPE Sharing item type 20091005

Event SHARED Signature
# Parameter Type Pass Value Optional Typing Method Associated Type Default value Description Created on
1 EV_ID Exporting Value transfer Type reference (TYPE) WCF_UST_ID Universal Sharing tool ID 20091005
2 EV_SHARER Exporting Value transfer Type reference (TYPE) SYUNAME Sharer 20091005
3 EV_TYPE Exporting Value transfer Type reference (TYPE) WCF_UST_ITEM_TYPE Sharing item type 20091005
History
Last changed by/on SAP  20110908 
SAP Release Created in 701