|
SAP NetWeaver 2004S SPS 10 | |||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||
| Packages that use UWLException | |
| com.sap.netweaver.bc.uwl | Contains API for main classes and interfaces used with UWL. |
| com.sap.netweaver.bc.uwl.admin | Provides API for administering the UWL. |
| com.sap.netweaver.bc.uwl.connect | Contains interfaces that define the interaction with different provider systems. |
| com.sap.netweaver.bc.uwl.substitution | This package contains interface and data definition for the substitution functionality presented in UWL. |
| Uses of UWLException in com.sap.netweaver.bc.uwl |
| Methods in com.sap.netweaver.bc.uwl that throw UWLException | |
IUWLSession |
IUWLService.beginSession(UWLContext context,
int idleTimeOutInSeconds)
This begins the session with UWL service. |
void |
IUWLService.endSession(UWLContext context)
This closes the session with UWL. |
IUWLConfigurationManager |
IUWLService.getConfigurationManager(UWLContext ctx)
Obtains the UWL Configuration Manager. |
IUWLItemManager |
IUWLService.getItemManager(UWLContext ctx)
Obtains the UWL Item Manager. |
IUWLAdmin |
IUWLService.getAdmin(UWLContext ctx)
Obtains the UWL admin. |
IUWLViewManager |
IUWLService.getViewManager(UWLContext ctx)
Obtains the UWL view manager. |
IPushChannel |
IUWLService.getPushChannel()
Returns the push channel that could be used for the Provider to do operations on UWL like sending items, deleting items etc. |
void |
IUWLService.registerProviderConnector(IProviderConnector pc)
This method registers the given provider connector with UWL service. |
void |
IUWLService.registerAttributeConnector(String ID,
IAttributeAccessConnector ac)
Registraton of Custom Attribute retrieval interface. |
void |
IUWLService.registerAttachmentConnector(String ID,
IAttachmentConnector ac)
Registration of Custom Attachment Connector. |
IUWLSubstitutionManager |
IUWLService.getSubstitutionManager(UWLContext ctx)
Only for internal usage. |
void |
IUWLService.registerProviderSubstitutionManager(IProviderSubstitutionManager psm)
This method registers the substitution manager of a given provider with UWL service. |
IUWLSession |
IUWLService.getUwlSessionForWebDynproClient(UWLContext context)
This method creates a UWL Client exclusively for WebDynpro clients with a timeout value of idle time=10 minutes. |
QueryResult |
IUWLItemManager.getItems(UWLContext context,
QueryProperties queryProps,
CompoundExpression filter)
Method to retrieve Items. |
QueryResult |
IUWLItemManager.getItemsForView(UWLContext context,
UWLView view,
QueryProperties queryProps,
CompoundExpression filter)
Method to retrieve Items for a particular View.If returned items are not fully uptodate, isPossiblyOutDated()
on the result return true. |
QueryResult |
IUWLItemManager.getItemsForItemType(UWLContext context,
String itemType,
QueryProperties queryProps,
CompoundExpression viewFilter)
Method to retrieve Items for a particular item type passed.If returned items are not fully uptodate, isPossiblyOutDated()
on the result return true. |
QueryResult |
IUWLItemManager.refreshCacheAndGetItems(UWLContext context,
UWLView view,
QueryProperties queryProps,
CompoundExpression viewFilter)
Connects to all providerConnectors and gets items from them. |
ItemCollection |
IUWLItemManager.filterItems(UWLContext context,
ItemCollection items,
CompoundExpression filter)
Filters items based upon the filter passed. |
QueryResult |
IUWLItemManager.search(UWLContext context,
String textToSearch,
UWLView view,
QueryProperties queryProps,
CompoundExpression filter)
Search in the cache for items matching the text. |
void |
IUWLItemManager.sortItems(UWLContext context,
ItemCollection items,
String[] sortKeys,
boolean[] sortOrder)
Method to explicitly sort the items based on the sort fields and the order passed. |
int[] |
IUWLItemManager.getTotalAndEmphasizedItemCountForView(UWLContext context,
UWLView view,
String configurationGroup,
String substitutedUser)
Returns items that need to be emphasized and total items in a particular View. |
ItemTypeCount[] |
IUWLItemManager.getItemTypesBySize(UWLContext ctx,
String configurationGroup,
String substitutedUser)
Returns most popular item types and their count. |
Set |
IUWLItemManager.getSubstitutedForUsersWithItems(UWLContext ctx,
String itemType)
Returns only those user ids for which the current user has substitued and has items for them. |
Attachment[] |
IUWLItemManager.getAttachmentHeaders(UWLContext context,
Item item)
Retreives the attachment headers for this item. |
void |
IUWLItemManager.populateAttachmentContent(UWLContext context,
Item item,
Attachment hollowAttachment)
Fills the content of the hollowAttachment depending upon the attachment type. |
void |
IUWLItemManager.populateAttachmentContents(UWLContext context,
Item item,
Attachment[] hollowAttachments)
Fills the content of the hollowAttachments depending upon the attachment type. |
Attachment |
IUWLItemManager.getPopulatedAttachment(UWLContext context,
long itemId,
String internalAttachmentId)
Locates an attachment identified by the internalAttachmentId for the item and populates it and returns. |
Item |
IUWLItemManager.getItemByUwlId(UWLContext context,
long uwlId,
boolean fillAllAttributes,
boolean fillDescription,
boolean fillAttachmentHeaders)
Method to retrieve an item. |
Item |
IUWLItemManager.getItemByExternalId(UWLContext context,
String connectorId,
String systemId,
String externalId)
|
Item |
IUWLItemManager.getSubProcessTrackingItem(UWLContext context,
Item parentItem)
Retrieves the sub process tracking item. |
Item |
IUWLItemManager.getItemByUwlId(UWLContext context,
long uwlId)
Same as getItemByUwlId(context,uwlId,true,true) |
Item |
IUWLItemManager.refreshAndGetItemByUwlId(UWLContext context,
long uwlId)
This method refreshes the item from the backend and returns it. |
String |
IUWLItemManager.getItemTypeForItem(UWLContext context,
long itemId)
Finds item type for the item identified by itemId. |
ProviderStatus[] |
IUWLItemManager.performAction(UWLContext context,
long[] itemKeys,
String action,
Map actionProperties)
Performs action on all the items whose keys are passed. |
ProviderStatus |
IUWLItemManager.performAction(UWLContext context,
Item item,
String action)
Performs action on the item passed. |
ProviderStatus |
IUWLItemManager.performAction(UWLContext context,
long itemId,
Action action,
Map actionProperties)
Call this method if and only if isActionLaunchable() returns false. |
ProviderStatus |
IUWLItemManager.performAction(UWLContext context,
Item item,
Action action,
Map actionProperties)
Call this method if and only if isActionLaunchable() returns false. |
ProviderStatus |
IUWLItemManager.performAction(UWLContext context,
String externalItemId,
String systemId,
String connector,
String action,
Map actionProperties)
Call this method if and only if isActionLaunchable() returns false. |
IActionHandler |
IUWLItemManager.getActionHandler(String handlerId)
Look up registered action handler by its id. |
String |
IUWLItemManager.getActionUrl(UWLContext context,
Item item,
Action action,
Map actionProperties)
This method should be called only if isActionLaunchable() returs true. |
String |
IUWLItemManager.getActionUrl(UWLContext context,
long[] itemIds,
String action)
Method that could be called to get one single url for launching multiple items. |
String |
IUWLItemManager.getActionUrl(UWLContext context,
long item,
String action)
This method should be called only if isActionLaunchable() returs true. |
Map |
IUWLItemManager.getActionProperties(UWLContext context,
Item item,
Action action,
Map actionProperties,
boolean needsItemValidation)
This method should be called only if Action is registered with the UI. |
boolean |
IUWLItemManager.isActionLaunchable(UWLContext context,
Item item,
Action action)
Finds if action passed for the item is of launchable type. |
Action |
IUWLItemManager.getActionForItem(UWLContext ctx,
Item item,
String actionName)
Searches for the action in the the configuration. |
Action |
IUWLItemManager.getDefaultActionForItem(UWLContext ctx,
Item item)
Searches in the configuration for default action defined for the Item's Itemtype. |
Action |
IUWLItemManager.getActionForItem(UWLContext ctx,
long itemId,
String actionName)
Looks in the configuration whether action is defined. |
Map |
IUWLItemManager.getAllActionsForItem(UWLContext context,
Item item)
Returns all the possible actions on that item, taken from the configuration and the provider connector itself. |
WorkLog |
IUWLItemManager.getHistoryForItem(UWLContext context,
Item item)
Return the history log data of the item, retrieved from the provider connector. |
void |
Attachment.setContent(Object content)
The content of attachment is set through this method. |
static Attachment |
Attachment.createForUpload(String title,
String filename,
String fileExtension,
Object content,
int type)
Creates an attachment instance for file uploading scenario. |
| Uses of UWLException in com.sap.netweaver.bc.uwl.admin |
| Methods in com.sap.netweaver.bc.uwl.admin that throw UWLException | |
IWebflowConfigurationAdmin.Result |
IWebflowConfigurationAdmin.loadConfiguration(UWLContext context,
IUWLConfigurationAdmin configAdmin,
boolean onlyNewSystems)
|
IWebflowConfigurationAdmin.Result |
IWebflowConfigurationAdmin.loadConfiguration(UWLContext context,
IUWLConfigurationAdmin configAdmin,
HashMap systemsToConfigure)
|
IWebflowConfigurationAdmin.SystemInfo[] |
IWebflowConfigurationAdmin.getSystems(IUWLConfigurationAdmin configAdmin)
|
String[] |
IUWLConfigurationManager.getPersonalizedViewIds(String userId)
Returns personalized view names for a user. |
UWLView |
IUWLConfigurationManager.getPersonalizedView(String userId,
String viewName)
Returns personalized view specified by viewName for the user specified by userId. |
NavigationNode |
IUWLConfigurationManager.getPersonalizedNavigationNode(String userId,
String nodeId)
|
NavigationNode[] |
IUWLConfigurationManager.getAllPersonalizedNavigationNodes(String userId)
|
String[] |
IUWLConfigurationManager.getAllPersonalizedNavigationNodeIds(String userId)
|
RegistrationResult |
IUWLConfigurationAdmin.registerConfiguration(UWLContext context,
String configurationName,
ConfigurationFile xmlorZipFile,
ConfigurationRoot.IConfigurationOwner configurationOwner)
Method for registering new Configurations with the Universal Worklist. |
RegistrationResult |
IUWLConfigurationAdmin.registerConfigurationXml(UWLContext context,
String configurationName,
InputStream xmlStream,
ConfigurationRoot.IConfigurationOwner owner)
Method for registering new Configurations with the Universal Worklist. |
RegistrationResult |
IUWLConfigurationAdmin.registerConfigurationZip(UWLContext context,
String configurationName,
InputStream xmlStream,
ConfigurationRoot.IConfigurationOwner owner)
Method for registering new Configurations with the Universal Worklist. |
RegistrationResult |
IUWLConfigurationAdmin.registerConfigurationForASystem(UWLContext ctx,
String namespace,
String system,
ConfigurationFile xmlOrZipFile,
ConfigurationRoot.IConfigurationOwner owner)
Method for registering Configuration specific to a system. |
void |
IUWLConfigurationAdmin.registerItemTypes(UWLContext context,
String configurationName,
List itemTypes,
ConfigurationRoot.IConfigurationOwner configurationOwner)
Registers itemTypes for the configuration passed. |
void |
IUWLConfigurationAdmin.registerConfiguration(UWLContext context,
String configurationName,
List itemTypes,
List views,
ConfigurationRoot.IConfigurationOwner configurationOwner)
Registers itemTypes and views for the configuration passed. |
void |
IUWLConfigurationAdmin.registerConfiguration(UWLContext context,
String namespace,
Collection itemTypes,
Collection views,
NavigationNode navigationRoot,
ConfigurationRoot.IConfigurationOwner owner)
Register ItemTypes, Views, NavigationRoot. |
void |
IUWLConfigurationAdmin.unregisterConfiguration(UWLContext context,
String configurationName)
Removes configuration from the Universal Worklist system. |
int |
IUWLConfigurationAdmin.unregisterConfigurationsBeginningWith(UWLContext context,
String namesBeginsWith)
Unregisters all configurations which begins with the text passed. |
ConfigurationInfo |
IUWLConfigurationAdmin.getConfigurationInfo(String configurationName)
|
String |
IUWLConfigurationAdmin.downloadXmlFromZip(String configurationName)
If configuration is registered as ZIP file then XML from inside the zip is returned. |
Object |
IUWLConfigurationAdmin.downloadConfigurationContent(String configurationName)
If configuration is registered as ZIP file then zip file InputStream is returned else string XML is returned |
void |
IUWLConfigurationAdmin.addPersonalized(UWLContext context,
UWLView view)
Adds view as personalized object |
int |
IUWLConfigurationAdmin.removePersonalizedView(UWLContext context,
String viewName)
Removes personalized view |
int |
IUWLConfigurationAdmin.removePersonalizedViewsForUser(String userId)
Removes all personalized views for the user |
int |
IUWLConfigurationAdmin.removePersonalized(String[] viewNames)
Removes all the personalized views passed for all the users. |
int |
IUWLConfigurationAdmin.removePersonalizedViewForAllUsers(String viewName)
Removes the personalized view for all the users. |
void |
IUWLConfigurationAdmin.addPersonalized(UWLContext context,
String navId,
NavigationNode node)
Adds a personalized navigation node for the user |
void |
IUWLConfigurationAdmin.removePersonalizedNavigationNode(UWLContext context,
String id)
Removes the personalized navigation node for the user |
void |
IUWLAdmin.cleanupExpiredItems(String system,
Date pushedBeforeThisDate)
Removes all expired items from the cache for the sytem specified. |
void |
IUWLAdmin.clearCache(String system)
Use with care, clears all the cache items. |
String[] |
IUWLAdmin.getSystemsWithItemsInCache()
Returns distinct sytem aliases which have items in UWL cache. |
List |
IUWLAdmin.getRunningPullChannels(UWLContext context)
Note: Strictly for internal usage and administration purpose only. |
List |
IUWLAdmin.getSystemsAndPercentageSuccess(UWLContext context)
Returns a list of SystemStatistics objects |
int |
IUWLAdmin.getTotalNumberOfActiveUsers(UWLContext context)
Note: Strictly for internal usage and administration purpose only. |
int |
IUWLAdmin.getNumberOfWorkerThreads(UWLContext context)
For internal purpose only. |
int |
IUWLAdmin.getNumberOfPendingJobs(UWLContext context)
For internal purpose only. |
long |
IUWLAdmin.getTotalProcessedJobs(UWLContext context)
For internal monitoring purpose only. |
void |
IPropertiesManager.updateConfiguration(String id,
Map properties,
IWebflowConfigurationAdmin.R3System system,
boolean activate,
UWLContext context)
Updates the configuration in the database |
void |
IPropertiesManager.deleteConfiguration(String id,
IWebflowConfigurationAdmin.R3System system,
UWLContext context)
Deletes the system configuration in the database |
void |
IPropertiesManager.updateConfig(Properties xproperties,
Map kmProperties)
internal use - change for 640. |
void |
IPropertiesManager.deactivateSystem(String connectorId,
String systemAlias,
String originalAlias)
For backward compatibility with older registrations. |
| Uses of UWLException in com.sap.netweaver.bc.uwl.connect |
| Subclasses of UWLException in com.sap.netweaver.bc.uwl.connect | |
class |
ConnectorException
This exception is thrown by connector related methods. |
| Methods in com.sap.netweaver.bc.uwl.connect that throw UWLException | |
List |
IPushChannel.pushItems(IProviderConnector pc,
IUser user,
ConnectorResult pushedItems)
Method used to push items to UWL. |
void |
IPushChannel.pushSharedItem(IProviderConnector pc,
Item item,
Set assignedUsers)
This is meant only for Adhoc Workflow Connector. |
boolean |
IPushChannel.updateItem(IProviderConnector pc,
UWLContext uwlContext,
Item item)
This method should be called if item is changed in the provider system. |
boolean |
IPushChannel.deleteItem(IProviderConnector pc,
UWLContext uwlContext,
Item item)
Method that deletes the item from the UWL cache. |
Item |
IPushChannel.getItemByKey(ItemKey key)
Connector implementation can get hold of an Item object using this method. |
ItemCollection |
IPushChannel.getItemsByKey(ItemKey key)
Connector implementation can get hold of an Items object using this method. |
ItemKey |
IPushChannel.getItemKeyByInternalId(long itemId)
Method that returns the Key for item. |
void |
IPushChannel.deleteSharedItemsWithExternalIds(IProviderConnector pc,
String system,
List externalIds)
This method deletes all shared items with external ids passed. |
void |
IPushChannel.attachSubProcess(IProviderConnector pc,
String userWhoCreatedItem,
long parentItemId,
String subProcessId)
Method to attach a sub process with an item. |
boolean |
IPushChannel.detachSubProcess(IProviderConnector pc,
UWLContext uwlContext,
long parentItemId,
Action action,
Map actionProperties)
Method to detach a sub process from an item. |
void |
IPushChannel.forceRefresh(String userId,
String providerId,
String systemId,
String itemType)
Force the refresh of items for a user from a particular provider and system on a particular item type |
String |
IMultiItemLauncher.getUrl(UWLContext context,
ItemCollection items,
Action action,
List actionPropertiesMap)
Constructs and returns a fully qualified URL based upon the Item and properties defined for the Action. |
void |
IEventResolutionServiceAdaptor.onItemChanged(Item item,
String actionName,
Map actionProperties)
Will be called by UWL service for alert items to notify the adaptor |
String |
IActionHandler.getUrl(UWLContext context,
Item item,
Action action,
Map properties)
Constructs and returns a fully qualified URL based upon the Item and properties defined for the Action. |
| Uses of UWLException in com.sap.netweaver.bc.uwl.substitution |
| Subclasses of UWLException in com.sap.netweaver.bc.uwl.substitution | |
class |
SubstitutionException
This exception is thrown by substitution related methods. |
|
SAP NetWeaver 2004S SPS 10 | |||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||