|
SAP NetWeaver '04 | |||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||
| Packages that use WcmException | |
| com.sap.netweaver.bc.rf.common | Contains repository framework common interface. |
| com.sapportals.wcm.control.released.search | |
| com.sapportals.wcm.rendering.base | Contains interfaces for flexible rendering of explorer controls. |
| com.sapportals.wcm.rendering.collection | Contains interfaces for flexible rendering of collections or lists of resources. |
| com.sapportals.wcm.rendering.detailsoverview | Provides interfaces for plug-ins that render overviews on the details page. |
| com.sapportals.wcm.rendering.detailsproperties | Provides interfaces for rendering properties of items on the details page. |
| com.sapportals.wcm.rendering.layout | Represents a container for defining the layout of explorer controls. |
| com.sapportals.wcm.rendering.property | |
| com.sapportals.wcm.rendering.resource | Contains interfaces for rendering a resource on the user interface. |
| com.sapportals.wcm.rendering.screenflow | Contains interfaces to trigger a screenflow from within an ICommand or IMassCommand. |
| com.sapportals.wcm.rendering.screenflow.os | Contains ready-to-use screenflow and helper classes to create a screenflow that opens a new screen and returns to the initial screen after the user has finished a task. |
| com.sapportals.wcm.rendering.uicommand | Contains interfaces to render and execute commands for one or more resources. |
| com.sapportals.wcm.repository | Contains the repository framework interfaces and classes. |
| com.sapportals.wcm.repository.filter | Contains interfaces and classes to define repository filters. |
| com.sapportals.wcm.repository.manager | Contains interfaces for repository managers. |
| com.sapportals.wcm.repository.manager.entrypoints | API for implementing entry point providers
Package Specification
Purpose
The entrypoints package contains interfaces and abstract
classes, which are offering all neccessary methods to act as an entry points provider. |
| com.sapportals.wcm.repository.service | Contains the repository service factory interface. |
| com.sapportals.wcm.repository.service.accessstatistic | Provides a service that keeps track of the time and date of content access. |
| com.sapportals.wcm.repository.service.appproperties | Contains classes and interfaces to persist information related to resources on the database. |
| com.sapportals.wcm.repository.service.comment | Provides a service for handling comments related to resources. |
| com.sapportals.wcm.repository.service.discussion | The Discussion Thread Repository Service is responsible for creating, deleting and keeping track of discussions. |
| com.sapportals.wcm.repository.service.feedback | Provides a service for managing feedback on resources. |
| com.sapportals.wcm.repository.service.personalnote | Provides a service that manages personal notes for resources. |
| com.sapportals.wcm.repository.service.rating | Provides a service for evaluating resources. |
| com.sapportals.wcm.repository.service.statemanagement | Provides a service that keeps track of the status of resources. |
| com.sapportals.wcm.repository.service.subscription | Provides a service that creates and manages subscriptions for resources. |
| com.sapportals.wcm.repository.service.timebasedpublish | Provides a service that controls when resources in a repository are visible or hidden. |
| com.sapportals.wcm.repository.so | Contains interfaces for semantic objects. |
| com.sapportals.wcm.service | Contains the service factory. |
| com.sapportals.wcm.service.actioninbox | Provides a service that handles notifications by saving them as action items. |
| com.sapportals.wcm.service.applog | Provides logging functions for services and applications using the framework. |
| com.sapportals.wcm.service.cache | Provides a caching service. |
| com.sapportals.wcm.service.checkout | Provides a service to keep track of the checkout status of resources. |
| com.sapportals.wcm.service.crawler | Provides a service that crawls repositories to obtain references to resources. |
| com.sapportals.wcm.service.crawler.parameter | Parameters definitions for special crawlers. |
| com.sapportals.wcm.service.indexmanagement | Provides a service for managing indexes. |
| com.sapportals.wcm.service.indexmanagement.retrieval.classification | Provides functions for taxonomies and classification. |
| com.sapportals.wcm.service.indexmanagement.retrieval.search | Provides functions for searching and textmining. |
| com.sapportals.wcm.service.landscape | Provides a service for information on configured systems and logon credentials. |
| com.sapportals.wcm.service.mimehandler | Provides a service for managing information related to mime types. |
| com.sapportals.wcm.service.notificator | Provides a service for sending notifications. |
| com.sapportals.wcm.service.objecttypehandler | Provides a service to add arbitrary commands for resources. |
| com.sapportals.wcm.service.pipeline | Contains interfaces for transforming the layout and format of resources. |
| com.sapportals.wcm.service.pipeline.producer | Contains interfaces to prepare content for a transformation to a different layout or format. |
| com.sapportals.wcm.service.propertyconfig | Provides a service for the administration of metadata for resource properties. |
| com.sapportals.wcm.service.propertyconfig.renderer | Provides a service for rendering resource properties. |
| com.sapportals.wcm.service.propertystructure | Provides structuring information for properties. |
| com.sapportals.wcm.service.relation | Provides a service to persist relationships between relation operands. |
| com.sapportals.wcm.service.scheduler | Provides a service that controls the execution of tasks. |
| com.sapportals.wcm.service.taskqueue | Provides interfaces to write or read tasks in
a platform-wide queue and to monitor their status. |
| com.sapportals.wcm.service.urimapper | Provides a service that maps URIs to unique IDs. |
| com.sapportals.wcm.service.urlgenerator | Provides a service that returns URLs to access resources in the CM system. |
| com.sapportals.wcm.service.xcrawler | Provides a service that crawls repositories to obtain references to resources. |
| com.sapportals.wcm.service.xmlforms | Provides interfaces for the creation of forms and XML documents. |
| com.sapportals.wcm.service.xmlforms.validation | |
| com.sapportals.wcm.util.acl | Contains interfaces for ACLs and AclManagers with definitions for permissions, ACLs and ACL entries. |
| com.sapportals.wcm.util.cache | Contains interfaces and classes for caches that are in memory or persistent. |
| com.sapportals.wcm.util.channels | Contains interfaces and classes for sending messages to recipients. |
| com.sapportals.wcm.util.content | Contains classes for handling the content of resources. |
| com.sapportals.wcm.util.controlstatus | Provides a service for the UI to persist the status of rendering objects. |
| com.sapportals.wcm.util.events | Contains interfaces and classes for generic eventing. |
| com.sapportals.wcm.util.factories | Provides base classes for factory implementations. |
| com.sapportals.wcm.util.html | Contains classses that handle the parsing of HTML. |
| com.sapportals.wcm.util.http | A collection of classes and interfaces for client-side HTTP access. |
| com.sapportals.wcm.util.http.slim | An implementation of the com.sapportals.wcm.util.http interfaces. |
| com.sapportals.wcm.util.systemconfig | Contains interfaces and classes for system configuration. |
| com.sapportals.wcm.util.uri | Contains interfaces and classes to handle uniform resource identifiers (uri). |
| com.sapportals.wcm.util.usermanagement | Contains supplementary classes for user management. |
| Uses of WcmException in com.sap.netweaver.bc.rf.common |
| Methods in com.sap.netweaver.bc.rf.common that throw WcmException | |
IRid |
Rid.addPathSegment(java.lang.String segment)
Adds a path segment. |
| Uses of WcmException in com.sapportals.wcm.control.released.search |
| Methods in com.sapportals.wcm.control.released.search that throw WcmException | |
IQueryEntryList |
SearchQueryListBuilder.buildSearchQueryList()
Central method for building query entry list that takes all set conditions into account. |
IQueryEntryList |
SearchQueryListBuilder.buildDidYouMeanQueryEntries(IQueryEntryList oldQuery,
java.lang.String oldTerm,
java.lang.String didYouMeanTerm)
Provides an adapted new query entry list for a "Did You Mean" search. |
IQueryEntry |
SearchQueryListBuilder.buildQueryEntryTimeWindow(IPropertyName propertyName,
java.util.Date startDate,
java.util.Date endDate)
Simple method for building a time window query entry list. |
static java.lang.String |
SearchQueryListBuilder.getDidYouMeanTerm(IQueryEntryList queryEntryList,
java.lang.String oldSearchTerm)
Method extracts the "Did you mean" search term. |
IQueryEntry |
SearchQueryListBuilder.buildQueryEntryConnector(java.lang.String connector)
Builds a single query entry that can be used as the connection between two query entry lists. |
| Uses of WcmException in com.sapportals.wcm.rendering.base |
| Methods in com.sapportals.wcm.rendering.base that throw WcmException | |
IConfigurableRendererStatus |
StatusFactory.getStatusInstance(ICollection resource,
com.sapportals.wcm.repository.service.layout.IDebugContainer container)
Returns a new instance of a ILayoutController
If no configuration for the set of parameters can be retrieved or the
mapping entry is faulty, the default LayoutController of the factory is
returned. |
IConfigurableRendererStatus |
StatusFactory.getStatusInstance(ITypedResourceList list,
com.sapportals.wcm.repository.service.layout.IDebugContainer container)
|
StatusInformation |
MetaStatus.execute(IExecutable p0)
|
StatusInformation |
MetaStatus.execute(java.lang.String p0)
|
java.lang.String |
IProxy.createNavigationTarget(ICollection p0)
creates the needed information for a Link or Button to
offer navigation to the given ICollection. |
java.util.Hashtable |
IProxy.getParameters()
|
IUIBaseCommand |
IProxy.getCommand()
|
java.lang.String |
IProxy.createDispatchableID(java.lang.String handler,
java.util.ArrayList values)
creates an id that contains dispatch information. |
java.lang.String |
IProxy.createDispatchableID(java.lang.String handler,
java.lang.String value)
creates an id that contains dispatch information. |
IResourceListProvider |
IMassCommandSupporter.getResourceListProvider()
|
void |
IRendererStatus.setParent(ICollection parent)
sets the collection whose children are to be handled within this status. |
void |
IRendererStatus.setTypedResourceList(ITypedResourceList list,
IResourceContext context)
sets the ITypedResourceList, whose elements are handled within this
status. |
void |
IRendererStatus.setCurrentIndex(int index)
sets the index-attribute of the status to the given value. |
int |
IRendererStatus.getCurrentIndex()
|
void |
IRendererStatus.filter()
filters the internal list of resources. |
void |
IRendererStatus.refresh()
reloads resources from RF revokes all selections |
IRenderingEvent |
IDelegatedReceiver.onEvent(com.sapportals.htmlb.event.Event event)
|
abstract java.lang.String |
AbstractProxyControl.createNavigationTarget(ICollection collection)
creates the needed information for a Link or Button to
offer navigation to the given ICollection. |
abstract java.util.Hashtable |
AbstractProxyControl.getParameters()
|
abstract IUIBaseCommand |
AbstractProxyControl.getCommand()
|
java.lang.String[] |
AbstractProxyControl.getInputFromEntryControls()
iterates through all controls that implement the IInputFieldControlinterface and
asks for their input. |
java.util.ArrayList |
AbstractProxyControl.getEventValues(com.sapportals.htmlb.event.Event event)
|
java.lang.String |
AbstractProxyControl.createDispatchableID(java.lang.String handler,
java.util.ArrayList values)
|
java.lang.String |
AbstractProxyControl.createDispatchableID(java.lang.String handler,
java.lang.String value)
|
protected ILayoutObject |
AbstractFactory.getLayoutObject(IProxy proxy,
IResource outerResource,
IResource resource,
java.util.Hashtable table,
com.sapportals.wcm.repository.service.layout.customizing.flavor.IFlavor flavor,
boolean requires508)
This method is used by the classes that extend the AbstractFactory. |
protected ILayoutObject |
AbstractFactory.getLayoutObject(IProxy proxy,
ITypedResourceList resourcelist,
java.util.Hashtable table,
com.sapportals.wcm.repository.service.layout.customizing.flavor.IFlavor flavor,
boolean requires508)
|
protected void |
AbstractFactory.initialize()
This method is called when the class, that extends AbstractFactory, is instantiated
for the first time. |
StatusInformation |
ProxyStatus.execute(IExecutable p0)
|
StatusInformation |
ProxyStatus.execute(java.lang.String p0)
|
| Uses of WcmException in com.sapportals.wcm.rendering.collection |
| Methods in com.sapportals.wcm.rendering.collection that throw WcmException | |
void |
LightCollectionRenderer.setStartRow(int value)
|
int |
LightCollectionRenderer.getStartRow()
|
protected com.sapportals.htmlb.Component |
LightCollectionRenderer.renderPager(boolean hasMore,
int pageInterval,
int linkCount)
creates a new instance of a Pager and returns its results of the
render method. |
protected com.sapportals.htmlb.Component |
LightCollectionRenderer.renderSearchHeader()
|
com.sapportals.htmlb.Component |
LightCollectionRenderer.renderFolderTitle()
|
protected com.sapportals.htmlb.Component |
LightCollectionRenderer.renderBreadcrumb()
|
com.sapportals.htmlb.Component |
LightCollectionRenderer.renderItemSelectionMode(IResource res)
|
protected IResourceRenderer |
LightCollectionRenderer.getRenderer(IResource res)
|
com.sapportals.htmlb.Component |
LightCollectionRenderer.renderAll()
|
protected com.sapportals.htmlb.Component |
LightCollectionRenderer.renderDecorations(com.sapportals.htmlb.Component comp)
|
protected void |
LightCollectionRenderer.createComponentValueMap()
|
protected ComponentValueMap |
LightCollectionRenderer.getComponentValueMap()
|
protected com.sapportals.htmlb.Component |
LightCollectionRenderer.renderUI()
|
protected void |
LightCollectionRenderer.filterResourceList()
|
protected IRendererStatus |
LightCollectionRenderer.getIRS()
|
void |
LightCollectionRenderer.readInputData(com.sapportals.htmlb.page.DynPage page)
|
IRenderingEvent |
LightCollectionRenderer.onEvent(com.sapportals.htmlb.event.Event event)
|
protected IResourceList |
LightCollectionRenderer.getResourceList()
|
protected void |
LightCollectionRenderer.sortResourceList(IPropertyNameList list,
SortDefinition sd)
|
com.sapportals.htmlb.Component |
ICollectionRenderer.renderAll()
|
void |
ICollectionRenderer.readInputData(com.sapportals.htmlb.page.DynPage page)
reads out the input of the modifiable Components rendered by
the implementing class. |
void |
AbstractRendererStatus.setParent(ICollection collection)
sets the parent collection for the status. |
void |
AbstractRendererStatus.setTypedResourceList(ITypedResourceList resourcelist,
IResourceContext context)
sets the typed resource list attribute for this status At the same time, it sets the internal attribute for an ICollection to null
to prevent that a resource list and a collection with children are active within the status at the
same time. |
int |
AbstractRendererStatus.getCurrentIndex()
|
void |
AbstractRendererStatus.setCurrentIndex(int index)
|
void |
AbstractRendererStatus.refresh()
reloads resources from RF revokes all selections filters and sorts depending on the settings |
void |
AbstractRendererStatus.filter()
filters the current IResourceList attribute of the status
using the set IResourceListFilter and the IParameters.
|
protected void |
AbstractRendererStatus.initializeSelectionList()
|
StatusInformation |
AbstractRendererStatus.execute(IExecutable execution)
carries out the action described by the given parameter. |
StatusInformation |
AbstractRendererStatus.execute(java.lang.String execution)
different signature for this method. |
ICollectionRenderer |
CollectionRendererFactory.getCollectionRenderer(IProxy proxy,
ICollection collection,
com.sapportals.wcm.repository.service.layout.customizing.flavor.IFlavor flavor)
|
ICollectionRenderer |
CollectionRendererFactory.getCollectionRenderer(IProxy proxy,
ICollection currentFolder,
ICollection customizingCollection,
com.sapportals.wcm.repository.service.layout.customizing.flavor.IFlavor flavor)
|
ICollectionRenderer |
CollectionRendererFactory.getCollectionRenderer(IProxy proxy,
ITypedResourceList resourcelist,
com.sapportals.wcm.repository.service.layout.customizing.flavor.IFlavor flavor)
|
ResourcePropertyComparator |
SortHandler.comparator(IPropertyNameList list,
SortDefinition sd)
|
IComponentEvent |
ComponentFactory.decodeEvent(ICollectionRenderer renderer,
IProxy proxy,
com.sapportals.htmlb.event.Event event,
java.util.Map values)
creates a new IComponent from the component's alias found inside
the given event and let's it fire the returned IComponentEvent or
null.
|
java.lang.String |
ComponentFactory.createLinkID(IComponent component,
java.util.ArrayList values)
creates a unique ID that also holds the given IComponent's alias
and all the entries of the given ArrayList. |
java.lang.String |
ComponentFactory.createStaticLinkID(IComponent component,
java.util.ArrayList values,
java.lang.String id)
creates a unique ID that also holds the given IComponent's alias
and all the entries of the given ArrayList. |
void |
SearchRendererStatus.setSession(ISearchSession session)
|
void |
SearchRendererStatus.refresh()
central refresh of list to be displayed |
void |
SearchRendererStatus.setCurrentIndex(int index)
|
com.sapportals.htmlb.Component |
SelectionHandler.renderItemSelectionMode(IResource res)
|
com.sapportals.htmlb.Component |
SelectionHandler.renderCheckbox(IResource res,
java.lang.String selectionmode)
|
void |
SelectionHandler.readInputData(com.sapportals.htmlb.page.DynPage page)
|
static com.sapportals.htmlb.Component |
CollectionRendererUtil.renderDecorations(ICollectionRenderer collRenderer,
IProxy proxy,
com.sapportals.htmlb.Component comp,
java.util.Map componentValueMap,
IResource resource)
|
static com.sapportals.htmlb.Component |
CollectionRendererUtil.renderDecorations(ICollectionRenderer collRenderer,
IProxy proxy,
com.sapportals.htmlb.Component comp,
java.util.Map componentValueMap)
|
static com.sapportals.htmlb.Component |
CollectionRendererUtil.renderDecorationsOld(ICollectionRenderer collRenderer,
IProxy proxy,
com.sapportals.htmlb.Component comp,
java.util.Map componentValueMap)
|
com.sapportals.htmlb.Component |
AbstractCollectionRenderer.renderFolderTitle()
Description of the Method |
com.sapportals.htmlb.Component |
AbstractCollectionRenderer.renderAll()
|
void |
AbstractCollectionRenderer.readCheckBoxes()
Description of the Method |
protected void |
AbstractCollectionRenderer.filterResourceList()
|
protected void |
AbstractCollectionRenderer.sortResourceList()
|
protected IResourceRenderer |
AbstractCollectionRenderer.getRenderer(IResource res)
|
| Uses of WcmException in com.sapportals.wcm.rendering.detailsoverview |
| Methods in com.sapportals.wcm.rendering.detailsoverview that throw WcmException | |
com.sapportals.htmlb.Component |
IResourceDetailsOverview.renderOverviewContent(IResource resource,
IProxy proxy)
Description of the Method |
com.sapportals.htmlb.Component |
AbstractResourceDetailsOverview.render(com.sapportals.htmlb.Component headerContent,
com.sapportals.htmlb.Component overviewContent)
Description of the Method |
java.lang.String |
AbstractResourceDetailsOverview.createTarget(IUICommand command,
IProxy proxy)
Description of the Method |
| Uses of WcmException in com.sapportals.wcm.rendering.detailsproperties |
| Methods in com.sapportals.wcm.rendering.detailsproperties that throw WcmException | |
com.sapportals.htmlb.Component |
AbstractResourceDetailsProperties.render(java.lang.String header,
com.sapportals.htmlb.Component footerComponent)
Description of the Method |
protected java.lang.String |
AbstractResourceDetailsProperties.getPropertyLabel(IProperty property,
IResourceContext context)
|
java.util.List |
DetailsPage.getDetailsPropertiesList(IResource resource)
Gets the detailsPropertiesList attribute of the ResourcePropertiesFactory object |
java.util.List |
DetailsPage.getDetailsOverviewList(IResource resource)
|
| Uses of WcmException in com.sapportals.wcm.rendering.layout |
| Methods in com.sapportals.wcm.rendering.layout that throw WcmException | |
void |
IExtLayoutController.init()
this method is called by the LayoutControllerFactory when
the initialization of the implementing class is finished. |
ILayoutController |
LayoutControllerFactory.getLayoutController(IProxy proxy,
IResource resource)
Returns a new instance of a ILayoutController
If no configuration for the set of parameters can be retrieved or the
mapping entry is faulty, the default LayoutController of the factory is
returned. |
ILayoutController |
LayoutControllerFactory.getLayoutController(IProxy proxy,
ITypedResourceList resourcelist)
Returns a new instance of a ILayoutController
If no configuration for the set of parameters can be retrieved or the
mapping entry is faulty, the default LayoutController of the factory is
returned. |
com.sapportals.htmlb.Component |
ILayoutComposer.render()
creates and returns the visible components for the user. |
void |
ILayoutComposer.init()
|
protected abstract com.sapportals.htmlb.Component |
AbstractLayoutComposer.renderAll()
this method is called by the method render as defined in
the ILayoutController interface. |
abstract void |
AbstractLayoutComposer.init()
|
| Uses of WcmException in com.sapportals.wcm.rendering.property |
| Methods in com.sapportals.wcm.rendering.property that throw WcmException | |
com.sapportals.htmlb.Component |
IModelledPropertyRenderer.renderProperty(IProperty property,
IMetaName metaName,
IResource resource,
IProxy proxy,
com.sapportals.wcm.repository.service.layout.customizing.IParameters parameters)
|
| Uses of WcmException in com.sapportals.wcm.rendering.resource |
| Methods in com.sapportals.wcm.rendering.resource that throw WcmException | |
com.sapportals.htmlb.Component |
AbstractResourceRenderer.render()
|
com.sapportals.htmlb.Component |
AbstractResourceRenderer.render(IProperty property,
int linktype)
Description of the Method |
com.sapportals.htmlb.Component |
AbstractResourceRenderer.render(java.lang.String displayname,
int linktype)
Description of the Method |
com.sapportals.htmlb.Component |
AbstractResourceRenderer.render(IProperty property,
java.lang.String target)
Description of the Method |
com.sapportals.htmlb.Component |
AbstractResourceRenderer.renderAction()
Description of the Method |
com.sapportals.htmlb.Component |
AbstractResourceRenderer.renderIcon()
Description of the Method |
com.sapportals.htmlb.Component |
AbstractResourceRenderer.renderIconContentlink()
Description of the Method |
com.sapportals.htmlb.Component |
AbstractResourceRenderer.renderImage()
Description of the Method |
com.sapportals.htmlb.Component |
AbstractResourceRenderer.renderImageContentlink()
Description of the Method |
protected java.lang.String |
AbstractResourceRenderer.getDefaultIcon()
|
protected com.sapportals.htmlb.Component |
AbstractResourceRenderer.renderContentLink(IResource resource,
com.sapportals.htmlb.Component comp)
creates a link to show the content of the given resource. |
protected com.sapportals.htmlb.Component |
AbstractResourceRenderer.renderContentLink(com.sapportals.htmlb.Component comp)
creates a link to show the content of the given resource. |
protected com.sapportals.htmlb.Component |
AbstractResourceRenderer.renderDetailsLink(IResource resource,
com.sapportals.htmlb.Component comp)
|
protected java.lang.String |
AbstractResourceRenderer.getCustomImage(IPropertyName propertyName)
returns the complete path to access the custom image-file specified for the current IResource of the renderer. |
com.sapportals.htmlb.Component |
AbstractResourceRenderer.renderMetaProperty(IMetaName metaName,
boolean hasContentLink)
Description of the Method |
IProperty |
AbstractResourceRenderer.getProperty(IPropertyName name)
Gets the property attribute of the AbstractResourceRenderer object |
java.util.List |
AbstractResourceRenderer.getPropertyListByMetaName(IMetaName metaName)
Gets the propertyListByMetaName attribute of the AbstractResourceRenderer object |
void |
AbstractResourceRenderer.setPropertyBag(java.util.Map propertyBag)
Set a property bag for the resource. |
com.sapportals.htmlb.Component |
ResourceNavigationRenderer.renderContentLink(IResource resource,
com.sapportals.htmlb.Component comp)
creates a link to show the content of the given resource. |
com.sapportals.htmlb.Component |
ResourceNavigationRenderer.renderContentLink(IResource resource)
creates a link to show the content of the given resource. |
protected void |
ResourceRendererFactory.initialize()
|
IResourceRenderer |
ResourceRendererFactory.getResourceRenderer(IProxy proxy,
IResource outerResource,
IResource resource,
com.sapportals.wcm.repository.service.layout.customizing.flavor.IFlavor flavor)
returns a new instance of an IResourceRenderer.
|
IResourceRenderer |
ResourceRendererFactory.getResourceRenderer(IProxy proxy,
ITypedResourceList list,
IResource resource,
com.sapportals.wcm.repository.service.layout.customizing.flavor.IFlavor flavor)
returns a new instance of an IResourceRenderer.
|
com.sapportals.htmlb.Component |
IResourceRenderer.render()
renders the current IResource depending on the configuration
available for this resource and on the implementation of the rendering
class. |
com.sapportals.htmlb.Component |
IResourceRenderer.render(IProperty property)
Deprecated. since EP6, SP2_CP |
com.sapportals.htmlb.Component |
IResourceRenderer.render(IProperty property,
int linktype)
Deprecated. since EP6, SP2_CP |
com.sapportals.htmlb.Component |
IResourceRenderer.render(java.lang.String displayname,
int linktype)
Deprecated. since EP6, SP2_CP. Instead of this method, use |
com.sapportals.htmlb.Component |
IResourceRenderer.render(IProperty property,
java.lang.String target)
Deprecated. since EP6, SP2_CP |
com.sapportals.htmlb.Component |
IResourceRenderer.renderMetaProperty(IMetaName metaName,
boolean hasContentLink)
renders the given metaName of the current IResource |
com.sapportals.htmlb.Component |
IResourceRenderer.renderIcon()
Deprecated. since EP6, SP2_CP |
com.sapportals.htmlb.Component |
IResourceRenderer.renderAction()
Deprecated. since EP6, SP2_CP |
com.sapportals.htmlb.Component |
IResourceRenderer.renderIconContentlink()
Deprecated. since EP6, SP2_CP |
com.sapportals.htmlb.Component |
IResourceRenderer.renderImage()
Deprecated. since EP6, SP2_CP |
com.sapportals.htmlb.Component |
IResourceRenderer.renderImageContentlink()
Deprecated. since EP6, SP2_CP |
void |
IResourceRenderer.setPropertyBag(java.util.Map propertyBag)
Set a property bag for the resource. |
| Uses of WcmException in com.sapportals.wcm.rendering.screenflow |
| Methods in com.sapportals.wcm.rendering.screenflow that throw WcmException | |
IRenderingEvent |
IScreenflow.execute()
|
IRenderingEvent |
AbstractScreenflow.execute()
|
| Uses of WcmException in com.sapportals.wcm.rendering.screenflow.os |
| Methods in com.sapportals.wcm.rendering.screenflow.os that throw WcmException | |
IRenderingEvent |
OneStepScreenflow.execute()
This method will add the needed elements to the dynamic screenflow definition. |
IRenderingEvent |
OneStepMassScreenflow.execute()
This method will add the needed elements to the dynamic screenflow definition. |
| Uses of WcmException in com.sapportals.wcm.rendering.uicommand |
| Methods in com.sapportals.wcm.rendering.uicommand that throw WcmException | |
com.sapportals.htmlb.hovermenu.HoverMenu |
AbstractUIMenu.renderHoverMenu(IUIGroupCommand group,
IResource resource,
AbstractProxyControl proxy)
Render a hover menu for a IUIGroupCommand given |
protected boolean |
AbstractUIMenu.renderGroup(IUIGroupCommand group,
com.sapportals.htmlb.hovermenu.HoverMenu hoverMenu,
IResource resource,
AbstractProxyControl proxy,
boolean showSeparator,
boolean groupExpanded,
boolean groupIncluded)
Creates a hover menu component according with the input parameters |
java.lang.String |
AbstractUIMenu.createTarget(IUIGroupCommand group,
AbstractProxyControl proxy)
Creates a unique Id as String where are encoded the IUIGroupCommand
data |
java.lang.String |
AbstractUIMenu.createTarget(IExecCommand command,
AbstractProxyControl proxy)
Creates a unique Id as String where are encoded the IExecCommand
data |
java.lang.String |
AbstractUIMenu.createTarget(IMassExecCommand command,
AbstractProxyControl proxy)
Creates a unique Id as String where are encoded the IUIMassExecCommand
data |
com.sapportals.htmlb.Component |
UIIconMenu.renderMenu(IUIGroupCommand groupCommand,
IResource resource,
AbstractProxyControl proxy)
Creates a link menu component according with the input parameters |
protected void |
AbstractCommand.createResource(IResourceContext context,
RID rid)
creates an IResource from the given parameters and sets it as the
member variable. |
protected IResource |
AbstractCommand.createResource(java.lang.String uri)
creates an IResource from the given parameters and returns it. |
RenderingEvent |
AbstractCommand.execute(ScreenflowData data)
|
com.sapportals.htmlb.Component |
UITabMenu.renderMenu(IUIGroupCommand groupCommand,
IResource resource,
AbstractProxyControl proxy)
Creates a link menu component according with the input parameters |
com.sapportals.htmlb.Component |
IUIMenu.renderMenu(IUIGroupCommand groupCommand,
IResource resource,
AbstractProxyControl newProxy)
Creates a menu component according with the input parameters |
java.lang.String[] |
AbstractUIMassCommand.getTargetParameters()
Deprecated. returns null. |
void |
AbstractUIMassCommand.setTargetParameters(java.util.List values,
IResourceContext context)
Deprecated. sets the given parameters for this class. |
java.util.ArrayList |
UICommandFactory.createTargetValues(IExecCommand command)
returns the arraylist with all the information needed by the given IUICommand
to do its work. |
java.util.ArrayList |
UICommandFactory.createTargetValues(IMassExecCommand command)
returns the arraylist with all the information needed by the given IUIMassCommand
to do its work. |
IUIBaseCommand |
UICommandFactory.decodeTargetCommand(java.util.ArrayList values,
IResourceContext context,
IProxy proxy)
returns a properly created instance of an IUICommand as it was
encoded in the given array list by the factories createTarget.
|
IExecCommand |
UICommandFactory.decodeTarget(java.util.ArrayList values,
IResourceContext context,
IProxy proxy)
returns a properly created instance of an IUICommand as it was
encoded in the given array list by the factories createTarget.
|
IMassExecCommand |
UICommandFactory.decodeMassTarget(java.util.ArrayList values,
IResourceContext context,
IProxy proxy)
returns a properly created instance of an IUIMassCommand as it
was encoded in the given array list by the factories createTarget
. |
IUIGroupCommand |
UICommandFactory.getGroupCommand(IResource resource,
com.sapportals.wcm.repository.service.layout.customizing.IParameterName group,
com.sapportals.wcm.repository.service.layout.customizing.flavor.IFlavor flavor,
java.util.Hashtable table)
returns the configured group command for the given resource. |
com.sapportals.htmlb.Component |
UIMenuBar.renderMenu(IUIGroupCommand groupCommand,
IResource resource,
AbstractProxyControl proxy)
creates a menu bar component according with the input parameters |
com.sapportals.htmlb.Component |
UILinkMenu.renderMenu(IUIGroupCommand groupCommand,
IResource resource,
AbstractProxyControl proxy)
Creates a link menu component according with the input parameters |
com.sapportals.htmlb.Component |
UIVerticalLinkMenu.renderMenu(IUIGroupCommand groupCommand,
IResource resource,
AbstractProxyControl proxy)
Creates a link menu component according with the input parameters |
IRenderingEvent |
ISimpleMassExecution.execute(IResourceList list,
com.sapportals.htmlb.event.Event event)
|
com.sapportals.htmlb.Component |
UIMenuFactory.getRenderMenu(IResource resource,
java.lang.String menuType,
com.sapportals.wcm.repository.service.layout.customizing.IParameterName group,
com.sapportals.wcm.repository.service.layout.customizing.flavor.IFlavor flavor,
IProxy proxy)
Renders a menu component ( menu bar, hover menu, button menu or link menu) according with the input data |
com.sapportals.htmlb.Component |
UIMenuFactory.renderMenuForGroup(IResource resource,
java.lang.String menuType,
IUIGroupCommand groupCommand,
IProxy proxy)
Renders a menu component ( menu bar, hover menu, button menu or link menu) according with the input data |
com.sapportals.htmlb.Component |
UIMenuFactory.getRenderMenu(IResource resource,
java.lang.String menuType,
com.sapportals.wcm.repository.service.layout.customizing.IParameterName group,
java.lang.String groupID,
com.sapportals.wcm.repository.service.layout.customizing.flavor.IFlavor flavor,
IProxy proxy)
Renders a menu component ( menu bar, hover menu, button menu or link menu) according with the input data |
com.sapportals.htmlb.Component |
UIMenuFactory.getRenderMenu(IResource resource,
java.lang.String menuType,
com.sapportals.wcm.repository.service.layout.customizing.IParameterName group,
java.lang.String groupID,
com.sapportals.wcm.repository.service.layout.customizing.flavor.IFlavor flavor)
Renders a menu component ( menu bar, hover menu, button menu or link menu) for a command group which have only command which generate external links and no proxy is needed |
com.sapportals.htmlb.Component |
UISmallButtonMenu.renderMenu(IUIGroupCommand groupCommand,
IResource resource,
AbstractProxyControl proxy)
Creates a small button menu component according with the input parameters |
protected void |
AbstractUICommand.createResource(IResourceContext context,
RID rid)
Creates an IResource from the given parameters and sets it as the
member variable. |
protected IResource |
AbstractUICommand.createResource(java.lang.String uri)
Creates a IResource for a given uri |
com.sapportals.htmlb.Component |
UIToolbarButtonMenu.renderMenu(IUIGroupCommand groupCommand,
IResource resource,
AbstractProxyControl proxy)
Creates a small button menu component according with the input parameters |
java.lang.String[] |
AbstractMassCommand.getTargetParameters()
returns null. |
void |
AbstractMassCommand.setTargetParameters(java.util.List values,
IResourceContext context)
sets the given parameters for this class. |
com.sapportals.htmlb.Component |
UICommandRenderer.renderMassAction(IResource res,
com.sapportals.wcm.repository.service.layout.customizing.IParameterName parameterName)
renders the IUIGroupCommand defined for the given resource. |
com.sapportals.htmlb.Component |
UICommandRenderer.renderCollectionAction(IResource res,
com.sapportals.wcm.repository.service.layout.customizing.IParameterName parameterName)
renders the IUIGroupCommand defined for the given resource. |
com.sapportals.htmlb.Component |
UICommandRenderer.renderAction(IResource res,
com.sapportals.wcm.repository.service.layout.customizing.IParameterName parameterName)
renders the IUIGroupCommand defined for the given resource. |
com.sapportals.htmlb.Component |
UICommandRenderer.renderAsLink(IResource res,
com.sapportals.wcm.repository.service.layout.customizing.IParameterName parameterName)
renders the IUIGroupCommand defined for the given resource as
a list of links. |
com.sapportals.htmlb.Component |
UICommandRenderer.renderAsIcon(IResource res,
com.sapportals.wcm.repository.service.layout.customizing.IParameterName parameterName)
renders the IUIGroupCommand defined for the given resource as
a hover menu, opening from an icon. |
IRenderingEvent |
ICommand.execute(IScreenflowData data)
carries out the wanted functionality on the given IResource and
might start a screenflow to do so. |
IRenderingEvent |
ISimpleExecution.execute(IResource res,
com.sapportals.htmlb.event.Event event)
|
com.sapportals.htmlb.Component |
UIHoverMenu.renderMenu(IUIGroupCommand groupCommand,
IResource resource,
AbstractProxyControl proxy)
Creates a hover menu component according with the input parameters |
com.sapportals.htmlb.Component |
UIButtonMenu.renderMenu(IUIGroupCommand groupCommand,
IResource resource,
AbstractProxyControl proxy)
Creates a button menu component according with the input parameters |
void |
IExecCommand.setTargetParameters(java.util.List p0,
IResourceContext p1)
sets the parameters the command returned in its getTargetParameters
method as well as the resource context. |
java.lang.String[] |
IExecCommand.getTargetParameters()
returns the information the command needs to carry out its task, when it is called through its execute method. |
IRenderingEvent |
IMassCommand.execute(IScreenflowData data)
carries out the wanted functionality on the given IResource and
might start a screenflow to do so. |
IRenderingEvent |
ISelector.execute(IResourceList list,
IProxy currentproxy)
Carries out the action on the IResourceList found in
the imported list, using the information from the current screen found inside the proxy. |
| Uses of WcmException in com.sapportals.wcm.repository |
| Subclasses of WcmException in com.sapportals.wcm.repository | |
class |
AbstractPropertyException
Abstract base class for property exceptions. |
class |
AccessDeniedException
Access to a resource or property is denied because the user does not have the required authorization. |
class |
AuthorizationRequiredException
The user is not authorized. |
class |
CheckedOutException
The resource is checked out by another user. |
class |
ExpectedCheckInRIDException
The RID of the new revision is different from the RID that the application excepted when chacking out. |
class |
ExpectedCheckInURIException
Deprecated. as of NW04. |
class |
ExternalLinkException
The requested RID contains an external link. |
class |
IllegalPropertyNameException
Raised when a property name was not acceptable. |
class |
IncompleteOperationException
An operation did not complete because of precondition failures. |
class |
InternalLinkException
The requested RID contains an internal link to a collection. |
class |
InvalidArgumentException
One ore more invalid values where provided for the parameters of a method. |
class |
InvalidNameException
The application tried to use a invalid resource name |
class |
InvalidPositionException
The required positioning was not valid (usually because the referenced collection member did not exist). |
class |
InvalidTargetException
An invalid target was used for a copy or move operation. |
class |
InvalidUriException
An invalid URI was used. |
class |
IOErrorException
An IO error occured while trying to access a resource. |
class |
LabelAlreadyExistsException
The application tried add a label that already exists in the version history. |
class |
LinkLoopException
The target RID specified when creating or updating am internal link is also a link and would cause an loop. |
class |
LockedException
The resource was locked by another user. |
class |
LockNotFoundException
The requested lock does not exist. |
class |
MethodNotAllowedException
The resource does not support the operation |
class |
NameAlreadyExistsException
The application tried to use a name for a new resource that already exists in the collection. |
class |
NoContentException
The resource has no content |
class |
NoRevisionException
The resource is not a revision resource. |
class |
NotCheckedOutException
The resource is not checked out |
class |
NotOrderedException
An attempt was made to perform an ordering operation on an unordered collection. |
class |
NotSupportedException
The repository manager does not support the operation. |
class |
NotVersionedException
The application tried to check out a resource that is not versioned. |
class |
PropertyMandatoryException
The property could not be removed because it is mandatory. |
class |
PropertyNameTooLongException
Raised when a property name was too long. |
class |
PropertyReadOnlyException
The property cannot be changed because it is read-only. |
class |
PropertyTypeLostException
Raised when a property was set, but the repository didn't support the desired type. |
class |
PropertyTypeMismatchException
Raised when an attempt was made to set a protected property with a non-applicable data type. |
class |
PropertyUnchangedException
Raised when a property change couldn't be commited due to a failed dependency on another change. |
class |
PropertyValueTooBigException
Raised when a property value was too big. |
class |
ResourceException
Resource Exception. |
class |
ResourceIsLinkException
This exception is thrown during copy or move operations if the
CopyParameter has copyInternalLink or copyExternalLink set to
true and links are encountered during a deep copy operation.
|
class |
ResourceNotCollectionException
Indicates that the resource has changed to a non-collection since the IResource object was obtained. |
class |
ResourceNotFoundException
Indicates that a resource could not be found. |
class |
ResourceReadOnlyException
The resource is read-only. |
class |
RevisionResourceException
The operation is not available because the resource is a revision. |
class |
ServiceUnavailableException
A service is not available. |
class |
SetPropertiesException
This exception indicates errors during a call. |
class |
UnassignableNameException
Raised when the name can not be assigned because (1) a "similar" name already exists (for instance, if "a" already exists in a case-preserving but not case-sensitive repository, and creation of "A" was attempted) or (2) the name is syntactically legal, but can not be reassigned to a new resource (stable names for versions and version histories). |
class |
VersionHasDescendantsException
The checkout operation failed because the version to be checked out has descendants in it's version history and the resulting version history fork is not allowed in current context. |
class |
VersionHistoryInUseException
ResourceException thrown if someone tries to create a Vcr in a workspace that already contains a vcr with the same version history. |
class |
VersionIsCheckedOutException
The checkout operation failed because the version to be checked out is already the checked out version of some other version controlled resource and the resulting version history fork is not allowed in current context. |
class |
VirusContentException
This exception is raised when a check reveals that content being read/written possibly contains a Virus. |
| Methods in com.sapportals.wcm.repository that throw WcmException | |
void |
TypedResourceList.setPropertyBag(IResource res,
java.util.Map propertyBag)
|
java.lang.String |
Property.getDescription()
|
java.lang.String |
Property.getDescription(IResourceContext context)
|
java.lang.String |
IProperty.getDescription()
Returns the description of the property |
java.lang.String |
IProperty.getDescription(IResourceContext context)
|
void |
ITypedResourceList.setPropertyBag(IResource resource,
java.util.Map propertyBag)
Set a property bag for a resource contained in the list. |
| Uses of WcmException in com.sapportals.wcm.repository.filter |
| Subclasses of WcmException in com.sapportals.wcm.repository.filter | |
class |
FilterConfigurationException
The application tried to check out a resource that is not versioned. |
| Methods in com.sapportals.wcm.repository.filter that throw WcmException | |
RID |
IRidFilter.filter()
Returns the resulting RID (can be the unchanged original RID). |
INamespaceFilter |
INamespaceFilterManager.getFilterForRead(INamespaceFilter nmspFilter,
NamespaceFilterMode mode)
Returns a read filter object that should be applied to the resource list of the predecessor filter. |
INamespaceFilter |
INamespaceFilterManager.getFilterForWrite(INamespaceFilter nmspFilter)
Returns a write filter objects |
IUriFilter |
IUriFilterManager.getFilter(URI uri,
IResourceContext context)
Deprecated. Returns a filter object that should be applied to the URI. |
protected void |
AbstractFilterManager.startUp()
Deprecated. As of EP 5.0 SP5, replaced by AbstractFilterManager.shutDownImpl(). |
protected void |
AbstractFilterManager.shutDown()
Deprecated. As of EP 5.0 SP5, replaced by AbstractFilterManager.startUpImpl(). |
IContentFilter |
IContentFilterManager.getFilterForRead(IContentFilter contentFilter)
Returns a read filter object that should be applied to the content of the predecessor filter. |
IContentFilter |
IContentFilterManager.getFilterForWrite(IContentFilter contentFilter)
Returns a write filter objects. |
IRidFilter |
IRidFilterManager.getFilter(RID rid,
IResourceContext context)
Returns a filter object that will be used to process the RID or null
. |
IResource |
IContentFilter.getResource()
Returns the resource that will be filtered. |
URI |
IContentFilter.getURI()
Deprecated. as of NW04. |
IRepositoryManager |
IContentFilter.getRepositoryManager()
Returns the repository manager of the new resource in case the write filter is applied before a create operation. |
IPropertyFilter |
IPropertyFilterManager.getFilterForRead(IPropertyFilter propFilter)
Returns a read filter object that should be applied to the property map of the predecessor filter. |
IPropertyFilter |
IPropertyFilterManager.getFilterForWrite(IPropertyFilter propFilter)
Returns a write filter objects |
ICollection |
INamespaceFilter.getCollection()
Returns the collection if the filter is applied on getChilden(). |
IResourceList |
INamespaceFilter.filter()
Returns the filtered resource list. |
IResource |
AbstractPropertyFilter.getResource()
|
URI |
AbstractPropertyFilter.getURI()
|
IRepositoryManager |
AbstractPropertyFilter.getRepositoryManager()
|
PropertyFilterMode |
AbstractPropertyFilter.getFilterMode()
|
IPropertyNameList |
AbstractPropertyFilter.getPropertyNameList()
|
void |
IFilterFactory.register(java.lang.String filterID,
java.lang.String repMgrID)
Register a filter for an additional repository manager. |
void |
IFilterFactory.register(java.lang.String filterID,
java.lang.String repMgrID,
java.util.Properties filterConfig)
Register a new filter for a repository manager. |
void |
IFilterFactory.unregister(java.lang.String filterID,
java.lang.String repMgrID)
Unregister a filter |
IResource |
IPropertyFilter.getResource()
Returns the resource that will be filtered. |
URI |
IPropertyFilter.getURI()
Returns the URI of the new resource in case the property write filter is applied to a create operation. |
IRepositoryManager |
IPropertyFilter.getRepositoryManager()
Returns the repository manager of the new resource in case the write filter is applied to a create operation. |
PropertyFilterMode |
IPropertyFilter.getFilterMode()
Get the FilterMode attribute of the IPropertyFilter object. |
IPropertyNameList |
IPropertyFilter.getPropertyNameList()
Get the property name list if mode is SINGLE_PROPERTY or PROPERTY_LIST. |
IPropertyMap |
IPropertyFilter.filter()
Returns the filtered property map. |
URI |
IUriFilter.filter()
Deprecated. Returns the resulting URI |
| Uses of WcmException in com.sapportals.wcm.repository.manager |
| Methods in com.sapportals.wcm.repository.manager that throw WcmException | |
static boolean |
ResourceEventUtils.isVisible(IResource resource,
IResourceContext context)
|
static boolean |
ResourceEventUtils.isVisibleWithLaterVersion(IResource resource,
IResourceContext context)
|
void |
OverallResourceEventBroker.send(IEvent event,
IEventSender sender)
Sends the specified event to all receivers that have registered for this kind of event. |
void |
OverallResourceEventBroker.register(IEventSender sender)
Registers an event sender instance. |
void |
OverallResourceEventBroker.register(IEventReceiver receiver,
IEvent template)
Registers an event receiver. |
void |
OverallResourceEventBroker.register(IEventReceiver receiver,
IEvent template,
IEventMapper mapper)
See the general contract of the OverallResourceEventBroker.register(IEventReceiver, IEvent)
method. |
void |
OverallResourceEventBroker.register(IEventReceiver receiver,
IEvent template,
int priority,
boolean async)
See the general contract of the OverallResourceEventBroker.register(IEventReceiver, IEvent)
method. |
void |
OverallResourceEventBroker.register(IEventReceiver receiver,
IEvent template,
IEventMapper mapper,
int priority,
boolean async)
See the general contract of the OverallResourceEventBroker.register(IEventReceiver, IEvent,
IEventMapper) and OverallResourceEventBroker.register(IEventReceiver, IEvent, int, boolean)
method. |
void |
OverallResourceEventBroker.unregister(IEventSender sender)
Unregisteres an event sender instance. |
void |
OverallResourceEventBroker.unregister(IEventReceiver receiver,
IEvent template)
Unregisteres an event receiver instance. |
| Constructors in com.sapportals.wcm.repository.manager that throw WcmException | |
AbstractResourceEventMapper(java.lang.String id,
java.util.Properties properties)
Create a mapper with a specific id from the given properties. |
|
| Uses of WcmException in com.sapportals.wcm.repository.manager.entrypoints |
| Methods in com.sapportals.wcm.repository.manager.entrypoints that throw WcmException | |
void |
IEntryPointsProvider.addAndRemoveRootEntryPoints(ICollection parentCollection,
IEntryPointList entryPoints,
DisplayMode displayMode)
Handles the already existing list of entry points on the first level of the entry points hierarchy. |
IEntryPointList |
IEntryPointsProvider.getEntryPointChildren(ICollection parentCollection,
IEntryPoint parentEntryPoint,
DisplayMode displayMode)
Gets entry points as children for a specific folder inside a entry points hierarchy. |
void |
AbstractEntryPointsProvider.addAndRemoveRootEntryPoints(ICollection parentCollection,
IEntryPointList entryPoints,
DisplayMode displayMode)
Handles the already existing list of entry points on the first level of the entry points hierarchy. |
IEntryPointList |
AbstractEntryPointsProvider.getEntryPointChildren(ICollection parentCollection,
IEntryPoint parentEntryPoint,
DisplayMode displayMode)
Gets entry points as children for a specific folder inside a entry points hierarchy. |
| Uses of WcmException in com.sapportals.wcm.repository.service |
| Subclasses of WcmException in com.sapportals.wcm.repository.service | |
class |
ServiceCallException
Indicates an error during a IRepositoryService.acceptServletCall(Properties, IResourceContext)
call. |
class |
ServiceNotAvailableException
Indicates that a repository service will not be available at one or more repositories. |
| Uses of WcmException in com.sapportals.wcm.repository.service.accessstatistic |
| Methods in com.sapportals.wcm.repository.service.accessstatistic that throw WcmException | |
IAccessStatistic |
IAccessStatisticManager.getAccessStatistic()
Gets a IAccessStatistic instance |
java.util.Date |
IAccessStatistic.getLastReadDate(IResource resource)
Gets last read date for a centain a document; may return null |
void |
IAccessStatistic.clearLastReadDate(IResource resource)
Deletes last read date property for a centain a document. |
void |
IAccessStatistic.updateLastReadDate(IResource resource)
Updates last read date property for a centain a document when this document is read |
| Uses of WcmException in com.sapportals.wcm.repository.service.appproperties |
| Methods in com.sapportals.wcm.repository.service.appproperties that throw WcmException | |
java.util.List |
IAppProperty.getValues()
Returns a list of property values if the property is defined as multi-valued, null otherwise |
java.util.List |
AppProperty.getValues()
|
protected void |
AppProperty.validateType(java.lang.Object v)
|
IAppProperty |
IApplicationProperties.getProperty(IPropertyName propertyName,
RID resourceID,
java.lang.String userID,
IResourceContext context)
Returns the personalized property for the specified resource and user ID. |
IResourceAppPropertyMap |
IApplicationProperties.getProperty(IPropertyName propertyName,
IRidList ridList,
java.lang.String userID,
IResourceContext context)
Returns the specified personalized property for all resources IDs in the list and the specified user ID. |
IAppPropertyMap |
IApplicationProperties.getProperties(java.lang.String namespace,
RID resourceID,
java.lang.String userID,
IResourceContext context)
Returns all personalized properties of a resource for a namespace and the user ID. |
IAppPropertyMap |
IApplicationProperties.getProperties(RID resourceID,
java.lang.String userID,
IResourceContext context)
Returns all personalized properties of a resource. |
void |
IApplicationProperties.deleteProperty(IPropertyName propertyName,
RID resourceID,
java.lang.String userID,
IResourceContext context)
Deletes a personalized property. |
IAppProperty |
IApplicationProperties.getProperty(IPropertyName propertyName,
RID resourceID,
IResourceContext context)
Returns the property for the specified resource identifier and name. |
IResourceAppPropertyMap |
IApplicationProperties.getProperty(IPropertyName propertyName,
IRidList ridList,
IResourceContext context)
Returns the properties with the specified name and for all RIDs in the list. |
IAppPropertyMap |
IApplicationProperties.getProperties(java.lang.String namespace,
RID resourceID,
IResourceContext context)
Returns all application properties for the specified namespace and RID (but not the personalized properties). |
IAppPropertyMap |
IApplicationProperties.getProperties(RID resourceID,
IResourceContext context)
Returns all application properties for the specified RID (not the personalized properties) |
IAppPropertyCollection |
IApplicationProperties.getProperties(IPropertyName propertyName,
RID resourceID,
IResourceContext context)
Returns all personalized properties for a given property name and RID. |
void |
IApplicationProperties.deleteProperty(IPropertyName propertyName,
RID resourceID,
IResourceContext context)
Deletes the property with the specified name from the persistent storage. |
void |
IApplicationProperties.setProperty(IAppProperty property,
RID resourceID,
IResourceContext context)
Stores the property for the specified RID in some persistent storage. |
IRidList |
IApplicationProperties.search(IPropertyName name,
java.lang.String userID,
java.lang.Object value,
Operator op,
boolean multiValued,
IResourceContext context)
Queries all properties and returns a list of RIDs that match the search criteria. |
IAppProperty |
IApplicationProperties.getProperty(IPropertyName propertyName,
IResource resource,
java.lang.String userID)
|
IAppPropertyMap |
IApplicationProperties.getProperties(java.lang.String namespace,
IResource resource,
java.lang.String userID)
|
IAppPropertyMap |
IApplicationProperties.getProperties(IResource resource,
java.lang.String userID)
|
void |
IApplicationProperties.deleteProperty(IPropertyName propertyName,
IResource resource,
java.lang.String userID)
|
IAppProperty |
IApplicationProperties.getProperty(IPropertyName propertyName,
IResource resource)
|
IAppPropertyMap |
IApplicationProperties.getProperties(java.lang.String namespace,
IResource resource)
|
void |
IApplicationProperties.setProperty(IAppProperty property,
IResource resource)
|
IAppPropertyMap |
IApplicationProperties.getProperties(IResource resource)
|
IAppPropertyCollection |
IApplicationProperties.getProperties(IPropertyName propertyName,
IResource resource)
|
void |
IApplicationProperties.deleteProperty(IPropertyName propertyName,
IResource resource)
|
IAppProperty |
IApplicationProperties.getProperty(IPropertyName propertyName,
RID resourceID,
java.lang.String userID)
Deprecated. as of NW04. Use method with resource context parameter |
IResourceAppPropertyMap |
IApplicationProperties.getProperty(IPropertyName propertyName,
IRidList ridList,
java.lang.String userID)
Deprecated. as of NW04. Use method with resource context parameter |
IAppPropertyMap |
IApplicationProperties.getProperties(java.lang.String namespace,
RID resourceID,
java.lang.String userID)
Deprecated. as of NW04. Use method with resource context parameter |
IAppPropertyMap |
IApplicationProperties.getProperties(RID resourceID,
java.lang.String userID)
Deprecated. as of NW04. Use method with resource context parameter |
void |
IApplicationProperties.deleteProperty(IPropertyName propertyName,
RID resourceID,
java.lang.String userID)
Deprecated. as of NW04. Use method with resource context parameter |
IAppProperty |
IApplicationProperties.getProperty(IPropertyName propertyName,
RID resourceID)
Deprecated. as of NW04. Use method with resource context parameter |
IResourceAppPropertyMap |
IApplicationProperties.getProperty(IPropertyName propertyName,
IRidList ridList)
Deprecated. as of NW04. Use method with resource context parameter |
IAppPropertyMap |
IApplicationProperties.getProperties(java.lang.String namespace,
RID resourceID)
Deprecated. as of NW04. Use method with resource context parameter |
void |
IApplicationProperties.setProperty(IAppProperty property,
RID resourceID)
Deprecated. as of NW04. Use method with resource context parameter |
IAppPropertyMap |
IApplicationProperties.getProperties(RID resourceID)
Deprecated. as of NW04. Use method with resource context parameter |
void |
IApplicationProperties.deleteProperty(IPropertyName propertyName,
RID resourceID)
Deprecated. as of NW04. Use method with resource context parameter |
IRidList |
IApplicationProperties.search(IPropertyName name,
java.lang.String userID,
java.lang.Object value,
Operator op,
boolean multiValued)
Deprecated. as of NW04. Use method with resource context parameter |
| Constructors in com.sapportals.wcm.repository.service.appproperties that throw WcmException | |
AppProperty(IPropertyName name,
java.lang.String value,
java.lang.String userID,
boolean enableCopy)
|
|
AppProperty(IPropertyName name,
java.util.Date value,
java.lang.String userID,
boolean enableCopy)
|
|
AppProperty(IPropertyName name,
java.lang.Integer value,
java.lang.String userID,
boolean enableCopy)
|
|
AppProperty(IPropertyName name,
java.lang.Long value,
java.lang.String userID,
boolean enableCopy)
|
|
AppProperty(IPropertyName name,
java.lang.Boolean value,
java.lang.String userID,
boolean enableCopy)
|
|
AppProperty(IPropertyName name,
XMLMarkup value,
java.lang.String userID,
boolean enableCopy)
|
|
AppProperty(IPropertyName name,
PropertyType type,
java.util.List values,
java.lang.String userID,
boolean enableCopy)
|
|
| Uses of WcmException in com.sapportals.wcm.repository.service.comment |
| Methods in com.sapportals.wcm.repository.service.comment that throw WcmException | |
boolean |
IComment.addComment(IResource resource,
java.lang.String Text)
Adds a comment to a given resource. |
| Uses of WcmException in com.sapportals.wcm.repository.service.discussion |
| Subclasses of WcmException in com.sapportals.wcm.repository.service.discussion | |
class |
DiscussionResourceTypeException
Indicates that setting or getting a resource type of a discussion resource was not successful. |
class |
DiscussionSingleTopicExistsException
Indicates that creation of a single topic, while running the discussion service without topic level, was not successful, because this single topic exists yet. |
| Methods in com.sapportals.wcm.repository.service.discussion that throw WcmException | |
IDiscussion |
IDiscussionManager.createDiscussion(IResource resource)
Creates a new discussion for a given primary resource. |
void |
IDiscussionManager.createSubscription(IDiscussion discussion,
IResourceContext context,
IResource resource)
Creates a subscription for an entire discussion or for a specific discussion item. |
ISubscription |
IDiscussionManager.getSubscription(IDiscussion discussion,
IResourceContext context,
IResource resource)
Gets the subscription for a specified secondary resource (discussion or discussion item). |
IDiscussion |
IDiscussionManager.getDiscussion(IResource resource)
Gets the IDiscussion instance for the specified primary resource.
|
IDiscussionItem |
IDiscussionManager.getTopic(RID itemRid,
IResourceContext resourceContext)
Gets the discussion topic for a discussion item. |
IDiscussionItem |
IDiscussionManager.getTopDiscussionItem(RID itemRid,
IResourceContext resourceContext)
Gets the discussion topic for a discussion item. |
void |
IDiscussionManager.deleteDiscussion(IDiscussion discussion)
Deletes an IDiscussion instance and all discussion data related to the primary resource.
|
void |
IDiscussionManager.deleteDiscussion(IResource resource)
Deletes an IDiscussion instance and all discussion data related to the specified primary resource.
|
void |
IDiscussionManager.deleteDiscussion(RID resourceRid,
IResourceContext context)
Deletes an IDiscussion instance and all discussion data for an attached primary resource.
|
void |
IDiscussionItem.setDescription(java.lang.String description)
Sets the description of the IDiscussionItem.
|
void |
IDiscussionItem.setContent(java.lang.String content)
Deprecated. as of NW04. |
IDiscussionItemList |
IDiscussionItem.getChildren(IDiscussionItem branchItem)
|
IDiscussionItem |
IDiscussionItem.getLastPost()
Gets last reply. |
void |
IDiscussionItem.setNumberOfPosts(boolean increment,
int increment_value)
Sets the number of posts that belong to discussion topic. |
void |
IDiscussionItem.setNumberOfPost(int value)
Sets the absolute value for property, property set for topic resource |
IDiscussionItem |
IDiscussionItem.getParent()
Gets the parent IDiscussionItem instance. |
IDiscussionItem |
IDiscussionItem.getTopic()
Gets the topic IDiscussionItem instance. |
boolean |
IDiscussionItem.canDeleteChild(IDiscussionItem item)
Checks if the deletion of a child discussion item is possible. |
boolean |
IDiscussionItem.isSubscribed()
Checks if a subscription for this item exists. |
IDiscussionItem |
IDiscussion.createItem(java.lang.String name,
java.lang.String content,
java.lang.String description)
Creates first topic of a discussion thread (root discussion item also called topic). |
void |
IDiscussion.editItem(IDiscussionItem item,
java.lang.String content,
java.lang.String description)
Edits a discussion item. |
IDiscussionItem |
IDiscussion.createSingleTopic()
Creates first topic of a discussion thread (root discussion item also called topic). |
IDiscussionItem |
IDiscussion.createItem(IDiscussionItem parent,
java.lang.String name,
java.lang.String content,
java.lang.String description)
Creates a discussion item within a thread. |
void |
IDiscussion.deleteItem(IDiscussionItem item)
Deletes a discussion item. |
void |
IDiscussion.deleteItemReplies(IDiscussionItem item)
Deletes a the replies folder of discussion item. |
void |
IDiscussion.deleteItemReplies(IResource itemResource)
Deletes a the replies folder of discussion item. |
boolean |
IDiscussion.isSubscribed()
Checks if a subscription for this discussion exists. |
| Uses of WcmException in com.sapportals.wcm.repository.service.feedback |
| Methods in com.sapportals.wcm.repository.service.feedback that throw WcmException | |
boolean |
IFeedback.addFeedback(IResource resource,
java.lang.String Text)
Adds a feedback item to the specified resource. |
boolean |
IFeedback.addFeedback(IResource resource,
java.lang.String Text,
com.sapportals.portal.security.usermanagement.IUMPrincipal receiver)
Adds a feedback item to the specified resource. |
| Uses of WcmException in com.sapportals.wcm.repository.service.personalnote |
| Methods in com.sapportals.wcm.repository.service.personalnote that throw WcmException | |
boolean |
IPersonalNote.addComment(IResource resource,
java.lang.String Text)
Adds a personal note to the specified resource. |
| Uses of WcmException in com.sapportals.wcm.repository.service.rating |
| Methods in com.sapportals.wcm.repository.service.rating that throw WcmException | |
boolean |
IRating.addRating(IResource resource,
int iVote)
Adds a rating to a given resource. |
| Uses of WcmException in com.sapportals.wcm.repository.service.statemanagement |
| Subclasses of WcmException in com.sapportals.wcm.repository.service.statemanagement | |
class |
StatemanagementException
Exception used in statemanagement |
| Methods in com.sapportals.wcm.repository.service.statemanagement that throw WcmException | |
IStatemanagementResource |
IStatemanagementManager.getStatemangementResource(IResource impResource)
Gets an instance of the IStatemanagementResource for a resource.
|
void |
IApprover.setApproverString(java.lang.String impApproverString)
Restores the IApprover object from a string as returned by getApproverString(). |
boolean |
IStep.appendApproverStringToStep(java.lang.String impApproverString)
Adds one approver to the step by using a string from the list which is returned by getApproverStringsOfStep()
The list which is returned by getApproverStringsOfStep()
contains strings, each of which represents a single approver entry assigned to the step.
|
boolean |
IResourceTransition.isAllowed()
Checks whether the transition is allowed for the current resource. |
boolean |
IResourceTransition.execute()
Changes the state of the current resource to the target state of the transition. |
java.lang.String |
IResourceTransition.getExecMessage()
Gets a message after method execute() has been called.
|
IResourceTransitionList |
IStatemanagementResource.getAllowedTransitions()
Gets all permitted transitions for the current resource and the current user. |
IResourceTransition |
IStatemanagementResource.getTransition(java.lang.String ID)
Gets a transition for the ID. |
IAclPermission |
IStatemanagementUtils.getApproverAdminPermission(IResource impResource)
Deprecated. Gets the permission for approver administration for a resource. |
void |
IStatemanagementUtils.setStatemanagementEnabled(ICollection impCollection,
boolean enabled)
Deprecated. Enables or disables the statemanagement for a folder. |
boolean |
IStatemanagementUtils.isStatemanagementEnabled(IResource impResource)
Deprecated. Checks whether the state management service is enabled for a collection or for the parent collection of a resource. |
void |
IStatemanagementUtils.saveApproverList(IResource impResource,
IStepList impApproverList)
Deprecated. Saves the list of steps and approvers for a resource |
IStepList |
IStatemanagementUtils.readApproverList(IResource impResource)
Deprecated. Reads the list of steps and approvers for a resource. |
java.lang.Integer |
IStatemanagementUtils.readCurrentStep(IResource impResource)
Deprecated. Reads the last step approved for a resource. |
java.lang.Integer |
IStatemanagementUtils.readNextStep(IResource impResource)
Deprecated. Reads the index of the next step to be approved. |
void |
IStatemanagementUtils.saveCurrentStep(IResource impResource,
java.lang.Integer impStep)
Deprecated. Saves the last approved step for a resource |
com.sapportals.portal.security.usermanagement.IUser |
IStatemanagementUtils.readWorkflowInitiator(IResource impResource)
Deprecated. Determines the person who initiated the approval process for a resource |
void |
IStatemanagementUtils.saveWorkflowInitiator(IResource impResource,
com.sapportals.portal.security.usermanagement.IUser impWorkflowInitiator)
Deprecated. Saves the person who initiated the approval process for a resource |
IState |
IStatemanagementUtils.readState(IResource impResource)
Deprecated. Determines the current state of a resource. |
void |
IStatemanagementUtils.saveState(IResource impResouce,
IState impState)
Deprecated. Saves the state of a resource |
boolean |
IStatemanagementUtils.isApproverlistAllowedForWrite(IResource impResource)
Deprecated. Checks whether the current user has permission to change the approver list for a resource |
boolean |
IStatemanagementUtils.isApproverlistAllowedForRead(IResource impResource)
Deprecated. Checks whether the current user is allowed to read the approver list for a resource |
IStepList |
IStatemanagementUtils.convertToApproverList(java.lang.String impApproverString)
Deprecated. Constructs a steplist from a string which is returned by convertToString |
java.lang.String |
IStatemanagementUtils.convertToString(IStepList impStepList)
Deprecated. Converts a steplist object into a string which can be used for persistent properties in UI |
boolean |
IStatemanagementUtils.addFeedback(IResource impResource,
java.lang.String impFeedbackText)
Deprecated. Wrapper method for saving feedback from the service servlet for the feedback service |
java.lang.String |
IStepList.getStepListString()
This method serializes the current state of the IStepList into a string that can be used to
persist the steplist in an HTML Page. |
void |
IStepList.setStepListString(java.lang.String impStepListString)
This method deserializes the IStepList from a string returned by getCompleteApproverList.
|
java.util.List |
IStepList.getApproverStringList()
This method returns a list with strings that can be used to persist the defined workflow as a multi-value application property of a resource. |
void |
IStepList.setApproverStringList(java.util.List impApproverList)
This method is used to restore the IStepList from the List returned by IStepList.getApproverStringList(). |
IApprover |
IStepList.addApproverToSelectedStep(java.lang.String impApproverId,
int impApproverTyp)
Adds a single approver to the selected steps. |
IApprover |
IStepList.addApproverToSelectedStep(com.sapportals.portal.security.usermanagement.IUMPrincipal impPrincipal,
int impApproverTyp)
Deprecated. as of NW04. Please use addApproverToSelectedStep(IUMPrincipal impPrincipal) |
IApprover |
IStepList.addApproverToSelectedStep(com.sapportals.portal.security.usermanagement.IUMPrincipal impPrincipal)
Adds a single approver to the selected steps. |
IStepList |
IStepListState.restoreStepList()
|
void |
IStatemanagementUtilsResource.setStatemanagementEnabled(boolean enabled)
Sets the StatemanagementEnabled attribute of the IStatemanagementUtilsResource object. |
boolean |
IStatemanagementUtilsResource.isStatemanagementEnabled()
Gets the StatemanagementEnabled attribute of the IStatemanagementUtilsResource object. |
boolean |
IStatemanagementUtilsResource.isApproverlistAllowedForWrite()
Gets the ApproverlistAllowedForWrite attribute of the IStatemanagementUtilsResource object. |
boolean |
IStatemanagementUtilsResource.isApproverlistAllowedForRead()
Gets the ApproverlistAllowedForRead attribute of the IStatemanagementUtilsResource object. |
void |
IStatemanagementUtilsResource.saveApproverList(IStepList impApproverList)
Saves the defined workflow for the current resource |
IStepList |
IStatemanagementUtilsResource.readApproverList()
Reads the list of steps and approvers from the database |
IStepList |
IStatemanagementUtilsResource.convertToApproverList(java.lang.String impApproverString)
Converts a string as returned from the convertToString() method back to a IStepList .
|
java.lang.String |
IStatemanagementUtilsResource.convertToString(IStepList impStepList)
Converts a steplist to a string in order to save this string as persistant data within a control |
boolean |
IStatemanagementUtilsResource.addFeedback(java.lang.String impFeedbackText)
Adds feedback to the IStatemanagementUtilsResource object. |
java.lang.Integer |
IStatemanagementUtilsResource.readNextStep()
Reads the index of the next step to be approved. |
java.lang.Integer |
IStatemanagementUtilsResource.readCurrentStep()
Reads the index of the last step approved for a resource |
com.sapportals.portal.security.usermanagement.IUser |
IStatemanagementUtilsResource.readWorkflowInitiator()
Determines the user who initiated the approval process for a resource |
IState |
IStatemanagementUtilsResource.readState()
Determines the current state of a resource. |
boolean |
ITransition.execute(IResource aResource)
Deprecated. Executes the transition |
boolean |
ITransition.isAllowed(IResource aResource)
Deprecated. Check whether the transition is allowed for a resource |
boolean |
ITransition.isAllowed(IResourceList aResourceList)
Deprecated. Checks that the transition is allowed for a list of resources |
ITransition |
IStatemanagement.getTransition(java.lang.String impID)
Deprecated. Returns the ITransition with the specified ID |
ITransitionList |
IStatemanagement.getTransitions(IResource aResource)
Deprecated. Returns all transitions defined in the workflow process for a resource |
ITransitionList |
IStatemanagement.getTransitions(IResourceList aResourceList,
IResourceContext aContext)
Deprecated. Returns all transitions defined in the workflow process for a resource list |
java.lang.String |
IStatemanagement.executeTransition(ITransition aTransition,
IResource aResource)
Deprecated. Executes the specified transition for the resource |
void |
IStatemanagement.executeTransition(ITransition aTransition,
IResourceList aResourceList,
IResourceContext aContext)
Deprecated. Executes the specified transition for a list of resources |
void |
IStatemanagement.setInitialState(IResource aResource)
Deprecated. Sets the initial state for a resource (i.e. in progress) |
void |
IStatemanagement.setInitialState(IResourceList aResourceList,
IResourceContext aContext)
Deprecated. Sets the initial state for a list of resources (i.e. in progress) |
IResourceTransitionIterator |
IResourceTransitionList.iterator()
Returns an iterator over the elements in this list in proper sequence |
boolean |
IResourceTransitionList.addAll(IResourceTransitionList c)
Appends all of the elements in the specified collection to the end of this list, in the order that they are returned by the specified collection's iterator (optional operation). |
IResourceTransitionIterator |
IResourceTransitionList.listIterator()
Returns a list iterator of the elements in this list (in proper sequence) |
IResourceTransitionIterator |
IResourceTransitionList.listIterator(int index)
Returns a list iterator of the elements in this list (in proper sequence), starting at the specified position in this list. |
IResourceTransitionList |
IResourceTransitionList.subList(int fromIndex,
int toIndex)
Returns a list iterator of the elements in this list (in proper sequence), starting at the specified position in this list. |
| Uses of WcmException in com.sapportals.wcm.repository.service.subscription |
| Subclasses of WcmException in com.sapportals.wcm.repository.service.subscription | |
class |
SubscriptionException
The exception thrown by the subscription service. |
| Methods in com.sapportals.wcm.repository.service.subscription that throw WcmException | |
java.lang.String |
ISubscription.getName()
Gets the name of the subscription that is displayed. |
void |
ISubscription.setName(java.lang.String newName)
Renames a subscription to a given new name. |
java.lang.String |
ISubscription.getOwner()
Gets the owner of the subscription. |
java.util.Date |
ISubscription.getLastModifiedDate()
Gets the date of the last modification of the subscription. |
java.util.Date |
ISubscription.getLastCheckDate()
Gets the last date the subscription was checked for changes. |
ISubscription |
ISubscription.set(ISubscriptionCondition condition,
IResource resource,
IChannel channel,
IRecipient recipient,
ISubscriptionAttributes attributes)
Changes or sets multiple parameters for a subscription in one operation. |
ISubscription |
ISubscription.set(ISubscriptionCondition condition,
IResourceList resources,
IChannel channel,
IRecipient recipient,
ISubscriptionAttributes attributes)
Changes or sets multiple parameters for a subscription in one operation. |
ISubscription |
ISubscription.set(ISubscriptionCondition condition,
IResource resource,
IChannel channel,
IRecipientList recipients,
ISubscriptionAttributes attributes)
Changes or sets multiple parameters for a subscription in one operation. |
ISubscription |
ISubscription.set(ISubscriptionCondition condition,
IResourceList resources,
IChannel channel,
IRecipientList recipients,
ISubscriptionAttributes attributes)
Changes or sets multiple parameters for a subscription in one operation. |
ISubscriptionAttributes |
ISubscription.getAttributes()
Gets the customizable attributes (like expiration date) of the subscription. |
void |
ISubscription.setAttributes(ISubscriptionAttributes attributes)
Sets the customizable attributes of a subscription. |
ISubscriptionCondition |
ISubscription.getCondition()
Gets the conditions (subscribed event, follow link, interval, RID tracking and recursion level) which leads to a notification for the subscription. |
boolean |
ISubscription.isValidCondition(ISubscriptionCondition condition)
Checks if a specified condition is valid for this subscription. |
void |
ISubscription.setCondition(ISubscriptionCondition condition)
Sets the subscription conditions (subscribed event, follow link, interval, RID tracking and recursion level) for which the subscription sends notifications. |
boolean |
ISubscription.setOwner(IRecipient newOwner)
Sets a new owner for this subscription. |
IUriList |
ISubscription.getURIs()
Deprecated. As of EP 5.0 SP2, replaced by ISubscription.getRIDs() |
IRidList |
ISubscription.getRIDs()
Gets the RIDs of the resources assigned to the subscription. |
IResourceList |
ISubscription.getResources()
Gets the resources assigned to the subscription. |
void |
ISubscription.setResources(IResourceList resourceList)
Resets the subscription's resources. |
void |
ISubscription.setResource(IResource resource)
Resets the subscription's resource. |
void |
ISubscription.addResource(IResource resource)
Adds a resource to the subscription. |
boolean |
ISubscription.isOnlyResource(IResource resource)
Checks if a resource is the only resource of a subscription. |
boolean |
ISubscription.removeResource(IResource resource)
Removes a resource from the subscription. |
IChannel |
ISubscription.getChannel()
Gets the channel that is used for sending notifications to the recipients. |
boolean |
ISubscription.isValidChannel(IChannel channel)
Checks if a given channel is valid for this subscription's recipients. |
void |
ISubscription.setChannel(IChannel channel)
Sets the channel to use for sending notifications to the recipients. |
IRecipientList |
ISubscription.getRecipients()
Gets the recipients of the subscription notifications. |
IRecipientList |
ISubscription.getSubscribedRecipients()
Gets the recipients of the subscription that have not unsubscribed. |
IRecipientList |
ISubscription.getUnsubscribedRecipients()
Gets the recipients of the subscription that have unsubscribed. |
void |
ISubscription.setRecipients(IRecipientList recipientList)
Resets the subscription's recipients. |
void |
ISubscription.setRecipient(IRecipient recipient)
Resets the subscription's recipient. |
void |
ISubscription.resetRecipients(IRecipientList recipientList)
Resets recipients for the subscription notifications. |
void |
ISubscription.resetRecipient(IRecipient recipient)
Reactivates all unsubscribed recipients for this subscription. |
void |
ISubscription.addRecipient(IRecipient recipient)
Adds a recipient to the subscription. |
boolean |
ISubscription.isOnlyRecipient(IRecipient recipient)
Checks if a recipient is the only recipient of a subscription. |
boolean |
ISubscription.removeRecipient(IRecipient recipient)
Removes a recipient from the subscription. |
boolean |
ISubscription.isUnsubscribed()
Checks whether all recipients are unsubscribed. |
boolean |
ISubscription.isUnsubscribed(IRecipient recipient)
Checks whether a recipient is unsubscribed. |
void |
ISubscription.unsubscribe(IRecipient recipient)
Unsubscribes a recipient and stops the subscription notifications for this recipient. |
void |
ISubscription.delete()
Deletes the subscription. |
ISubscription |
ISubscriptionManager.createSubscription(IResourceContext context,
java.lang.String name,
ISubscriptionCondition condition,
IResourceList resources,
IChannel channel,
IRecipientList recipients,
ISubscriptionAttributes attributes)
Creates a new subscription with the specified attributes for several resources and recipients. |
ISubscriptionList |
ISubscriptionManager.deleteSubscriptionsForUser(IResourceContext context,
IRecipient deletedUser,
IRecipient newUser,
boolean replaceOnlyOwnedSubscriptions)
Deletes all subscriptions for a given user. This method might be called if a user does no longer exist in the system, and his subscriptions should be clean up. |
ISubscription |
ISubscriptionManager.createSubscription(IResourceContext context,
java.lang.String name,
ISubscriptionCondition condition,
IResource resource,
IChannel channel,
IRecipientList recipients,
ISubscriptionAttributes attributes)
Creates a new subscription with the specified attributes for one resource and several recipients. |
ISubscription |
ISubscriptionManager.createSubscription(IResourceContext context,
java.lang.String name,
ISubscriptionCondition condition,
IResource resource,
IChannel channel,
IRecipient recipient,
ISubscriptionAttributes attributes)
Creates a new subscription with the specified attributes for one resource and recipient. |
IRidList |
ISubscriptionManager.checkRIDsForSubscription(IResourceContext context,
java.lang.String owner,
IRidList RIDs)
Checks if at least one subscription exists for each given RID. |
IChannel |
ISubscriptionManager.getDefaultChannel(IRecipientList recipientList)
Gets the default channel over all recipients. The returned channel is a channel that is valid for all recipients, if such a channel can be found. |
IRidList |
ISubscriptionManager.checkResourcesForSubscription(IResourceContext context,
java.lang.String owner,
IResourceList resources)
Checks if at least one subscription exists for each given resource. |
ISubscription |
ISubscriptionManager.getSubscription(IResourceContext context,
java.lang.String id)
Gets the subscription with the specified ID. |
ISubscriptionList |
ISubscriptionManager.getSubscriptions(IResourceContext context,
RID rid,
boolean includeSubfolders)
Gets all subscriptions for a specified rid. |
ISubscriptionList |
ISubscriptionManager.getPassiveSubscriptions(IResourceContext context,
IRecipient recipient)
Gets all passive subscriptions for a specified recipient. |
ISubscriptionList |
ISubscriptionManager.getSubscriptions(IResourceContext context,
java.lang.String owner,
IResource resource)
Returns all matching subscriptions with a specified owner and resource. |
ISubscriptionList |
ISubscriptionManager.getSubscriptions(IResourceContext context,
java.lang.String owner)
Returns all matching subscriptions for a specified owner. |
ISubscriptionList |
ISubscriptionManager.getSubscriptions(IResourceContext context,
IRecipient recipient,
boolean resolveIncludedUsers)
Returns all matching subscriptions for a specified recipient. |
java.util.Collection |
ISubscriptionManager.getConditionEvents(IResource resource)
Gets all possible event types related to subscriptions that can occur for the specified resource. |
ISubscriptionConditionEvent |
ISubscriptionManager.getDefaultConditionEvent(IResource resource)
Gets the default event type for a specified resource. |
java.util.Collection |
ISubscriptionManager.getConditionIntervals(IResource resource)
Gets all available interval types for subscription notification. |
ISubscriptionConditionInterval |
ISubscriptionManager.getDefaultConditionInterval(IResource resource)
Gets the default interval type for a subscription notification. |
ISubscriptionConditionInterval |
ISubscriptionManager.getMinConditionInterval(IResource resource)
Gets the shortest interval type available for subscription notifications. |
java.util.Collection |
ISubscriptionManager.getConditionRecursionLevels(IResource resource)
Gets all available subscription recursion levels for a specified resource. |
ISubscriptionConditionRecursionLevel |
ISubscriptionManager.getDefaultConditionRecursionLevel(IResource resource)
Gets the default subscription recursion level for a specified resource. |
int |
ISubscriptionManager.getDefaultConditionFollowLinks(IResource resource)
Gets the default behavior for a subscribed link. |
int |
ISubscriptionManager.getDefaultConditionRidTracking(IResource resource)
Gets the RID tracking behavior that is the default for a specified resource. |
ISubscriptionConditionRecursionLevel |
ISubscriptionManager.getMaxConditionRecursionLevel(IResource resource)
Gets the maximum subscription recursion level that is possible for a specified resource. |
boolean |
ISubscriptionManager.isValidCondition(ISubscriptionCondition condition,
IResourceList resourceList)
Checks whether a condition is valid for a specified list of resources. |
boolean |
ISubscriptionManager.isValidCondition(ISubscriptionCondition condition,
IResource resource)
Checks whether a condition is valid for a specified resource. |
IResourceList |
ISubscriptionManager.getInvalidForCondition(ISubscriptionCondition condition,
IResourceList resourceList)
Checks whether a condition is valid for a specified list of resources and returns the resources for which the condition is invalid. |
boolean |
ISubscriptionManager.isValidChannel(IChannel channel,
IRecipientList recipientList)
Checks whether a channel is valid for a specified list of recipients. |
boolean |
ISubscriptionManager.isValidChannel(IChannel channel,
IRecipient recipient)
Checks whether a channel is valid for a specified recipient. |
IRecipientList |
ISubscriptionManager.getInvalidForChannel(IChannel channel,
IRecipientList recipients)
Checks whether a channel is valid for the specified recipients, and returns the recipients for which the channel is invalid. |
void |
ISubscriptionManager.raiseNotification(IResourceEvent event)
Raises an event which then triggers a subscription notification. |
ISubscriptionList |
ISubscriptionManager.createSubscriptionList()
Creates an empty ISubscriptionList. |
ISubscriptionAttributes |
ISubscriptionManager.createSubscriptionAttributes()
Creates a default ISubscriptionAttributes. |
ISubscriptionCondition |
ISubscriptionManager.createSubscriptionCondition()
Creates a default ISubscriptionCondition. |
boolean |
ISubscriptionManager.checkPermission(IResourceContext context,
java.lang.String permissionName,
IResourceList resources)
Checks whether the user stored in the context has the specified subscription permission for the list of resources. |
boolean |
ISubscriptionManager.checkPermission(IResourceContext context,
java.lang.String permissionName,
IResource resource)
Checks subscription permission for the user from the specified context. |
void |
ISubscriptionCondition.setEvent(int eventid,
IResource resource)
Sets the event type that causes the subscription notification to be sent. |
void |
ISubscriptionCondition.setInterval(java.lang.String intervalid)
Sets the notification interval that defines when notifications are sent. |
void |
ISubscriptionCondition.setRecursionLevel(java.lang.String levelid)
Sets the recursion level of the subscription. |
| Uses of WcmException in com.sapportals.wcm.repository.service.timebasedpublish |
| Methods in com.sapportals.wcm.repository.service.timebasedpublish that throw WcmException | |
void |
ITimebasedPublishServiceManager.setTimebasePublishEnabled(ICollection impFolder,
boolean enabled)
Enables the time-based publishing service for a folder When the time-based publishing service is enabled for a folder, the visibility of all children within this folder is controlled by the time-based publishing service. |
boolean |
ITimebasedPublishServiceManager.isTimebasePublishEnabled(IResource impResource)
Checks whether time-based publishing has been enabled for the resource. |
void |
ITimebasedPublishServiceManager.saveValidDate(IResource impResource,
java.util.Date validDate)
Saves the date on which a resource will be hidden. |
void |
ITimebasedPublishServiceManager.saveInvalidDate(IResource impResource,
java.util.Date invalidDate)
Saves the date on which a resource will become visible. |
java.util.Date |
ITimebasedPublishServiceManager.readValidDate(IResource impResource)
Reads the date on which a resource will be visible. |
java.util.Date |
ITimebasedPublishServiceManager.readInvalidDate(IResource impResource)
Reads the date on which a resource will be hidden. |
boolean |
ITimebasedPublishServiceManager.isVisible(IResource impResource)
Checks whether all conditions for the visibility of the time-based publishing service have been fullfilled. |
void |
ITimebasedPublishServiceManager.handleVisibleResources()
Searches for all resources which have become visible since the last call of this method and sends an event for every resource to inform other services about the visibility of these resources. |
void |
ITimebasedPublishServiceManager.handleInvisibleResources()
Searches for all resources which have become invisible since the last call of this method and sends an event for every resource to inform other services about these hidden resources. |
| Uses of WcmException in com.sapportals.wcm.repository.so |
| Subclasses of WcmException in com.sapportals.wcm.repository.so | |
class |
SoException
|
| Methods in com.sapportals.wcm.repository.so that throw WcmException | |
boolean |
IObjectFactoryRegistry.isA(java.lang.Class cl,
IResource res)
Get the A attribute of the ITypeCastRegistry object. |
java.lang.Object |
IObjectFactoryRegistry.as(java.lang.Class cl,
IResource res)
|
| Uses of WcmException in com.sapportals.wcm.service |
| Methods in com.sapportals.wcm.service that throw WcmException | |
static ServiceFactory |
ServiceFactory.getInstance()
Returns the ServiceFactory instance |
IService |
ServiceFactory.getService(java.lang.String type)
|
boolean |
ServiceFactory.isAvailable(java.lang.String type)
|
java.util.Collection |
ServiceFactory.getAllServices()
|
void |
ServiceFactory.releaseService(IService service)
|
IService |
IServiceFactory.getService(java.lang.String type)
Returns a instance for a given service type identifier |
boolean |
IServiceFactory.isAvailable(java.lang.String type)
Returns true if the service is available. |
java.util.Collection |
IServiceFactory.getAllServices()
Returns all services |
void |
IServiceFactory.releaseService(IService service)
Releases the service instance. |
protected void |
AbstractService.preService()
|
protected void |
AbstractService.startUp()
Deprecated. As of EP 5.0 SP5, replaced by AbstractService.shutDownImpl(). |
protected void |
AbstractService.shutDown()
Deprecated. As of EP 5.0 SP5, replaced by AbstractService.startUpImpl(). |
| Constructors in com.sapportals.wcm.service that throw WcmException | |
AbstractService(java.util.Properties properties)
Deprecated. As of EP 5.0 SP5, replaced by default (public, no arguments) constructor. |
|
| Uses of WcmException in com.sapportals.wcm.service.actioninbox |
| Methods in com.sapportals.wcm.service.actioninbox that throw WcmException | |
IActionInboxCategory |
IActionInboxCategory.getParent()
Get the parent category for this category. |
IActionInboxAction[] |
IActionInboxCategory.getActions()
Get a list of available actions for this category. |
IActionInboxAction |
IActionInboxCategory.getAction(java.lang.String name)
Get a specific action by name. |
java.util.Properties |
IActionInboxCategory.getRequiredItemProperties()
Get a list of with the required properties. Warning: Only the keys are set for this property bag, all values are set to an empty string! |
IActionInboxItemCategory |
IActionInboxCategory.getItemCategory(IResourceContext context,
com.sapportals.portal.security.usermanagement.IUMPrincipal owner)
Get an item category for a specific user/group/role. |
int |
IActionInboxCategory.getCreationType()
Check if creation of items is allowed for this category. |
int |
IActionInboxCategory.getDeletionType()
Check if deletion of items is allowed for this category. |
int |
IActionInboxCategory.getDoneHandlingType()
Check if deletion of items is allowed for this category. |
boolean |
IActionInboxCategory.isUsersOnly()
Check if action inboxes for this category are for users only (will lead to autoresolving of recipients). |
IResource |
IActionInboxItemCategory.getResource(IResourceContext context)
Get the resource associated to this item category. |
IActionInboxCategory |
IActionInboxItemCategory.getCategory()
Get the category for this item category. |
com.sapportals.portal.security.usermanagement.IUMPrincipal |
IActionInboxItemCategory.getOwner()
Get the owner of this item category. |
IActionInboxItemList |
IActionInboxItemCategory.getItems(IResourceContext context)
Get a list with the available items for this item category. |
IActionInboxItemList |
IActionInboxItemCategory.getItems(IResourceContext context,
boolean withUnread,
boolean withRead,
boolean withDone)
Get a list with the available items for this item category for a given state. |
IActionInboxItem |
IActionInboxItemCategory.getItem(IResourceContext context,
java.lang.String itemID)
Get a specific item. |
java.lang.String |
IActionInboxItemCategory.getLinkID()
Get a link ID to crosslink items across several item categories. |
IActionInboxItem |
IActionInboxItemCategory.createItem(IResourceContext context,
IActionInboxItemProducer producer,
IActionInboxNotification notification,
java.lang.String linkID)
Create a new item in the item category. |
IActionInboxItemList |
IActionInboxItemCategory.getItemsTop(IResourceContext context,
int topNumber)
Get a list with the available items for this item category depending on certain parameters. |
IActionInboxItemList |
IActionInboxItemCategory.getItemsTop(IResourceContext context,
int topNumber,
int depth,
java.lang.String sortedBy,
boolean ascending)
Get a list with the available items for this item category depending on certain parameters. |
IActionInboxItemList |
IActionInboxItemCategory.getItemsTop(IResourceContext context,
boolean withUnread,
boolean withRead,
boolean withDone,
int topNumber)
Get a list with the available items for this item category for a given state. |
void |
IActionInboxItemCategory.setItemsReadForCategory(IResourceContext context)
|
boolean |
IActionInboxItemProducer.executeItemAction(IResourceContext context,
IActionInboxAction action,
IActionInboxItem item)
Execute an action for an item. |
IActionInboxCategory |
IActionInboxService.registerProducer(IActionInboxItemProducer itemProducer,
java.lang.String categoryID)
Register an item producer to a category at the IActionInboxService. |
IActionInboxCategoryList |
IActionInboxService.getCategories()
Get the categories. |
IActionInboxCategory |
IActionInboxService.getCategory(java.lang.String categoryID)
Get a specific category by id. |
IActionInboxItemCategoryList |
IActionInboxService.getItemCategories(IResourceContext context,
com.sapportals.portal.security.usermanagement.IUMPrincipal owner)
Get all item categories for a specific user/group/role. |
IActionInboxItemCategoryList |
IActionInboxService.getItemCategories(IResourceContext context,
com.sapportals.portal.security.usermanagement.IUMPrincipal owner,
java.lang.String[] categoryIDs)
Get specific item categories for a specific user/group/role. |
IActionInboxItemCategory |
IActionInboxService.getItemCategory(IResourceContext context,
com.sapportals.portal.security.usermanagement.IUMPrincipal owner,
IActionInboxCategory category)
Get a specific item category for a specific user/group/role. |
IActionInboxItemCategory |
IActionInboxService.getItemCategory(IResourceContext context,
com.sapportals.portal.security.usermanagement.IUMPrincipal owner,
java.lang.String categoryID)
Get a specific item category for a specific user/group/role. |
IActionInboxItemList |
IActionInboxService.getItemsFromIDs(IResourceContext context,
java.lang.String categoryID,
com.sapportals.portal.security.usermanagement.IUMPrincipal owner,
java.lang.String[] itemIDs)
Get a list of items for a given array of ids. |
IActionInboxItemList |
IActionInboxService.send(com.sapportals.portal.security.usermanagement.IUMPrincipal recipient,
IActionInboxItemProducer producer,
IActionInboxNotification notification)
Store a notification in a user/group/role's inbox for a given category. |
IActionInboxItemList |
IActionInboxService.send(java.util.Collection recipients,
IActionInboxItemProducer producer,
IActionInboxNotification notification)
Store a notification in several user/group/role's inboxes for a given category as several items (same as send(recipients, producer, notification, false)).
|
IActionInboxItemList |
IActionInboxService.send(java.util.Collection recipients,
IActionInboxItemProducer producer,
IActionInboxNotification notification,
boolean isLinked)
Store a notification in several user/group/role's inboxes for a given category. |
IActionInboxItemList |
IActionInboxService.sendToUsers(com.sapportals.portal.security.usermanagement.IUMPrincipal recipient,
IActionInboxItemProducer producer,
IActionInboxNotification notification,
boolean isLinked)
Store a notification in a user's inbox for a given category. |
IActionInboxItemList |
IActionInboxService.sendToUsers(java.util.Collection recipients,
IActionInboxItemProducer producer,
IActionInboxNotification notification,
boolean isLinked)
Store a notification in several user's inboxes for a given category. |
IActionInboxItemList |
IActionInboxService.setItemsDone(IActionInboxItemProducer producer,
java.lang.String categoryID,
com.sapportals.portal.security.usermanagement.IUser reasonAuthor,
java.lang.String reasonID,
java.lang.String[] itemIDs)
Set several existing action inbox items to 'done'. |
IActionInboxItemList |
IActionInboxService.setItemsRead(IResourceContext context,
IActionInboxItemList items)
Set several existing action inbox items to 'read'. |
IActionInboxItemList |
IActionInboxService.setItemsDone(IResourceContext context,
com.sapportals.portal.security.usermanagement.IUser reasonAuthor,
java.lang.String reasonID,
IActionInboxItemList items)
Set several existing action inbox items to 'done'. |
IActionInboxItemList |
IActionInboxService.deleteItems(IActionInboxItemProducer producer,
java.lang.String categoryID,
java.lang.String[] itemIDs)
Delete several existing action inbox items. |
IActionInboxItemList |
IActionInboxService.deleteItems(IResourceContext context,
IActionInboxItemList items)
Delete several existing action inbox items. |
IActionInboxItemList |
IActionInboxService.executeItemActions(IResourceContext context,
java.lang.String actionName,
IActionInboxItemList items)
execute an action on several existing action inbox items. |
void |
IActionInboxService.setItemsReadForCategory(IResourceContext context,
IActionInboxItemCategory category)
|
IResource |
IActionInboxItem.getResource(IResourceContext context)
Get the resource associated to this item. |
com.sapportals.portal.security.usermanagement.IUMPrincipal |
IActionInboxItem.getOwner()
Get the owner of this item. |
IActionInboxItemCategory |
IActionInboxItem.getItemCategory()
Get the item category for this item. |
java.lang.String |
IActionInboxItem.getProducerID()
Get the id of the producer which once produced this item. |
java.util.Date |
IActionInboxItem.getModificationDate()
Get the last modification date of this item. |
boolean |
IActionInboxItem.isLinked()
Check, if this item is a linked item (an item that is stored as a multiple but crosslinked item in the inboxes for several users). |
java.util.Collection |
IActionInboxItem.getLinkedOwners(IResourceContext context)
Get the list of owners for a linked action item. |
boolean |
IActionInboxItem.isRead()
Check, if this item was already read by it's owner ( setRead()
has been called). |
boolean |
IActionInboxItem.setRead(IResourceContext context)
Set the 'read' state. |
boolean |
IActionInboxItem.isDone()
Check, if this item is in done state ( setDone() has been
called). |
java.lang.String |
IActionInboxItem.getDoneReason()
Get the reason, why an item was set to done. |
com.sapportals.portal.security.usermanagement.IUser |
IActionInboxItem.getDoneAuthor()
Get the user, who was caused the 'done'. |
boolean |
IActionInboxItem.setDone(IResourceContext context,
com.sapportals.portal.security.usermanagement.IUser reasonAuthor,
java.lang.String reasonID)
Set the 'done' state. |
void |
IActionInboxItem.delete(IResourceContext context)
Delete the action item. |
boolean |
IActionInboxItem.executeAction(IResourceContext context,
IActionInboxAction action)
Perform the given action for this item. |
static IActionInboxCategoryList |
ActionInboxUtils.createCategoryList()
Create an empty IActionInboxCategoryList. |
static IActionInboxItemCategoryList |
ActionInboxUtils.createItemCategoryList()
Create an empty IActionInboxItemCategoryList. |
static IActionInboxItemList |
ActionInboxUtils.createItemList()
Create an empty IActionInboxItemList. |
IActionInboxCategory |
AbstractActionInboxCategory.getParent()
|
IActionInboxAction[] |
AbstractActionInboxCategory.getActions()
|
IActionInboxAction |
AbstractActionInboxCategory.getAction(java.lang.String name)
|
java.util.Properties |
AbstractActionInboxCategory.getRequiredItemProperties()
|
IActionInboxItemCategory |
AbstractActionInboxCategory.getItemCategory(IResourceContext context,
com.sapportals.portal.security.usermanagement.IUMPrincipal owner)
|
int |
AbstractActionInboxCategory.getCreationType()
|
int |
AbstractActionInboxCategory.getDeletionType()
|
int |
AbstractActionInboxCategory.getDoneHandlingType()
|
boolean |
AbstractActionInboxCategory.isUsersOnly()
|
| Constructors in com.sapportals.wcm.service.actioninbox that throw WcmException | |
AbstractActionInboxCategory(IActionInboxService manager,
java.lang.String name,
IActionInboxCategory parent,
Descriptions descriptions,
java.util.Properties requiredItemProperties,
java.lang.String resourceType,
java.util.HashMap actions,
int creationType,
int deletionType,
int doneHandlingType,
boolean isUsersOnly)
|
|
| Uses of WcmException in com.sapportals.wcm.service.applog |
| Subclasses of WcmException in com.sapportals.wcm.service.applog | |
class |
AppLogException
TBD: Description of the class. |
| Methods in com.sapportals.wcm.service.applog that throw WcmException | |
IAppLogRetriever |
IAppLogService.getAppLogRetriever(com.sapportals.portal.security.usermanagement.IUser user)
|
| Uses of WcmException in com.sapportals.wcm.service.cache |
| Methods in com.sapportals.wcm.service.cache that throw WcmException | |
IClusterCacheArea |
ICacheService.getCacheArea(java.lang.String ID)
Get an instance of an IClusterCacheArea for the given
area ID. |
| Uses of WcmException in com.sapportals.wcm.service.checkout |
| Methods in com.sapportals.wcm.service.checkout that throw WcmException | |
boolean |
ICheckout.isCheckoutEnable(IResource resource)
Checks whether a resource can be checked out or not |
boolean |
ICheckout.isCheckedOut(IResource resource)
Returns flag, whether the resource is checked out or not |
com.sapportals.portal.security.usermanagement.IUser |
ICheckout.getCheckOutUser(IResource resource)
Returns the user who checked out the item |
boolean |
ICheckout.checkout(IResource resource,
java.lang.String localhost,
java.lang.String localFile,
java.lang.String checkoutMode)
Adds a checkout item to the specified resource. |
boolean |
ICheckout.canCancelCheckout(IResource resource)
Checks whether the resource can be checkout cancelled by the current user |
boolean |
ICheckout.cancelCheckout(IResource resource)
|
boolean |
ICheckout.canCheckin(IResource resource)
Checks whether the resource can be checked in by the current user |
boolean |
ICheckout.checkin(IResource resource)
Deletes a checkout item belonging to a resource |
void |
ICheckout.setCheckoutMode(IResource resource,
java.lang.String localhost,
java.lang.String localFile,
java.lang.String checkoutMode)
Sets a checkout status |
java.lang.String |
ICheckout.getCheckoutMode(IResource resource)
Gets the current checkout status |
java.lang.String |
ICheckout.getCheckoutHost(IResource resource)
Returns the host to which the file is checked out to |
java.lang.String |
ICheckout.getCheckoutPath(IResource resource)
Returns the path to which the file is checked out to |
| Uses of WcmException in com.sapportals.wcm.service.crawler |
| Subclasses of WcmException in com.sapportals.wcm.service.crawler | |
class |
CrawlerRunningException
Deprecated. as of NW04. The crawler service was replaced by the xcrawler service com.sapportals.wcm.service.xcrawler |
| Methods in com.sapportals.wcm.service.crawler that return WcmException | |
WcmException |
AbstractPushedResultReceiver.onCrawlException(java.lang.Exception exception,
IResource resource)
Deprecated. Called by the crawler when an exception occured during the crawl. |
WcmException |
AbstractListResultReceiver.onCrawlException(java.lang.Exception exception,
IResource resource)
Deprecated. Called by the crawler when an exception occured during the crawl. |
WcmException |
ICrawlerResultReceiver.onCrawlException(java.lang.Exception exception,
IResource resource)
Deprecated. Called by the crawler when an exception occured during the crawl. |
| Methods in com.sapportals.wcm.service.crawler that throw WcmException | |
abstract int |
AbstractPushedResultReceiver.onCrawlNext(IResource resource)
Deprecated. Inform the receiver about the next visited resource inside a colleciton. |
boolean |
AbstractPushedResultReceiver.onCrawlDown(IResource resource)
Deprecated. Inform the receiver about the descending in the hierarchy. |
void |
AbstractPushedResultReceiver.onCrawlUp(IResource resource)
Deprecated. Inform the receiver about the ascending in the hierarchy. |
int |
ICrawlerPushedDeltaResultReceiver.onCrawlNew(IResource resource)
Deprecated. Inform the receiver about a newly found resource. |
int |
ICrawlerPushedDeltaResultReceiver.onCrawlChanged(IResource resource)
Deprecated. Inform the receiver about a changed resource. |
int |
ICrawlerPushedDeltaResultReceiver.onCrawlDeleted(RID resourceID)
Deprecated. Inform the receiver about a deleted resource. |
int |
ICrawlerPushedDeltaResultReceiver.onCrawlUnvisited(IResource resource)
Deprecated. Inform the receiver about a unvisited resource (a resource that has been crawled before, but has not been referenced by other resources beginning at the given start resources and is still accessable). |
int |
ICrawlerPushedDeltaResultReceiver.onCrawlUnvisitedChanged(IResource resource)
Deprecated. Inform the receiver about a unvisited resource (a resource that has been crawled before, but has not been referenced by other resources beginning at the given start resources and is still accessable and has changed). |
int |
ICrawlerPushedDeltaResultReceiver.onCrawlUnvisitedDeleted(RID resourceID)
Deprecated. Inform the receiver about a unvisited resource (a resource that has been crawled before, but has not been referenced by other resources beginning at the given start resources and is already deleted). |
ISchedulerEntry |
IScheduledCrawler.getSchedulerEntry()
Deprecated. Get the scheduler's entry for this scheduled crawler. |
java.util.Date |
ICrawlerVisitedList.getLastCrawlStart()
Deprecated. Get the timestamp of the last crawl start. |
IRidList |
ICrawlerVisitedList.getLastCrawlStartRIDList()
Deprecated. Get the list with IDs of the start resources which where used for the last crawl. |
ICrawlerVisitedEntry |
ICrawlerVisitedList.getEntry(RID resourceID)
Deprecated. Search an entry for a given resource ID. |
void |
ICrawlerVisitedList.setCrawlStart(IResourceList resources)
Deprecated. (Re-)Set the list of resources to start crawling with. |
ICrawlerVisitedEntry |
ICrawlerVisitedList.createEntry(RID resourceID)
Deprecated. Create a new 'found' entry for a given resource ID. |
ICrawlerVisitedEntry |
ICrawlerVisitedList.addEntry(RID resourceID)
Deprecated. Create a new 'found' entry for a given resource ID, overwrite if alread exists. |
ICrawlerVisitedEntry |
ICrawlerVisitedList.deleteEntry(RID resourceID)
Deprecated. Delete an entry from the database for a given resource ID. |
void |
ICrawlerVisitedList.clearAllEntries()
Deprecated. Clear the list (treat as uncrawled). |
ICrawlerVisitedEntry |
ICrawlerVisitedList.setUnvisited(ICrawlerVisitedEntry entry)
Deprecated. Mark an entry as unvisited. |
ICrawlerVisitedEntry |
ICrawlerVisitedList.setVisited(ICrawlerVisitedEntry entry)
Deprecated. Mark an entry as visited. |
ICrawlerVisitedEntry |
ICrawlerVisitedList.setExcluded(ICrawlerVisitedEntry entry)
Deprecated. Mark an entry as excluded. |
ICrawlerVisitedEntryIterator |
ICrawlerVisitedList.getIterator(boolean includeFound,
boolean includeVisited,
boolean includeError,
boolean includeExcluded,
RID startRID)
Deprecated. Get an iterator for a list of entries, which matches the given criterias. |
static java.lang.String |
CrawlerUtils.getPriorityDescription(ICrawler crawler,
java.util.Locale locale)
Deprecated. Get a text describing the priority of a crawler. |
static java.lang.String |
CrawlerUtils.getPacingDescription(ICrawler crawler,
java.util.Locale locale)
Deprecated. Get a text describing the pacing of a crawler. |
static void |
CrawlerUtils.setPacingStep(ICrawler crawler,
boolean slowdown)
Deprecated. Modify the pacing of a crawler. |
IResourceList |
ISpecialCrawler.getResult()
Deprecated. Get the result from the crawler. |
void |
ICrawlerQueue.runCrawlers(boolean doClearVisitedList)
Deprecated. Start the currently queued crawlers. |
boolean |
ICrawlerPushedResultReceiver.onCrawlDown(IResource resource)
Deprecated. Inform the receiver about the descending in the hierarchy. |
void |
ICrawlerPushedResultReceiver.onCrawlUp(IResource resource)
Deprecated. Inform the receiver about the ascending in the hierarchy. |
int |
ICrawlerPushedResultReceiver.onCrawlNext(IResource resource)
Deprecated. Inform the receiver about the next visited resource inside a colleciton. |
java.lang.String |
ICrawlerProfile.getCrawlerType()
Deprecated. Get the crawler type to use for the crawl. |
int |
ICrawlerProfile.getDepth()
Deprecated. Get the maximum crawling depth to use for the crawl. |
int |
ICrawlerProfile.getInternalLinkDepth()
Deprecated. Get the maximum crawling depth for internal links to use for the crawl. |
int |
ICrawlerProfile.getExternalLinkDepth()
Deprecated. Get the maximum crawling depth for external links to use for the crawl. |
boolean |
ICrawlerProfile.getIncludeVersionsFlag()
Deprecated. Check if the flag to include versions of resources is set. |
IGenericQuery |
ICrawlerProfile.getPropertyQuery()
Deprecated. Get the query expression for searching the properties. |
int |
ICrawlerProfile.getHierarchicalCrawlMode()
Deprecated. Get the mode for a hierachical crawl. |
int |
ICrawlerProfile.getNiceness()
Deprecated. Get the niceness factor to use for the crawl. |
int |
ICrawlerProfile.getPriority()
Deprecated. Get the priority to use for the crawl. |
long |
ICrawlerProfile.getTimeLimit()
Deprecated. Get the time limit to use for the crawl. |
boolean |
ICrawlerProfile.getCaseSensitiveFlag()
Deprecated. Get the case sensitive flag. |
long |
ICrawlerProfile.getContentSizeLimit()
Deprecated. Get the content size limit. |
ISpecialCrawler |
ICrawlerService.getSpecialCrawler(AbstractSpecialCrawlerParameters parameters,
IResourceContext context,
IResource startResource)
Deprecated. Get a special crawler for a specific operation, e.g. an SUBFOLDER_CRAWLER to get the subfolders of the given start
resources. |
ISpecialCrawler |
ICrawlerService.getSpecialCrawler(AbstractSpecialCrawlerParameters parameters,
IResourceContext context,
IResourceList startResources)
Deprecated. Get a special crawler for a specific operation, e.g. an SUBFOLDER_CRAWLER to get the subfolders of the given start
resources. |
ICrawler |
ICrawlerService.getCrawler(java.lang.String crawlerID)
Deprecated. Get a specific crawler by it's ID. |
ICrawlerList |
ICrawlerService.getAllCrawlers()
Deprecated. Get a a list of all crawlers (crawling non-scheduled and all scheduled). |
ICrawlerProfile |
ICrawlerService.getProfile(java.lang.String id)
Deprecated. Get a parameter profile for a given ID. |
ICrawlerProfileList |
ICrawlerService.getAllProfiles()
Deprecated. Get a list of all available parameter profiles for a given ID. |
ICrawlerQueue |
ICrawlerService.createCrawlerQueue(java.lang.String id,
int size)
Deprecated. Create a new crawler queue. |
ICrawlerQueue |
ICrawlerService.deleteCrawlerQueue(java.lang.String id)
Deprecated. Delete an existing crawler queue. |
ICrawler |
ICrawlerService.createCrawler(ICrawlerProfile profile,
ICrawlerResultReceiver receiver,
IResource startResource)
Deprecated. Create a new crawler from a given profile. |
ICrawler |
ICrawlerService.createCrawler(ICrawlerProfile profile,
ICrawlerResultReceiver receiver,
IResourceList startResources)
Deprecated. Create a new crawler from a given profile. |
ICrawler |
ICrawlerService.createCrawler(java.lang.String type,
ICrawlerResultReceiver receiver,
IResourceList startResources)
Deprecated. Create a new crawler (same as createCrawler(receiver,
startResourceICrawler.FULL_DEPTH, false, false, false, null)). |
ICrawler |
ICrawlerService.createCrawler(java.lang.String type,
ICrawlerResultReceiver receiver,
IResource startResource)
Deprecated. Create a new crawler (same as createCrawler(receiver,
startResourceICrawler.FULL_DEPTH, false, false, false, null)). |
ICrawler |
ICrawlerService.createCrawler(java.lang.String type,
ICrawlerResultReceiver receiver,
IResourceList startResources,
int depth,
boolean internalLinkFlag,
boolean externalLinkFlag,
boolean includeVersionsFlag,
IGenericQuery propertyQuery)
Deprecated. Create a new crawler for the given parameters. |
ICrawler |
ICrawlerService.createCrawler(java.lang.String type,
ICrawlerResultReceiver receiver,
IResource startResource,
int depth,
boolean internalLinkFlag,
boolean externalLinkFlag,
boolean includeVersionsFlag,
IGenericQuery propertyQuery)
Deprecated. Create a new crawler for the given parameters. |
ICrawler |
ICrawlerService.createCrawler(java.lang.String type,
ICrawlerResultReceiver receiver,
IResourceList startResources,
AbstractSpecialCrawlerParameters parameters)
Deprecated. Create a new crawler for the given parameters. |
ICrawler |
ICrawlerService.createCrawler(java.lang.String type,
ICrawlerResultReceiver receiver,
IResource startResource,
AbstractSpecialCrawlerParameters parameters)
Deprecated. Create a new crawler for the given parameters. |
IScheduledCrawler |
ICrawlerService.getScheduledCrawler(java.lang.String crawlerID)
Deprecated. Get a specific scheduled crawler by it's ID. |
IScheduledCrawlerList |
ICrawlerService.getAllScheduledCrawlers()
Deprecated. Get a a list of all scheduled crawlers. |
IScheduledCrawler |
ICrawlerService.createScheduledCrawler(java.lang.String scheduledCrawlerID,
ICrawler crawler,
ISchedulerTimeTable timetable,
java.util.Properties properties)
Deprecated. Create a new scheduled crawler. |
IScheduledCrawler |
ICrawlerService.suspendScheduledCrawler(IScheduledCrawler crawler)
Deprecated. Suspend a scheduled crawler (inactivate it). |
IScheduledCrawler |
ICrawlerService.resumeScheduledCrawler(IScheduledCrawler crawler)
Deprecated. Resume a suspended scheduled crawler ((re)activate it). |
IScheduledCrawler |
ICrawlerService.updateScheduledCrawler(IScheduledCrawler crawler)
Deprecated. Update a scheduled crawler. |
IScheduledCrawler |
ICrawlerService.deleteScheduledCrawler(IScheduledCrawler crawler)
Deprecated. Delete a scheduled crawler. |
ICrawlerResultReceiver |
ICrawler.getResultReceiver()
Deprecated. Get the result reciever for this crawler. |
void |
ICrawler.setResultReceiver(ICrawlerResultReceiver receiver)
Deprecated. Set the result reciever for this crawler. |
IResourceList |
ICrawler.getStartResources()
Deprecated. Get the starting point(s) for this crawler. |
void |
ICrawler.setStartResources(IResourceList resources)
Deprecated. Set the starting points for this crawler. |
void |
ICrawler.setStartResource(IResource resource)
Deprecated. Set the starting point for this crawler. |
int |
ICrawler.getDepth()
Deprecated. Get the maximum crawling depth set for the crawl. |
void |
ICrawler.setDepth(int depth)
Deprecated. Set the maximum crawling depth for the crawl. |
int |
ICrawler.getInternalLinkDepth()
Deprecated. Get the maximum crawling depth for internal links set for the crawl. |
void |
ICrawler.setInternalLinkDepth(int depth)
Deprecated. Set the maximum crawling depth for internal links for the crawl. Please note: using setFollowInternalLinksFlag(false) will
be treated as a setFollowInternalLinksFlag(0). |
boolean |
ICrawler.getFollowInternalLinksFlag()
Deprecated. Check if the flag to follow internal links is set. |
void |
ICrawler.setFollowInternalLinksFlag(boolean flag)
Deprecated. Set the flag to follow internal links. |
int |
ICrawler.getExternalLinkDepth()
Deprecated. Get the maximum crawling depth for external links set for the crawl. |
void |
ICrawler.setExternalLinkDepth(int depth)
Deprecated. Set the maximum crawling depth for external links for the crawl. Please note: using setFollowExternalLinksFlag(false) will
be treated as a setFollowExternalLinksFlag(0). |
boolean |
ICrawler.getFollowExternalLinksFlag()
Deprecated. Check if the flag to follow external links is set. |
void |
ICrawler.setFollowExternalLinksFlag(boolean flag)
Deprecated. Set the flag to follow external links. |
boolean |
ICrawler.getIncludeVersionsFlag()
Deprecated. Check if the flag to include versions of resources is set. |
void |
ICrawler.setIncludeVersionsFlag(boolean flag)
Deprecated. Set the flag to include versions of resources. |
IGenericQuery |
ICrawler.getPropertyQuery()
Deprecated. Get the query expression for searching the properties. |
void |
ICrawler.setPropertyQuery(IGenericQuery query)
Deprecated. Set the query expression for searching properties. |
int |
ICrawler.getHierarchicalCrawlMode()
Deprecated. Get the mode for a hierachical crawl. |
void |
ICrawler.setHierachicalCrawlMode(int mode)
Deprecated. Set the hierarchical crawl mode. |
void |
ICrawler.crawl()
Deprecated. Start a new crawl for the crawler's default id. (same as crawl(null, false)) |
void |
ICrawler.crawl(java.lang.String crawlID)
Deprecated. Start a new crawl for a given id. (same as crawl(crawlID, false)) |
void |
ICrawler.crawl(java.lang.String crawlID,
boolean retry)
Deprecated. Start a crawl for a given id. |
void |
ICrawler.recrawl(java.lang.String crawlID)
Deprecated. Start another crawl (delta crawl) for a given id. |
ICrawlerVisitedList |
ICrawler.getLastVisitedList()
Deprecated. Get the list of visited resources for a given id. |
void |
ICrawler.cancelCrawl()
Deprecated. Cancel a running crawler. |
void |
ICrawler.suspend()
Deprecated. Suspend a running crawler. |
void |
ICrawler.resume()
Deprecated. Resume a previously suspended running crawler. |
void |
ICrawler.delete()
Deprecated. Delete the crawler (tell the ICrawlerService that it won't be
used any more). |
int |
ICrawler.getNiceness()
Deprecated. Get the niceness factor of the crawler. |
void |
ICrawler.setNiceness(int niceness)
Deprecated. Set the niceness factor for the crawler. |
int |
ICrawler.getPriority()
Deprecated. Get the priority of the crawler. |
void |
ICrawler.setPriority(int priority)
Deprecated. Set the priority for the crawler. |
long |
ICrawler.getTimeLimit()
Deprecated. Get the time limit of the crawler. The limit determines the maximum running time of the crawler in msec. |
void |
ICrawler.setTimeLimit(long limit)
Deprecated. Set the time limit for the crawler. |
boolean |
ICrawler.getCaseSensitiveFlag()
Deprecated. Get the case sensitive flag of the crawler. |
void |
ICrawler.setCaseSensitiveFlag(boolean flag)
Deprecated. Set the case sensitive flag for the crawler. |
long |
ICrawler.getContentSizeLimit()
Deprecated. Get the content size limit of the crawler. The limit determines the maximum content size of the resources the crawler should pass to the result receiver in byte. |
void |
ICrawler.setContentSizeLimit(long limit)
Deprecated. Set the content size limit for the crawler. |
IResource |
ICrawlerVisitedEntry.getResource(IResourceContext context)
Deprecated. Get the resource for the RID of this entry. |
| Uses of WcmException in com.sapportals.wcm.service.crawler.parameter |
| Constructors in com.sapportals.wcm.service.crawler.parameter that throw WcmException | |
SubfolderCrawlerParameters(int depth)
Deprecated. Construct with specific depth. |
|
SubfolderCrawlerParameters()
Deprecated. Construct with unlimited depth. |
|
| Uses of WcmException in com.sapportals.wcm.service.indexmanagement |
| Subclasses of WcmException in com.sapportals.wcm.service.indexmanagement | |
class |
CommunicationException
Indicates that the communication with another server failed because of an error. |
class |
IndexDoesNotExistOnServerException
Indicates that an index doesnt exist on the index server. |
class |
IndexInactiveException
Indicates that the requested action can not be performed because of an inactive index. |
class |
IndexNotReadyException
Indicates that the requested action can not be performed because of an busy index. |
| Methods in com.sapportals.wcm.service.indexmanagement that throw WcmException | |
void |
IIndexService.deleteIndex(IIndex index)
Deprecated. as of NW04. Use deleteIndex(IIndex,IResourceContext) ATTENTION: Using this signature instead of the one with a resource context for a classification index can lead to problems. If ACLs are used for the taxonomy repository, no folder can be deleted by this method because the service user context that is used only has read permission. |
IIndex |
IIndexService.createIndex(java.lang.String indexId,
java.lang.String indexName,
java.lang.String indexGroup,
java.lang.String serviceId)
Creates an index object. |
void |
IIndexService.deleteIndex(IIndex index,
IResourceContext context)
Deletes an index. |
void |
IIndexService.attachIndexToRepository(IIndex index,
IResource folder)
Attaches an index to a folder in a repository. |
void |
IIndexService.attachIndexFolder(IIndex index,
IIndexFolder indexfolder)
Attaches an index folder to an index. |
void |
IIndexService.detachIndexFromRepository(IIndex index,
IResource folder)
Detaches an index from a folder in a repository. |
void |
IIndexService.detachIndexFolder(IIndex index,
IIndexFolder indexFolder)
Detaches an index folder from an index. |
IPropertyMap |
IIndexService.getIndexedProperties()
Determines all properties indexed in at least one of the indexes maintained by the index service. |
IPropertyMap |
IIndexService.getIndexedProperties(IResourceContext resourceContext)
Determines all properties indexed in at least one of the indexes maintained by the index service and for which read access for the resource context is allowed. |
IPropertyMap |
IIndexService.getIndexedProperties(java.util.List indexes)
Determines all properties indexed in at least one of the indexes. |
IPropertyMap |
IIndexService.getIndexedProperties(java.util.List indexes,
IResourceContext resourceContext)
Determines all properties indexed in at least one of the indexes and for which read access for the resource context is allowed. |
IIndex |
IIndexService.getIndex(java.lang.String indexId)
Returns the specified index. |
java.util.Properties |
IIndexService.getServiceProperties(java.lang.String serviceId)
Gets the properties of an index implementation. |
java.util.Set |
IIndexService.getLanguagesOfIndexedDocuments(java.util.List indexes)
The methods get as parameter a list of index IDs. |
void |
IIndexService.internalSaveIndex(IIndex index)
Saves a newly created index object inside the index service. |
java.lang.Object |
IIndexService.getObjectInstance(java.lang.String objectInstanceName)
Gets an instance of an object specified by an IWcmIndexConst constant. |
IResourceContext |
IIndexService.getIndexServiceUserContext()
|
void |
IIndexService.startDeltaIndexCrawler(IIndexFolder indexFolder)
Deprecated. as of NW04. Crawlers can only be queued - use queueDeltaIndexCrawler |
void |
IIndexService.startIndexCrawler(IIndexFolder indexFolder)
Deprecated. as of NW04. Crawlers can only be queued - use queueIndexCrawler |
void |
IIndexService.enqueueDeltaIndexCrawler(IIndexFolder indexFolder)
Puts a delta index crawl into the index management crawler queue. |
void |
IIndexService.queueDeltaIndexCrawler(IIndexFolder indexFolder)
Puts a delta index crawl into the index management crawler queue. |
void |
IIndexService.queueIndexCrawler(IIndexFolder indexFolder)
Puts an index crawl into the index management crawler queue. |
void |
IIndexService.enqueueIndexCrawler(IIndexFolder indexFolder)
Deprecated. as of NW04. Does not work with the new crawlers |
void |
IIndexService.runQueuedCrawlers()
Deprecated. as of NW04. Does not work with the new crawlers |
ITaskQueueHandler |
IIndexService.getTaskQueueHandler()
Returns the task queue handler of the index management service. |
void |
IIndexService.setSchedulerTimeTable(java.lang.String indexId,
ISchedulerTimeTable schedulerTimeTable)
Registers a schedule for delta index crawling for the index with the ISchedulerTimeTable. |
ISchedulerTimeTable |
IIndexService.getSchedulerTimeTable(java.lang.String indexId)
Returns the timetable of a schedule for delta index crawling for the index. |
java.lang.String |
IIndexService.createIndexSchedulerEntryId(java.lang.String indexId,
RID indexFolderRid)
Returns an identifier for a delta index schedule for an folder, which if defined by the according schedule of the index. |
java.lang.String |
IIndexService.createSchedulerEntryId(java.lang.String indexId,
RID indexFolderRid)
Returns an identifier for a delta index schedule for an folder, which if not defined by the according schedule of the index. |
java.lang.String |
IIndexService.createEmptySchedulerEntryId(java.lang.String indexId)
Returns an identifier for a delta index schedule for the index. |
RID |
IIndexService.getIndexmanagementRepositoryPrefixRID()
Gets the resource ID of the root folder of the indexmanagement repository. |
java.util.List |
IIndexService.getActiveIndexes()
Returns all existing indexes in the system which are active. |
boolean |
IIndexService.isReadAllowed(IResourceContext context,
IIndex index)
Checks the read access permission of a user for an index. |
java.util.List |
IIndexService.isReadAllowed(IResourceContext context,
java.util.List indexes)
Checks the read access permission of a user for a list of indexes. |
boolean |
IIndexService.isWriteAllowed(IResourceContext context,
IIndex index)
Checks the write access permission of a user for an index. |
java.util.List |
IIndexService.isWriteAllowed(IResourceContext context,
java.util.List indexes)
Checks the write access permission of a user for a list of indexes. |
boolean |
IIndexService.isDeleteAllowed(IResourceContext context,
IIndex index)
Checks the delete permission of a user for an index. |
java.util.List |
IIndexService.isDeleteAllowed(IResourceContext context,
java.util.List indexes)
Checks the delete permission of a user for a list of indexes. |
void |
IIndexService.startXIndexCrawler(IIndex index,
IResource startResource)
This method is only used by internal methods and should not be used programmers using the imdexmanagement API. |
void |
IIndexService.startXTaxRetrainCrawler(IIndex index,
java.lang.String taxonomyName,
ICollection taxonomyCollection,
boolean isSearchRelevant)
This method is only used by internal methods and should not be used programmers using the imdexmanagement API. |
void |
IIndexService.startResourceIndexer(IResource document,
AbstractClassificationIndex index)
This method is only used by internal methods and should not be used programmers using the imdexmanagement API. |
java.util.List |
IIndexService.getActiveIndexmanagementCrawlers(IIndex index)
This method is only used by internal methods and should not be used programmers using the imdexmanagement API. |
void |
IIndexService.deleteCrawlers(java.util.List crawlers)
This method is only used by internal methods and should not be used programmers using the imdexmanagement API. |
void |
IIndexService.stopCrawlers(java.util.List crawlers)
This method is only used by internal methods and should not be used programmers using the imdexmanagement API. |
void |
IIndexService.suspendCrawlers(java.util.List crawlers)
This method is only used by internal methods and should not be used programmers using the imdexmanagement API. |
void |
IIndexService.resumeCrawlers(java.util.List crawlers)
This method is only used by internal methods and should not be used programmers using the imdexmanagement API. |
void |
IIndexFolder.setCrawlerProfileId(java.lang.String crawlerProfileId)
Set the CrawlerProfileId attribute of the IIndexFolder object. |
void |
IIndexFolder.setCrawlerStartRid(RID crawlerStartRid)
Set the CrawlerStartRid attribute of the IIndexFolder object. |
void |
IIndexFolder.setSchedulerTimeTable(ISchedulerTimeTable schedulerTimeTable)
Set the SchedulerTimeTable attribute of the IIndexFolder object. |
void |
IIndexFolder.setNewGlobalSchedulerTimeTable(ISchedulerTimeTable schedulerTimeTable)
Set the SchedulerTimeTable attribute of the IIndexFolder object if this is the schedule defined before for the index. |
void |
IIndexFolder.setIndexedSuccessfully(boolean isIndexedSuccessfully)
Sets the internal flag to indicate if indexing was successful. |
java.util.Date |
IIndexFolder.getLastIndexed()
Returns the date when the index folder has been indexed the last time |
void |
IIndexFolder.setLastIndexed(java.util.Date lastIndexedDate)
Sets the date when the index folder has been indexed the last time. |
boolean |
IIndexFolder.isCrawlerProfileIDInherited()
Indicates if the crawler profile ID is inherited from the index crawler profile ID. |
void |
IndexFolder.setCrawlerStartRid(RID crawlerStartRid)
Set the CrawlerStartRid attribute of the IIndexFolder object. |
void |
IndexFolder.setCrawlerProfileId(java.lang.String crawlerProfileId)
Set the CrawlerProfileId attribute of the IIndexFolder object. |
void |
IndexFolder.setSchedulerTimeTable(ISchedulerTimeTable schedulerTimeTable)
Set the SchedulerTimeTable attribute of the IIndexFolder object. |
void |
IndexFolder.setNewGlobalSchedulerTimeTable(ISchedulerTimeTable schedulerTimeTable)
Set the SchedulerTimeTable attribute of the IIndexFolder object if this is the schedule defined before the index. |
void |
IndexFolder.setIndexedSuccessfully(boolean isIndexedSuccessfully)
|
java.util.Date |
IndexFolder.getLastIndexed()
|
void |
IndexFolder.setLastIndexed(java.util.Date lastIndexedDate)
|
boolean |
IndexFolder.isCrawlerProfileIDInherited()
true if the crawler profile ID that is returned from getCrawlerProfileId()
is inherited from the index crawler profile ID. |
IPropertyMap |
IIndex.getIndexedProperties()
Returns the properties, indexed with the documents in the index. |
void |
IIndex.setCrawlerProfileId(java.lang.String crawlerProfileId)
Sets the ID of the default crawler profile for all index folders of the index. |
void |
IIndex.indexDocuments(IResourceList resources)
Puts a list of documents into the index. |
void |
IIndex.indexDocuments(IResourceList resources,
IResourceEvent resourceEvent)
Puts a list of documents into the index. |
void |
IIndex.indexDocument(IResource resource)
Puts a document into the index. |
void |
IIndex.indexDocument(IResource resource,
IResourceEvent resourceEvent)
Puts a document into the index It is recommended that you do not index documents manually using this method. For repositories that send cm events, documents are indexed automatically when their content or their properties are changed. For repositories that do not support eventing, for example, Web repositories, a delta index crawler should be scheduled for the index folders that need to be updated. |
void |
IIndex.deindexDocuments(IResourceList resources)
Removes a list of documents from the index It is recommended that you do not deindex documents manually using this method. For repositories that send cm events, documents are deindexed automatically when they are deleted. For repositories that do not support eventing, for example, Web repositories, a delta index crawler should be scheduled for the index folders that need to be updated. |
void |
IIndex.deindexDocuments(IUriList uris)
Deprecated. as of NW04. Use deindex documents(IRidList) |
void |
IIndex.deindexDocuments(IRidList rids)
Removes a list of documents from the index It is recommended that you do not deindex documents manually using this method. For repositories that send cm events, documents are deindexed automatically when they are deleted. For repositories that do not support eventing, for example, Web repositories, a delta index crawler should be scheduled for the index folders that need to be updated. |
void |
IIndex.deindexDocument(IResource resource)
Removes a document from the index. |
void |
IIndex.deindexDocument(URI uri)
Deprecated. as of NW04. Use deindexDocument(RID) |
void |
IIndex.deindexDocument(RID rid)
Removes a document from the index. |
void |
IIndex.delete()
Deprecated. as of NW04. Use deleted(IResourceContext) |
void |
IIndex.delete(IResourceContext context)
Deletes the index physically Important: To delete an index the deleteIndex(IIndex)
method of the IIndexService interface should be used
instead of this. |
void |
IIndex.clear()
All documents are removed from the index and the index is set to an initial state. |
void |
IIndex.deleteOnServer()
Deletes the index on the index server connected with the CM system. |
void |
IIndex.createIndexOnServer()
Creates the index on the index server connected with the CM system. |
void |
IIndex.checkProperties(java.util.Properties customProperties)
With this method the properties that should be set could be checked. |
void |
IIndex.generate()
Deprecated. as of NW04. Use generate(IResourceContext) |
void |
IIndex.generate(IResourceContext context)
Generates the index physically after creating the index object and initializing it The index data is only saved on CM side if the index could be generated successfully. |
void |
IIndex.reindex()
Clears the index (see clear() method) and starts putting all
documents into the index again It may be necessary to reindex an index if a CM repository that is assigned to the index now points to another underlying repository. |
void |
IIndex.reindex(boolean disablePostClearTasks)
Clears the index (see clear() method) and starts putting all
documents into the index again It may be necessary to reindex an index may be needed if a CM repository that is assigned to the index now points to another underlying repository. |
void |
IIndex.deltaReindex()
Performs indexing of the documents that are not yet indexed or have been changed since the last crawl. |
java.util.List |
IIndex.getLanguagesOfIndexedDocuments()
Returns the languages of an index, for which documents exist in. |
void |
IIndex.setSchedulerTimeTable(ISchedulerTimeTable schedulerTimeTable)
Registers a schedule for delta index crawling for the index with the ISchedulerTimeTable. |
ISchedulerTimeTable |
IIndex.getSchedulerTimeTable()
Returns the timetable of a schedule for delta index crawling for the index. |
boolean |
IIndex.setActive(boolean isActive)
|
void |
IIndex.setActiveDuringStartup(boolean isActive)
|
void |
IIndex.setInactiveIndexHasChanged()
Sets a property on true, if index documents have changed during index was inactive. |
RID |
IIndex.getRID()
Gets the resource ID of the resource representation of this index. |
void |
IIndex.setStateAndNumberOfCrawler(AbstractIndex.IndexingState state,
int numOfCrawler)
|
void |
IIndex.setIndexingState(AbstractIndex.IndexingState state)
|
AbstractIndex.IndexingState |
IIndex.getIndexingState()
|
int |
IIndex.reduceNumberOfCrawler()
|
boolean |
IndexFolderList.add(IIndexFolder indexFolder)
|
boolean |
IndexFolderList.addAll(IIndexFolderList indexFolderList)
Add All to the IIndexFolderList object. |
void |
IndexFolderList.add(int index,
IIndexFolder indexFolder)
|
void |
IndexFolderList.addLast(IIndexFolder indexFolder)
Add Last to the IIndexFolderList object. |
void |
IndexFolderList.addFirst(IIndexFolder indexFolder)
Add First to the IIndexFolderList object. |
void |
IndexFolderList.remove(IIndexFolder indexFolder)
|
void |
AbstractIndexCollection.addIndex(IIndex index)
|
IPropertyMap |
AbstractIndex.getIndexedProperties()
Returns the properties, indexed with the documents in the index. |
void |
AbstractIndex.setCrawlerProfileId(java.lang.String crawlerProfileId)
Sets the ID of the default crawler profile for all index folders of the index. |
void |
AbstractIndex.checkProperties(java.util.Properties customProperties)
|
java.util.List |
AbstractIndex.getLanguagesOfIndexedDocuments()
Returns the languages of an index, for which documents exist in. |
void |
AbstractIndex.indexDocuments(IResourceList resources,
IResourceEvent resourceEvent)
Indexes a list of documents |
void |
AbstractIndex.indexDocuments(IResourceList resources)
Indexes a list of documents |
void |
AbstractIndex.indexDocument(IResource resource)
Indexes a document |
void |
AbstractIndex.indexDocument(IResource resource,
IResourceEvent resourceEvent)
Indexes a document |
void |
AbstractIndex.deindexDocuments(IResourceList resources)
Deindexes a document |
void |
AbstractIndex.deindexDocuments(IUriList resourceUris)
Deprecated. as of NW04. Use deindexDocuments(IRidList) |
void |
AbstractIndex.deindexDocuments(IRidList resourceRids)
Deindexes a document |
void |
AbstractIndex.deindexDocument(IResource resource)
Deindexes a document |
void |
AbstractIndex.deindexDocument(URI resourceUri)
Deprecated. as of NW04. Use deindexDocument(RID) |
void |
AbstractIndex.deindexDocument(RID resourceRid)
Deindexes a document |
void |
AbstractIndex.reindex()
Reindexes the index |
void |
AbstractIndex.reindex(boolean disablePostClearTasks)
Reindexes the index |
void |
AbstractIndex.deleteOnServer()
|
static void |
AbstractIndex.deleteOnServer(java.lang.String indexId)
|
void |
AbstractIndex.createIndexOnServer()
|
void |
AbstractIndex.startReindexer(boolean disablePostClearTasks)
|
void |
AbstractIndex.deltaReindex()
Performs indexing of the documents that are not indexed yet or have been changed since the last crawl. |
protected abstract void |
AbstractIndex.internalIndexDocuments(IResourceList resources,
IResourceEvent resourceEvent)
Indexes a list of documents |
protected abstract void |
AbstractIndex.internalDeindexDocuments(IRidList rids)
Deindexes documents |
protected void |
AbstractIndex.reindexPostClear(IIndexFolderList preClearIndexFolders)
Deprecated. as of NW04. Does not work with the new crawlers |
protected boolean |
AbstractIndex.reindexXPostClear(IIndexFolderList preClearIndexFolders)
|
void |
AbstractIndex.reindexNotTrainingDocs()
|
void |
AbstractIndex.internalAddQueuedCrawler(IIndexServiceCrawler crawler)
For internal use only! |
void |
AbstractIndex.internalRunQueuedIfNoActive()
|
java.lang.String |
AbstractIndex.getResourceInfo(RID documentRid)
|
void |
AbstractIndex.setSchedulerTimeTable(ISchedulerTimeTable schedulerTimeTablePar)
Registers a schedule for delta index crawling for the index with the ISchedulerTimeTable. |
ISchedulerTimeTable |
AbstractIndex.getSchedulerTimeTable()
Returns the timetable of a schedule for delta index crawling for the index. |
boolean |
AbstractIndex.setActive(boolean isActive)
Sets an index inactive or activates it. |
void |
AbstractIndex.setActiveDuringStartup(boolean isActive)
|
void |
AbstractIndex.setInactiveIndexHasChanged()
Sets a property on true, if index documents have changed during index was inactive. |
RID |
AbstractIndex.getRID()
Gets the resource ID of the resource representation of this index. |
protected void |
AbstractIndex.checkIndexIsActive()
|
void |
AbstractIndex.setStateAndNumberOfCrawler(AbstractIndex.IndexingState state,
int numOfCrawler)
|
void |
AbstractIndex.setNumberOfCrawler(int numOfCrawler)
|
void |
AbstractIndex.setIndexingState(AbstractIndex.IndexingState state)
|
int |
AbstractIndex.getNumberOfCrawler(RID indexRid)
|
int |
AbstractIndex.reduceNumberOfCrawler()
|
AbstractIndex.IndexingState |
AbstractIndex.getIndexingState()
|
AbstractIndex.RunningState |
AbstractIndex.getRunningState()
Returns a state indicating what is actually happening with respect to indexing. |
int |
AbstractIndex.getNumberOfSuccessfullyIndexedDocs()
Returns the numbers of documents successfully indexed and searchable. |
int |
AbstractIndex.getNumberOfDocumentsInQueue()
Returns the numbers of documents currently in work for indexing, but not in an error state. |
int |
AbstractIndex.getNumberOfErrors()
Returns the numbers of documents failed during indexing. |
long |
AbstractIndex.getActiveTime()
Gives a rough estimation for the time duration needed for indexing the actual available documents. |
void |
AbstractIndex.suspendAll()
Suspends all running tasks for indexing. |
void |
AbstractIndex.resumeAll()
Resumes all suspended tasks for indexing. |
void |
AbstractIndex.stopAll()
Stops all running tasks for indexing. |
void |
AbstractIndex.restartAll()
Stops all stopped and suspended tasks for indexing. |
void |
ITaskQueueHandler.startIndexCrawler(IIndex index,
RID startRid,
IResourceEvent event)
Runs an index crawl as a separate thread. |
void |
ITaskQueueHandler.startDeltaCrawler(IIndex index,
RID startRid)
Runs an delta index crawl as a separate thread. |
void |
ITaskQueueHandler.startTrainingCrawler(java.lang.String taxonomyName,
ICollection taxonomyCollection,
IClassificationIndex index,
boolean isSearchRelevant)
Runs a taxonomy training crawler as a separate thread. |
void |
ITaskQueueHandler.createTaxonomyHierarchyByCopiing(java.lang.String taxonomyName,
ICollection existingHierarchy,
IClassificationIndex index)
The taxonomy hierarchy is created by copiing an existing hierarchy. |
void |
ITaskQueueHandler.startDeindexCrawler(IIndex index,
RID startRid)
Runs a deindex crawl as a separate thread. |
void |
ITaskQueueHandler.startDeindexCrawler(IIndex index,
RID startRid,
IResourceEvent event,
RID eventPreRid,
RID eventNewRid,
java.lang.String crawlerProfileId)
Runs a deindex crawl as a separate thread. |
void |
ITaskQueueHandler.indexDocument(IIndex index,
IResource document,
IResourceEvent event)
Indexes a document into an index. |
void |
ITaskQueueHandler.reindex(IIndex index,
boolean disablePostClearTasks)
Clears the index and starts putting all documents into the index again. |
void |
ITaskQueueHandler.deltaReindex(IIndex index)
Performs indexing of the documents that are not yet indexed or have been changed since the last crawl. |
void |
ITaskQueueHandler.deindexDocuments(IIndex index,
IRidList deindexRids,
boolean removeClassification)
Deindexes a list of document IDs from an index. |
void |
ITaskQueueHandler.activateSchedulerEntry(java.lang.String schedulerEntryId)
Activates a newly created scheduler entry for the current system of the task queue reader. |
void |
ITaskQueueHandler.updateCategoryContents(java.lang.String taxonomyName,
boolean dirtyOnly,
IIndex index,
IResourceContext context,
boolean markCategoriesUpdated)
Starts a process that checks and updates categories of a taxonomy where the query is not in sync with the documents of category. |
void |
ITaskQueueHandler.executeTask(ITask task)
Runs an index management task of the task queue service. |
boolean |
IIndexFolderList.add(IIndexFolder indexFolder)
Adds indexFolder to the list. |
void |
IIndexFolderList.add(int index,
IIndexFolder indexFolder)
Adds the index folder at the specified position. |
boolean |
IIndexFolderList.addAll(IIndexFolderList indexFolderList)
Adds all elements of indexFolderList to the IIndexFolderList
object. |
void |
IIndexFolderList.addLast(IIndexFolder indexFolder)
Adds indexFolder at the end of the index folder list. |
void |
IIndexFolderList.addFirst(IIndexFolder indexFolder)
Adds indexFolder at the beginning of the index folder list. |
void |
IIndexFolderList.remove(IIndexFolder indexFolder)
|
| Constructors in com.sapportals.wcm.service.indexmanagement that throw WcmException | |
IndexFolder(java.lang.String indexId,
RID indexFolderRid,
java.lang.String crawlerProfileId,
RID crawlerStartRid,
ISchedulerTimeTable scheduleTimeTable,
boolean indexedSuccessfully,
java.util.Date lastIndexed,
java.lang.String schedulerEntryId,
java.lang.String schedulerIndexEntryId)
Constructor for the index folder. |
|
IndexFolder(java.lang.String indexId,
RID rid)
Construct object of class IndexFolder. |
|
IndexFolder(java.lang.String indexId,
RID rid,
java.lang.String crawlerProfileId)
Construct object of class IndexFolder. |
|
IndexFolder(java.lang.String indexId,
RID rid,
java.lang.String crawlerProfileId,
RID crawlerStartRid)
Construct object of class IndexFolder. |
|
IndexFolder(java.lang.String indexId,
RID rid,
java.lang.String crawlerProfileId,
RID crawlerStartRid,
ISchedulerTimeTable schedulerTimeTable,
boolean isIndexedSuccessfully)
Construct object of class IndexFolder. |
|
IndexFolder(java.lang.String indexId,
RID rid,
java.lang.String crawlerProfileId,
RID crawlerStartRid,
ISchedulerTimeTable schedulerTimeTable,
boolean isIndexedSuccessfully,
java.util.Date lastIndexedDate)
Construct object of class IndexFolder. |
|
IndexFolderList(java.lang.String indexId)
Construct object of class IndexFolderList. |
|
IndexFolderList(IndexFolderList list,
java.lang.String indexId)
Construct object of class IndexFolderList. |
|
AbstractIndex(java.lang.String indexId,
java.lang.String indexName,
java.lang.String indexGroup,
IIndexFolderList indexFolders,
java.lang.String serviceId,
java.lang.String serviceUserId,
java.util.Properties indexServiceProperties)
Deprecated. as of NW04. Use constructor with crawler profile ID |
|
AbstractIndex(java.lang.String indexId,
java.lang.String indexName,
java.lang.String indexGroup,
IIndexFolderList indexFolders,
java.lang.String serviceId,
java.lang.String crawlerProfileId,
java.lang.String serviceUserId,
java.util.Properties indexServiceProperties)
Constructor. |
|
| Uses of WcmException in com.sapportals.wcm.service.indexmanagement.retrieval.classification |
| Methods in com.sapportals.wcm.service.indexmanagement.retrieval.classification that throw WcmException | |
void |
AbstractClassificationIndex.setDocumentClassification(IResource document,
java.util.Map classification)
Deprecated. as of NW04. Use setDocClassification(IResource,Map) |
void |
AbstractClassificationIndex.setDocumentClassification(IResource document,
java.util.Map classification,
boolean indexDocumentClassification)
Deprecated. as of NW04. Use setDocClassification(IResource,Map,boolean) |
void |
AbstractClassificationIndex.setDocumentClassification(IResource document,
java.util.Map classification,
boolean indexDocumentClassification,
boolean isTrainingDocument)
Deprecated. as of NW04. Use setDocClassification(IResource,Map,boolean, boolean) |
boolean |
AbstractClassificationIndex.isTrainingDocument(IResource document,
RID taxonomyClassRid)
|
boolean |
AbstractClassificationIndex.isDocClassifiedInAnyTax(IResource resource)
|
boolean |
AbstractClassificationIndex.isManuallyDeclassifiedDocument(IResource document,
RID taxonomyClassRid)
|
void |
AbstractClassificationIndex.setTaxonomyClassificationThreshold(java.lang.String taxonomyName,
java.lang.String thresholdId,
float threshold)
Set the TaxonomyClassificationThreshold attribute of the AbstractClassificationIndex object. |
void |
AbstractClassificationIndex.setTaxonomyTrainingUri(java.lang.String taxonomyName,
URI trainingUri)
Deprecated. as of NW04. Use setTaxonomyTrainingRid(String,RID) |
void |
AbstractClassificationIndex.setTaxonomyTrainingRid(java.lang.String taxonomyName,
RID trainingRid)
Set the TaxonomyTrainingUri attribute of the AbstractClassificationIndex object. |
void |
AbstractClassificationIndex.setTaxonomyBestClassesSensitivity(java.lang.String taxonomyName,
BestClassesSensitivity sensitivity)
Sets the threshold of a taxonomy |
java.util.Map |
AbstractClassificationIndex.getDocumentClassification(IResource document)
Deprecated. as of NW04. Use getDocClassification(IResource) |
float |
AbstractClassificationIndex.getTaxonomyClassificationThreshold(java.lang.String taxonomyName,
java.lang.String thresholdId)
Gets the threshold of a taxonomy |
URI |
AbstractClassificationIndex.getTaxonomyTrainingUri(java.lang.String taxonomyName)
Deprecated. as of NW04. Use getTaxonomyTrainingRid(String) |
RID |
AbstractClassificationIndex.getTaxonomyTrainingRid(java.lang.String taxonomyName)
Gets the uri of the root folder of the hierarchy that has been used to train/create the given taxonomy. |
IResourceList |
AbstractClassificationIndex.getClassDocuments(ICollection taxonomyClass)
Gets all documents of a taxonomy class |
IResourceList |
AbstractClassificationIndex.getClassDocuments(RID taxonomyClassRid,
IResourceContext context)
Gets all documents of a taxonomy class |
IRidList |
AbstractClassificationIndex.getClassDocumentRids(ICollection taxonomyClass)
Gets the resource IDs of all documents of a taxonomy class |
IRidList |
AbstractClassificationIndex.getClassDocumentRids(RID taxonomyClassRid,
IResourceContext context)
Gets the resource IDs of all documents of a taxonomy class |
java.util.Collection |
AbstractClassificationIndex.getBestClassesOld(IResourceList resourceDocuments,
java.lang.String taxonomyName)
|
java.util.Collection |
AbstractClassificationIndex.getBestClasses(IResourceList resourceDocuments,
java.lang.String taxonomyName)
|
java.util.Collection |
AbstractClassificationIndex.getBestClasses(IResourceList resourceDocuments,
java.lang.String taxonomyName,
java.util.Map thresholds)
|
BestClassesSensitivity |
AbstractClassificationIndex.getTaxonomyBestClassesSensitivity(java.lang.String taxonomyName)
Gets the sensitivity level of the best classes algorithm |
void |
AbstractClassificationIndex.removeTaxonomy(java.lang.String taxonomy,
IResourceContext context)
for internal use - to remove a taxonomy delete the taxonomy collection |
void |
AbstractClassificationIndex.addTaxonomy(java.lang.String taxonomy)
Deprecated. as of NW04. Use addTaxonomy(String,IResourceContext) |
void |
AbstractClassificationIndex.addTaxonomy(java.lang.String taxonomy,
IResourceContext context)
Add Taxonomy to the AbstractClassificationIndex object. |
void |
AbstractClassificationIndex.indexDocuments(IResourceList resources,
java.lang.String taxonomyName,
IUriList taxonomyClasses,
boolean isSearchRelevant)
Deprecated. as of NW04. Use indexDocuments(IResourceList, String, IRidList, boolean) |
void |
AbstractClassificationIndex.indexDocuments(IResourceList resources,
java.lang.String taxonomyName,
IRidList taxonomyClasses,
boolean isSearchRelevant)
Indexes a list of documents (method for internal use) |
void |
AbstractClassificationIndex.indexDocument(IResource resource,
java.lang.String taxonomyName,
IUriList taxonomyClasses,
boolean isSearchRelevant)
Deprecated. as of NW04. Use indexDocument(IResource, String, IRidList, boolean) |
void |
AbstractClassificationIndex.indexDocuments(IResourceList resources)
Indexes a list of documents |
void |
AbstractClassificationIndex.indexDocuments(IResourceList resources,
boolean reindexMode,
boolean sendLinkEvents)
Indexes a list of documents |
void |
AbstractClassificationIndex.indexDocument(IResource resource,
java.lang.String taxonomyName,
IRidList taxonomyClasses,
boolean isSearchRelevant)
indexes a document (method for internal use) |
java.util.Collection |
AbstractClassificationIndex.classifyDocuments(IResourceList resourceDocuments,
java.lang.String taxonomyName,
int maxResults)
Classifies documents (which taxonomy class folders do the documents fit best) |
java.util.Collection |
AbstractClassificationIndex.classifyDocuments(IResourceList resourceDocuments,
java.lang.String taxonomyName)
Classifies documents (which taxonomy class folders do the documents fit best) |
java.util.Collection |
AbstractClassificationIndex.unfilteredClassifyDocuments(IResourceList resourceDocuments,
java.lang.String taxonomyName,
float threshold,
int maxResults)
Classifies documents (which taxonomy class folders do the documents fit best) |
java.util.Collection |
AbstractClassificationIndex.classifyDocuments(IResourceList resourceDocuments,
java.lang.String taxonomyName,
float threshold,
int maxResults)
Classifies documents (which taxonomy class folders do the documents fit best). |
protected abstract java.util.Collection |
AbstractClassificationIndex.internalClassifyDocuments(IResourceList resourceDocuments,
java.lang.String taxonomyName,
float threshold,
int maxResults)
Classifies documents (which taxonomy class folders do the documents fit best) |
protected abstract void |
AbstractClassificationIndex.internalIndexDocuments(IResourceList resources,
java.lang.String taxonomyName,
IRidList taxonomyClasses,
IResourceEvent resourceEvent,
boolean isSearchRelevant,
boolean reindexMode,
boolean sendLinkEvents)
Indexes a list of documents (method for internal use) |
protected void |
AbstractClassificationIndex.internalIndexDocuments(IResourceList resources,
IResourceEvent resourceEvent)
indexes a list of documents (method for internal use) |
protected void |
AbstractClassificationIndex.reindexPostClear(IIndexFolderList preClearIndexFolders)
Deprecated. as of NW04. Does not work with the new crawlers |
void |
AbstractClassificationIndex.finishXPostClear()
|
protected boolean |
AbstractClassificationIndex.reindexTrainingResources(IIndexFolderList preClearIndexFolders)
|
void |
AbstractClassificationIndex.indexManualTrainDocs()
|
ClassificationStatus |
AbstractClassificationIndex.getDocumentClassificationStatus(IResource document,
java.lang.String taxonomyName)
|
void |
AbstractClassificationIndex.setDocumentClassificationStatus(IResource document,
java.lang.String taxonomyName,
ClassificationStatus status)
Sets the classification status of a document for a taxonomy |
void |
AbstractClassificationIndex.setDocumentClassificationStatus(IResource document,
java.lang.String taxonomyName,
ClassificationStatus status,
java.lang.String notToSend)
Sets the classification status of a document for a taxonomy |
void |
AbstractClassificationIndex.setDocumentClassificationStatus(IResource document,
java.lang.String taxonomyName,
ClassificationStatus status,
boolean sendEvents,
java.lang.String notToSend)
Sets the classification status of a document for a taxonomy |
void |
AbstractClassificationIndex.setDocumentClassificationStatus(IResourceList documents,
java.lang.String taxonomyName,
ClassificationStatus status)
Sets the classification status for a list of documents for a taxonomy. |
IResourceList |
AbstractClassificationIndex.getDocumentsToClassify(java.lang.String taxonomyName)
Deprecated. as of NW04. |
IResourceList |
AbstractClassificationIndex.getDocumentsToClassify(java.lang.String taxonomyName,
IResourceContext context)
Gets all documents of an index that have the status "to classify" within a taxonomy |
IResourceList |
AbstractClassificationIndex.getDocumentsNeverToClassify(java.lang.String taxonomyName,
IResourceContext context)
Gets all documents of an index that have the status "never to classify" within a taxonomy |
IResourceList |
AbstractClassificationIndex.getDocumentsNeverToClassify(java.lang.String taxonomyName)
Deprecated. as of NW04. |
IRidList |
AbstractClassificationIndex.getDocumentRidsToClassify(java.lang.String taxonomyName,
IResourceContext context)
Gets all rids of documents of an index that have the status "to classify" within a taxonomy |
IRidList |
AbstractClassificationIndex.getDocumentRidsNeverToClassify(java.lang.String taxonomyName,
IResourceContext context)
Gets all rids of documents of an index that have the status "never to classify" within a taxonomy |
RID |
AbstractClassificationIndex.getSpecialFolderRID(java.lang.String taxonomyName,
SpecialFolder specialFolderType)
|
IDocClassificationMap |
AbstractClassificationIndex.getDocClassification(IResource document)
Gets the classification that has been set for the document. |
IDocClassificationMapList |
AbstractClassificationIndex.getDocListClassification(IResourceList documents)
Gets the classifications that have been set for the documents. |
void |
AbstractClassificationIndex.setDocClassification(IDocClassificationMap documentClassificationMap)
Stores the document classification that has been choosen by manual or automatic classification. |
void |
AbstractClassificationIndex.setDocClassification(IDocClassificationMap documentClassificationMap,
java.lang.String notToSend)
Stores the document classification that has been choosen by manual or automatic classification. |
void |
AbstractClassificationIndex.setDocClassification(IDocClassificationMap documentClassificationMap,
boolean indexDocumentClassification)
Stores the document classification that has been choosen by manual or automatic classification. |
void |
AbstractClassificationIndex.setDocClassification(IDocClassificationMap documentClassificationMap,
boolean indexDocumentClassification,
boolean isTrainingDocument)
Stores the document classification that has been choosen by manual or automatic classification. |
void |
AbstractClassificationIndex.setDocClassification(IDocClassificationMap documentClassificationMap,
boolean indexDocumentClassification,
boolean isTrainingDocument,
boolean sendLinkEvents)
Stores the document classification that has been choosen by manual or automatic classification. |
void |
AbstractClassificationIndex.setDocClassification(IDocClassificationMap documentClassificationMap,
boolean indexDocumentClassification,
boolean isTrainingDocument,
boolean sendLinkEvents,
java.lang.String notToSend)
Stores the document classification that has been choosen by manual or automatic classification. |
void |
AbstractClassificationIndex.setDocListClassification(IDocClassificationMapList documentClassificationMapList)
Stores the documents classifications that has been choosen by manual or automatic classification. |
void |
AbstractClassificationIndex.setTaxonomyType(java.lang.String taxonomyName,
TaxonomyType taxonomyType)
Sets the type for the taxonomy |
void |
AbstractClassificationIndex.setIndexOnlyClassifiedDocs(boolean indexOnlyClassifiedDocs)
If set on true, only documents are indexed, which are also assigned to categories, otherwise all documents are indexed. |
TaxonomyType |
AbstractClassificationIndex.getTaxonomyType(java.lang.String taxonomyName)
|
boolean |
AbstractClassificationIndex.isIndexOnlyClassifiedDocs()
Returns true, if only documents are indexed, which could be assigned to categories. |
IQueryFolder |
AbstractClassificationIndex.getQueryFolder(RID taxonomyClassRid)
Gets a query folder instance |
IRidList |
AbstractClassificationIndex.getDocumentTrainingClasses(IResource document)
|
IRidList |
AbstractClassificationIndex.getManuallyDeclassifiedClasses(IResource document)
|
void |
AbstractClassificationIndex.autoClassifyDocs(java.lang.String taxonomyName,
IRidList docRidList,
IResourceContext context)
Requests proposals for the best categories for the documents and sets these categories automatically as document classification. |
void |
AbstractClassificationIndex.autoClassifyDocs(java.lang.String taxonomyName,
IResourceList docList,
IResourceContext context)
Requests proposals for the best categories for the documents and sets these categories automatically as document classification. |
void |
AbstractClassificationIndex.autoClassifyDocs(java.lang.String taxonomyName,
IResourceContext context)
Requests proposals for the best categories for documents that have no classification and sets these categories automatically as document classification. |
protected void |
AbstractClassificationIndex.deleteTaxRmIndexFolder(IResourceContext context)
Deletes the whole folder hierarchy of an index in the taxonomy repository. |
protected ICollection |
AbstractClassificationIndex.createTaxRmIndexFolder(IResourceContext context)
Creates the folder that represents the index in the taxonomy repository. |
void |
AbstractClassificationIndex.removeCategoryAssignments(ICollection deletedCategoryFolder)
Removes the assignment of all documents of the index to a category. |
protected void |
AbstractClassificationIndex.deleteIndexTaxDocClassification(IRidList documentIDs)
Deletes the classification of the documents regarding the taxonomies of this index. |
void |
AbstractClassificationIndex.startTaxonomyTrainingCrawler(ICollection taxonomyCollection,
boolean isSearchRelevant)
Deprecated. as of NW04. Crawlers can only be queued - use queueTaxonomyTrainingCrawler |
abstract void |
AbstractClassificationIndex.startTaxonomyTrainingCrawler(java.lang.String taxonomyName,
ICollection taxonomyCollection,
boolean isSearchRelevant,
boolean clearVisitedList,
ISemaphore semaphore)
Runs a taxonomy training crawler. |
protected IPropertyName |
AbstractClassificationIndex.getPropertyNameTaxonomy(java.lang.String taxonomyName)
|
abstract void |
AbstractClassificationIndex.updateCategoryContents(java.lang.String taxonomyName,
boolean dirtyOnly,
IResourceContext context)
Starts a process that checks and updates categories of a taxonomy where the query is not in sync with the documents of category. |
protected void |
AbstractClassificationIndex.addResourceToClassificationIndex(RID resourceRID,
IResourceContext context)
Adds a resource to the list of resources that are index in the index. |
protected void |
AbstractClassificationIndex.removeResourceFromClassificationIndex(RID resourceRID,
IResourceContext context)
Removes a resource from the list of resources that are indexed in the index. |
void |
AbstractClassificationIndex.synchronizeTaxonomyMetaData(java.lang.String taxonomyName)
Rebuilds the taxonomy meta data on the classification engine. |
void |
AbstractClassificationIndex.deleteClassificationProperties(IResource resource)
|
UpdateTaxonomyState |
AbstractClassificationIndex.getUpdateTaxonomyState(java.lang.String taxonomyName)
|
UpdateTaxonomyState |
AbstractClassificationIndex.getUpdateTaxonomyState(java.lang.String taxonomyName,
java.util.Locale locale)
|
void |
AbstractClassificationIndex.setUpdateTaxonomyState(java.lang.String state,
java.lang.String taxonomyName,
int visitedCategories,
int catgoriesToUpdate,
int allCategories)
|
void |
AbstractClassificationIndex.checkUpdateTaxonomyStateDuringStartUp()
|
void |
AbstractClassificationIndex.setQueryFolderExternalFast(IQueryFolder queryFolder,
IQueryEntryList query)
|
IDocClassificationMap |
IDocClassificationMapList.get(RID documentRid)
|
IQueryEntryList |
IQueryFolder.getQuery(IResourceContext context)
Gets the query of the query folder. |
void |
IQueryFolder.setQuery(IQueryEntryList query,
IResourceContext context)
Sets a query for the query folder. |
void |
IQueryFolder.setQueryFast(IQueryEntryList query,
IResourceContext context)
Sets a query for the query folder. |
IQueryFolder |
IQueryFolder.move(RID destination,
IResourceContext context)
Reflects a move of a folder in the taxonomy repository to perform the move also in the hierarchical query structure. |
IQueryFolder |
IQueryFolder.copy(RID destination,
IResourceContext context)
Reflects a copy of a folder in the taxonomy repository to perform the copy also in the hierarchical query structure. |
void |
IQueryFolder.delete(IResourceContext context)
Deletes the query folder in the QBC-engine and in the CM persistence. |
void |
IQueryFolder.setDirty(boolean isDirty,
IResourceContext context)
Sets a flag for the query folder that indicates that the documents of the category don't match the current query. |
boolean |
IQueryFolder.isDirty(IResourceContext context)
A flag for the query folder that indicates whether the documents of the category match the current query or not. |
ISearchResultList |
IQueryFolder.getQueryDocuments(IResourceContext context)
Documents of the index that match the query of the folder. |
boolean |
IQueryFolder.isQueryDefined(IResourceContext context)
Checks for existence of a query for the query folder. |
void |
IClassificationIndexCollection.addIndex(IIndex index)
Adds an index to the index collection |
java.util.Collection |
IClassificationIndexCollection.classifyDocuments(IResourceList resourceDocuments,
java.lang.String taxonomyName,
int maxResults)
classifies documents (which taxonomy class folders do the documents fit best) |
java.util.Collection |
IClassificationIndexCollection.classifyDocuments(IResourceList resourceDocuments,
java.lang.String taxonomyName)
classifies documents (which taxonomy class folders do the documents fit best) |
java.util.Collection |
IClassificationIndexCollection.classifyDocuments(IResourceList resourceDocuments,
java.lang.String taxonomyName,
float threshold,
int maxResults)
classifies documents (which taxonomy class folders do the documents fit best) |
IQueryFolder |
IQBClassificationIndex.getQueryFolder(RID taxonomyClassRid)
Gets a query folder instance |
void |
IQBClassificationIndex.deleteQueryFolderExternal(IQueryFolder queryFolder)
Deletes a query folder on the external classification engine |
void |
IQBClassificationIndex.setQueryFolderExternal(IQueryFolder queryFolder,
IQueryEntryList query)
Sets the query on the external classification engine. |
void |
IQBClassificationIndex.setQueryFolderExternalFast(IQueryFolder queryFolder,
IQueryEntryList query)
Sets the query on the external classification engine. |
void |
IQBClassificationIndex.moveQueryFolderExternal(IQueryFolder queryFolder,
RID destination)
Moves the query folder on the external classification engine |
void |
IQBClassificationIndex.updateCategoryContents(java.lang.String taxonomyName,
boolean dirtyOnly,
IResourceContext context)
Starts a process that checks and updates categories of a taxonomy where the query is not in sync with the documents of category. |
ISearchResultList |
IQBClassificationIndex.getQueryDocuments(IQueryFolder queryFolder,
IResourceContext context)
Documents of the index that match the query of the folder. |
ISearchSession |
IQBClassificationIndex.getQueryDocumentsPreview(IQueryFolder queryFolder,
IResourceContext context)
Deprecated. as of NW04. Do not use |
IRidList |
IQBClassificationIndex.getAffectedCategories(IQueryFolder queryFolder,
IResourceContext context)
Gets a list of categories of a taxonomy that are affected if the query of the query folder has changed. |
void |
IClassificationIndex.addTaxonomy(java.lang.String taxonomyName)
Deprecated. as of NW04. Use addTaxonomy(String,IResourceContext) |
void |
IClassificationIndex.addTaxonomy(java.lang.String taxonomyName,
IResourceContext context)
Adds a new taxonomy to the index By adding the taxonomy name, a folder is created for the taxonomy in the taxonomy repository and the taxonomy is saved with the index. |
void |
IClassificationIndex.removeTaxonomy(java.lang.String taxonomyName,
IResourceContext context)
Removes a taxonomy form the index By removing a taxonomy, the folder for the taxonomy in the taxonomy repository is deleted and the taxonomy itself is removed from the index. |
void |
IClassificationIndex.indexDocument(IResource resource,
java.lang.String taxonomyName,
IUriList taxonomyClasses,
boolean isSearchRelevant)
Deprecated. as of NW04. Use indexDocument(IResource, String, IRidList, boolean) |
void |
IClassificationIndex.indexDocument(IResource resource,
java.lang.String taxonomyName,
IRidList taxonomyClasses,
boolean isSearchRelevant)
Puts a document into the index It is recommended that you do not index a document manually using this method. For repositories that send cm events, documents are indexed automatically when their content or their properties are changed. For repositories that do not support eventing, for example, Web repositories, a delta index crawler should be scheduled for the index folders that need to be updated. |
void |
IClassificationIndex.indexDocuments(IResourceList resources,
java.lang.String taxonomyName,
IUriList taxonomyClasses,
boolean isSearchRelevant)
Deprecated. as of NW04. Use indexDocuments(IResourceList, String, IRidList, boolean) |
void |
IClassificationIndex.indexDocuments(IResourceList resources,
java.lang.String taxonomyName,
IRidList taxonomyClasses,
boolean isSearchRelevant)
Indexes a list of documents It is recommended that you do not index documents manually using this method. For repositories that send cm events, documents are indexed automatically when their content or their properties are changed. For repositories that do not support eventing, for example, Web repositories, a delta index crawler should be scheduled for the index folders that need to be updated. |
java.util.Collection |
IClassificationIndex.getClassFeatures(java.util.Collection taxonomyClassUris,
java.lang.String taxonomyName,
int maxResults)
Deprecated. as of NW04. Use getClassFeatures(IRidList taxonomyClassRids,String taxonomyName, int maxResults) |
java.util.Collection |
IClassificationIndex.getClassFeatures(IRidList taxonomyClassRids,
java.lang.String taxonomyName,
int maxResults)
Gets the features of taxonomy categories The most characteristic key words of a category are returned for each category. |
java.util.Collection |
IClassificationIndex.classifyDocuments(IResourceList resourceDocuments,
java.lang.String taxonomyName,
int maxResults)
Classifies documents into existing categories of a taxonomy The returned results are only proposals. |
java.util.Collection |
IClassificationIndex.classifyDocuments(IResourceList resourceDocuments,
java.lang.String taxonomyName)
Classifies documents into existing categories of a taxonomy The returned results are only proposals. |
java.util.Collection |
IClassificationIndex.classifyDocuments(IResourceList resourceDocuments,
java.lang.String taxonomyName,
float threshold,
int maxResults)
Classifies documents into existing categories of a taxonomy The returned results are only proposals. |
java.util.Collection |
IClassificationIndex.clusterDocuments(IResourceList resourceDocuments,
int maxResults)
Divides documents into clusters of documents The clustering is done on the basis of content similarity. |
IResourceList |
IClassificationIndex.getClassDocuments(ICollection taxonomyClass)
Gets all documents of a taxonomy class The taxonomy class is a folder in the taxonomy repository To get the resource ID of a taxonomy class, first the resource ID of the taxonomy root must be determined by using the getSpecialFolderRID(taxonomyName,SpecialFolder.TAXONOMY) method.
|
java.util.Map |
IClassificationIndex.doGeneric(java.lang.String function,
java.util.Map parameters)
Enables an index service to perform classification actions that are not reflected by the interface |
java.util.Map |
IClassificationIndex.getDocumentClassification(IResource document)
Deprecated. as of NW04. Use getDocClassification(IResource) |
IDocClassificationMap |
IClassificationIndex.getDocClassification(IResource document)
Gets the categories to which the document is assigned To get proposals of categories that a document might match, use classifyDocuments.
|
IDocClassificationMapList |
IClassificationIndex.getDocListClassification(IResourceList documents)
Gets the categories to which the documents are assigned To get proposals of categories into which documents might fit, use classifyDocuments.
|
void |
IClassificationIndex.setDocClassification(IDocClassificationMap documentClassificationMap)
Stores the document classification that has been chosen by manual or automatic classification |
void |
IClassificationIndex.setDocClassification(IDocClassificationMap documentClassificationMap,
java.lang.String notToSend)
|
void |
IClassificationIndex.setDocClassification(IDocClassificationMap documentClassificationMap,
boolean indexDocumentClassification)
Stores the document classification that has been chosen by manual or automatic classification |
void |
IClassificationIndex.setDocClassification(IDocClassificationMap documentClassificationMap,
boolean indexDocumentClassification,
boolean isTrainingDocument)
Stores the document classification that has been chosen by manual or automatic classification |
void |
IClassificationIndex.setDocListClassification(IDocClassificationMapList documentClassificationMapList)
Stores the documents classification that has been chosen by manual or automatic classification |
void |
IClassificationIndex.setDocumentClassification(IResource document,
java.util.Map classification)
Deprecated. as of NW04. Use setDocClassification(IResource,Map) |
void |
IClassificationIndex.setDocumentClassification(IResource document,
java.util.Map classification,
boolean indexDocumentClassification)
Deprecated. as of NW04. Use setDocClassification(IResource,Map,boolean) |
void |
IClassificationIndex.setDocumentClassification(IResource document,
java.util.Map classification,
boolean indexDocumentClassification,
boolean isTrainingDocument)
Deprecated. as of NW04. Use setDocClassification(IResource,Map,boolean, boolean) |
java.lang.Runnable |
IClassificationIndex.getTaxonomyTrainingCrawler(ICollection taxonomyCollection,
boolean isSearchRelevant)
Deprecated. as of NW04. Use startTaxonomyTrainingCrawler |
void |
IClassificationIndex.startTaxonomyTrainingCrawler(ICollection taxonomyCollection,
boolean isSearchRelevant)
Deprecated. as of NW04. Crawlers can only be queued - use queueTaxonomyTrainingCrawler(String,ICollection,boolean) |
void |
IClassificationIndex.startTaxonomyTrainingCrawler(ICollection taxonomyCollection,
boolean isSearchRelevant,
boolean clearVisitedList,
ISemaphore semaphore)
Deprecated. as of NW04. Use startTaxonomyTrainingCrawler(String,ICollection,boolean,boolean,ISemaphore) |
void |
IClassificationIndex.startTaxonomyTrainingCrawler(java.lang.String taxonomyName,
ICollection taxonomyCollection,
boolean isSearchRelevant,
boolean clearVisitedList,
ISemaphore semaphore)
Runs a taxonomy training crawler. |
void |
IClassificationIndex.queueTaxonomyTrainingCrawler(ICollection taxonomyCollection,
boolean isSearchRelevant)
Deprecated. as of NW04. Use queueTaxonomyTrainingCrawler(String,ICollection,boolean) |
void |
IClassificationIndex.queueTaxonomyTrainingCrawler(java.lang.String taxonomyName,
ICollection taxonomyCollection,
boolean isSearchRelevant)
Adds a taxonomy training crawler to the index management crawler queue. |
void |
IClassificationIndex.createTaxonomyHierarchyByCopiing(java.lang.String taxonomyName,
ICollection existingHierarchy)
The taxonomy hierarchy is created by copiing an existing hierarchy. |
float |
IClassificationIndex.getTaxonomyClassificationThreshold(java.lang.String taxonomyName,
java.lang.String thresholdId)
Gets the threshold of a taxonomy |
void |
IClassificationIndex.setTaxonomyClassificationThreshold(java.lang.String taxonomyName,
java.lang.String thresholdId,
float threshold)
Sets the threshold of a taxonomy |
URI |
IClassificationIndex.getTaxonomyTrainingUri(java.lang.String taxonomyName)
Deprecated. as of NW04. Use getTaxonomyTrainingRid(String) |
RID |
IClassificationIndex.getTaxonomyTrainingRid(java.lang.String taxonomyName)
Gets the URI of the root folder of the hierarchy that has been used to train/create the given taxonomy. |
void |
IClassificationIndex.setTaxonomyTrainingUri(java.lang.String taxonomyName,
URI trainingUri)
Deprecated. as of NW04. Use setTaxonomyTrainingRid(String, RID) |
void |
IClassificationIndex.setTaxonomyTrainingRid(java.lang.String taxonomyName,
RID trainingRid)
Sets the RID of the root folder of the hierarchy that has been used to train/create the given taxonomy. |
java.util.Collection |
IClassificationIndex.getBestClasses(IResourceList resourceDocuments,
java.lang.String taxonomyName)
|
BestClassesSensitivity |
IClassificationIndex.getTaxonomyBestClassesSensitivity(java.lang.String taxonomyName)
Gets the sensitivity level of the best classes algorithm |
void |
IClassificationIndex.setTaxonomyBestClassesSensitivity(java.lang.String taxonomyName,
BestClassesSensitivity sensitivity)
Sets the threshold of a taxonomy |
boolean |
IClassificationIndex.isTrainingDocument(IResource document,
RID taxonomyClassRid)
|
ClassificationStatus |
IClassificationIndex.getDocumentClassificationStatus(IResource document,
java.lang.String taxonomyName)
Gets the classification status of a document for a taxonomy |
void |
IClassificationIndex.setDocumentClassificationStatus(IResource document,
java.lang.String taxonomyName,
ClassificationStatus status)
Sets the classification status of a document for a taxonomy |
void |
IClassificationIndex.setDocumentClassificationStatus(IResource document,
java.lang.String taxonomyName,
ClassificationStatus status,
java.lang.String notToSend)
This method is for internal usage only |
void |
IClassificationIndex.setDocumentClassificationStatus(IResource document,
java.lang.String taxonomyName,
ClassificationStatus status,
boolean sendEvents,
java.lang.String notToSend)
This method is for internal usage only |
void |
IClassificationIndex.setDocumentClassificationStatus(IResourceList documents,
java.lang.String taxonomyName,
ClassificationStatus status)
Sets the classification status for a list of documents for a taxonomy |
IResourceList |
IClassificationIndex.getDocumentsToClassify(java.lang.String taxonomyName)
Deprecated. as of NW04. Use getDocumentsToClassify(String,IResourceContext) |
IResourceList |
IClassificationIndex.getDocumentsNeverToClassify(java.lang.String taxonomyName)
Deprecated. as of NW04. Use getDocumentsNeverToClassify(String,IResourceContext) |
IResourceList |
IClassificationIndex.getDocumentsToClassify(java.lang.String taxonomyName,
IResourceContext context)
Gets all documents of an index that have the status "to classify" in a taxonomy |
IResourceList |
IClassificationIndex.getDocumentsNeverToClassify(java.lang.String taxonomyName,
IResourceContext context)
Gets all documents of an index that have the status "never to classify" in a taxonomy |
IRidList |
IClassificationIndex.getDocumentRidsToClassify(java.lang.String taxonomyName,
IResourceContext context)
Gets all RIDs of documents of an index that have the status "to classify" in a taxonomy |
IRidList |
IClassificationIndex.getDocumentRidsNeverToClassify(java.lang.String taxonomyName,
IResourceContext context)
Gets all RIDs of documents for an index that have the status "never to classify" in a taxonomy |
RID |
IClassificationIndex.getSpecialFolderRID(java.lang.String taxonomyName,
SpecialFolder specialFolderType)
|
TaxonomyType |
IClassificationIndex.getTaxonomyType(java.lang.String taxonomyName)
|
void |
IClassificationIndex.setTaxonomyType(java.lang.String taxonomyName,
TaxonomyType taxonomyType)
|
IRidList |
IClassificationIndex.getDocumentTrainingClasses(IResource document)
Gets all taxonomy classes for which the document is a training document |
IRidList |
IClassificationIndex.getManuallyDeclassifiedClasses(IResource document)
|
void |
IClassificationIndex.removeCategoryAssignments(ICollection deletedCategoryFolder)
Removes the assignment to a deleted category for all documents in the index |
void |
IClassificationIndex.autoClassifyDocs(java.lang.String taxonomyName,
IRidList docRidList,
IResourceContext context)
Requests proposals for the best categories for the documents and sets these categories automatically as document classification. |
void |
IClassificationIndex.autoClassifyDocs(java.lang.String taxonomyName,
IResourceList docList,
IResourceContext context)
Requests proposals for the best categories for the documents and sets these categories automatically as document classification. |
void |
IClassificationIndex.autoClassifyDocs(java.lang.String taxonomyName,
IResourceContext context)
Requests proposals for the best categories for documents that have no classification and sets these categories automatically as document classification. |
void |
IClassificationIndex.synchronizeTaxonomyMetaData(java.lang.String taxonomyName)
Rebuilds the taxonomy meta data on the classification engine. |
void |
IClassificationIndex.updateSearchCategoryAttributes(IResourceList oldResourceListe,
IResourceList newResourceListe,
java.lang.String taxonomyName,
RID categoryRid)
The attributes neccessary for searching in taxonomies are modified on the index server only. |
UpdateTaxonomyState |
IClassificationIndex.getUpdateTaxonomyState(java.lang.String taxonomyName)
Returns the actual state of the taxonomy with respect to an actually running update. |
UpdateTaxonomyState |
IClassificationIndex.getUpdateTaxonomyState(java.lang.String taxonomyName,
java.util.Locale locale)
Returns the actual state of the taxonomy with respect to an actually running update. |
void |
ITaxonomyCollection.sendEventForLink(int eventType,
RID taxonomyClassRid,
RID targetRid,
IResourceContext context)
Creates a link resource object and sends an event of the given event type |
void |
ITaxonomyCollection.sendEventForLink(int eventType,
RID taxonomyClassRid,
RID targetRid,
IResourceContext context,
IResourceEvent originalEvent)
Creates a link resource object and sends an event of the given event type |
void |
ICompareTaxonomies.compareTaxonomies(IClassificationIndex index1,
java.lang.String taxname1,
IClassificationIndex index2,
java.lang.String taxname2,
IResourceContext context)
Compares two taxonomies. |
IDocClassificationMap |
DocClassificationMapList.get(RID documentRid)
|
| Constructors in com.sapportals.wcm.service.indexmanagement.retrieval.classification that throw WcmException | |
AbstractClassificationIndex(java.lang.String indexId,
java.lang.String indexName,
java.lang.String indexGroup,
IIndexFolderList indexFolders,
java.lang.String serviceId,
java.lang.String serviceUserId,
java.util.Properties indexServiceProperties)
Deprecated. as of NW04. Use constructor with crawler profile ID |
|
AbstractClassificationIndex(java.lang.String indexId,
java.lang.String indexName,
java.lang.String indexGroup,
IIndexFolderList indexFolders,
java.lang.String serviceId,
java.lang.String crawlerProfileId,
java.lang.String serviceUserId,
java.util.Properties indexServiceProperties)
|
|
| Uses of WcmException in com.sapportals.wcm.service.indexmanagement.retrieval.search |
| Methods in com.sapportals.wcm.service.indexmanagement.retrieval.search that throw WcmException | |
java.util.Collection |
IExtendedSearchIndex.getDocumentAbstracts(ISearchResultList searchResults)
gets the abstract of documents |
java.util.Collection |
IExtendedSearchIndex.getHighlightedContent(ISearchResultList searchResults,
IQueryEntryList queryList)
gets the hightlighted content of resources with respect to the queryList |
java.util.Collection |
IExtendedSearchIndex.getHighlightedSummary(ISearchResultList searchResults,
IQueryEntryList queryList,
int maxNumberOfWords)
Returns a summary for all input documents. |
void |
IQueryEntry.setRowType(java.lang.String rowType)
Sets the row type |
void |
IQueryEntry.setTermWeight(float weight)
Sets the term weight the term weight goes from 0.0 ... 1.0 |
void |
IQueryEntry.setTermAction(byte termAction)
Adds a term action; the term action defines how the search is executed (fuzzy, exact,...) (it must only be called when the row type is ROW_TYPE_ATTRIBUTE or ROW_TYPE_TERM) |
void |
IQueryEntry.setPropertyType(byte propertyType)
Adds a property type. |
void |
IQueryEntry.setPropertyName(java.lang.String propertyName)
Deprecated. as of NW04. See setPropertyName(IPropertyName) |
void |
IQueryEntry.setPropertyName(IPropertyName cmPropertyName)
Optional: defines in which attribute the search is to be executed if an attribute search is executed |
ISearchSession |
ISearchSessionProvider.getSearchSession()
get search session from SearchRendererStatus |
ISearchResultList |
ISearchIndex.executeQuery(IQueryEntryList queryEntryList,
IResourceContext context,
int maxResults)
Executes the search |
ISearchResultList |
ISearchIndex.executeQuery(IQueryEntryList queryEntryList,
IResourceContext context,
int maxResults,
ICollection searchFromHere)
Executes the search |
ISearchSession |
ISearchIndex.executeQueryWithSession(IQueryEntryList queryEntryList,
IResourceContext context)
Executes the search |
ISearchSession |
ISearchIndex.executeQueryWithSession(IQueryEntryList queryEntryList,
IResourceContext context,
ICollection searchFromHere)
Executes the search |
ISearchResultList |
ISearchIndex.searchSimilarDocuments(IResourceList searchDocuments,
int maxResults)
searches similar documents |
ISearchSession |
ISearchIndex.searchSimilarDocumentsWithSession(IResourceList searchDocuments)
searches similar documents |
java.util.Collection |
ISearchIndex.searchSimilarTerms(java.util.Collection terms,
int maxTerms)
searches similar terms to a collection of terms |
java.util.Collection |
ISearchIndex.getDocumentFeatures(IResourceList resourceDocuments,
int maxFeatures)
gets the features of documents |
java.util.Collection |
ISearchIndex.getDocumentAbstracts(IResourceList resourceDocuments)
gets the abstract of documents |
java.lang.String |
ISearchIndex.getQueryAsString()
Deprecated. as of NW04. |
void |
ISearchIndex.loadQuery(java.util.Properties props)
Deprecated. as of NW04. |
java.util.Map |
ISearchIndex.doGeneric(java.lang.String function,
java.util.Map parameters)
this method enables an index service to perform classification actions that are not reflected by the interface. |
ISearchSession |
ISearchIndexCollection.executeQueryWithSession(IQueryEntryList queryEntryList,
IResourceContext context)
Executes the search |
ISearchSession |
ISearchIndexCollection.executeQueryWithSession(IQueryEntryList queryEntryList,
IResourceContext context,
int initNumberMaxRawResults)
Executes the search |
ISearchResultList |
ISearchIndexCollection.executeQuery(IQueryEntryList queryEntryList,
IResourceContext context,
int maxResults)
Executes the search |
ISearchResultList |
ISearchIndexCollection.executeQuery(IQueryEntryList queryEntryList,
IResourceContext context,
int maxResults,
ICollection searchFromHere)
Executes the search |
ISearchResultList |
ISearchIndexCollection.executeQuery(IQueryEntryList queryEntryList,
IResourceContext context,
int maxResults,
ICollection searchFromHere,
java.util.Set languages)
Executes the search |
ISearchSession |
ISearchIndexCollection.executeQueryWithSession(IQueryEntryList queryEntryList,
IResourceContext context,
ICollection searchFromHere)
Executes the search |
ISearchSession |
ISearchIndexCollection.executeQueryWithSession(IQueryEntryList queryEntryList,
IResourceContext context,
int initNumberMaxRawResults,
ICollection searchFromHere)
Executes the search |
ISearchSession |
ISearchIndexCollection.executeQueryWithSession(IQueryEntryList queryEntryList,
IResourceContext context,
int initNumberMaxRawResults,
ICollection searchFromHere,
ISortPropertyName sortProperty)
Executes the search |
ISearchSession |
ISearchIndexCollection.executeQueryWithSession(IQueryEntryList queryEntryList,
IResourceContext context,
int initNumberMaxRawResults,
ICollection searchFromHere,
ISortPropertyName sortProperty,
java.util.Set languages)
Executes the search |
ISearchSession |
ISearchIndexCollection.executeQueryWithSession(IQueryEntryList queryEntryList,
IResourceContext context,
int initNumberMaxRawResults,
IRidList searchFromHereList,
ISortPropertyName sortProperty,
java.util.Set languages)
Executes the search |
ISearchResultList |
ISearchIndexCollection.searchSimilarDocuments(IResourceList searchDocuments,
int maxResults)
searches similar documents |
ISearchSession |
ISearchIndexCollection.searchSimilarDocumentsWithSession(IResourceList searchDocuments)
searches similar documents |
ISearchSession |
ISearchIndexCollection.searchSimilarDocumentsWithSession(IResourceList searchDocuments,
int initNumberMaxRawResults)
searches similar documents |
ISearchSession |
ISearchIndexCollection.searchSimilarDocumentsWithSession(IResourceList searchDocuments,
int initNumberMaxRawResults,
ISortPropertyName sortProperty)
searches similar documents |
java.util.Collection |
ISearchIndexCollection.searchSimilarTerms(java.util.Collection terms,
int maxTerms)
searches similar terms to a collection of terms |
java.lang.String |
ISearchIndexCollection.getQueryAsString()
Deprecated. as of NW04. |
void |
ISearchIndexCollection.loadQuery(java.util.Properties props)
Deprecated. as of NW04. |
void |
ISearchIndexCollection.addIndex(IIndex index)
Adds an index to the index collection |
IPropertyDistributionList |
ISearchIndexCollection.getPropertyDistributionOverview(IQueryEntryList queryEntryList,
ICollection searchFromHere,
IResourceContext context,
ISearchIndex index)
Returns basic information about the distribution of the properties of an index, only considering the documents fullfilling the search restriction. |
IPropertyDistributionList |
ISearchIndexCollection.getPropertyDistributionOverview(IQueryEntryList queryEntryList,
ICollection searchFromHere,
IResourceContext context,
java.util.Collection indexList)
Returns basic information about the distribution of the properties of the indexes, only considering the documents fullfilling the search restriction. |
IPropertyDistributionList |
ISearchIndexCollection.getPropertyDistributionOverview(IQueryEntryList queryEntryList,
ICollection searchFromHere,
IResourceContext context)
Returns basic information about the distribution of the properties of the indexes, of the SearchIndexCollection only considering the documents fullfilling the search restriction. |
IPropertyRangeList |
ISearchIndexCollection.getPropertyRanges(IPropertyName propertyName,
IQueryEntryList queryEntryList,
ICollection searchFromHere,
IResourceContext context,
ISearchIndex index)
Returns the ranges of the properties of an index, only considering the documents fullfilling the search restriction. |
IPropertyRangeList |
ISearchIndexCollection.getPropertyRanges(IPropertyName propertyName,
IQueryEntryList queryEntryList,
ICollection searchFromHere,
IResourceContext context,
java.util.Collection indexList)
Returns the ranges of the properties of the indexes, only considering the documents fullfilling the search restriction. |
IPropertyRangeList |
ISearchIndexCollection.getPropertyRanges(IPropertyName propertyName,
IQueryEntryList queryEntryList,
ICollection searchFromHere,
IResourceContext context)
Returns the ranges of the properties of the indexes of the ISearchIndexCollection, only considering the documents fullfilling the search restriction. |
java.util.Collection |
ISearchIndexCollection.getPropertyValues(IPropertyName propertyName,
IQueryEntryList queryEntryList,
ICollection searchFromHere,
IResourceContext context,
ISearchIndex index)
Returns the distinct property values of an index, only considering the documents fullfilling the search restriction. |
java.util.Collection |
ISearchIndexCollection.getPropertyValues(IPropertyName propertyName,
IQueryEntryList queryEntryList,
ICollection searchFromHere,
IResourceContext context,
java.util.Collection indexes)
Returns the distinct property values of the indexes for the specified property, only considering the documents fullfilling the search restriction. |
java.util.Collection |
ISearchIndexCollection.getPropertyValues(IPropertyName propertyName,
IQueryEntryList queryEntryList,
ICollection searchFromHere,
IResourceContext context)
Returns the distinct property values of all indexes of the ISearchIndexCollection for the specified property, only considering the documents fullfilling the search restriction. |
java.util.List |
IRawSearchSession.getRawSearchResults(int newMaxResults)
If the session has less than new max results a search with newMaxResults is performed and these raw results are returned. |
abstract ISearchResultList |
AbstractSearchIndexCollection.executeQuery(IQueryEntryList queryEntryList,
IResourceContext context,
int maxResults)
|
abstract ISearchResultList |
AbstractSearchIndexCollection.executeQuery(IQueryEntryList queryEntryList,
IResourceContext context,
int maxResults,
ICollection searchFromHere)
|
abstract ISearchResultList |
AbstractSearchIndexCollection.executeQuery(IQueryEntryList queryEntryList,
IResourceContext context,
int maxResults,
ICollection searchFromHere,
java.util.Set languages)
|
abstract ISearchSession |
AbstractSearchIndexCollection.executeQueryWithSession(IQueryEntryList queryEntryList,
IResourceContext context)
|
abstract ISearchSession |
AbstractSearchIndexCollection.executeQueryWithSession(IQueryEntryList queryEntryList,
IResourceContext context,
ICollection searchFromHere)
|
abstract ISearchSession |
AbstractSearchIndexCollection.executeQueryWithSession(IQueryEntryList queryEntryList,
IResourceContext context,
int initNumberMaxRawResults)
|
abstract ISearchSession |
AbstractSearchIndexCollection.executeQueryWithSession(IQueryEntryList queryEntryList,
IResourceContext context,
int initNumberMaxRawResults,
ICollection searchFromHere)
|
abstract ISearchSession |
AbstractSearchIndexCollection.executeQueryWithSession(IQueryEntryList queryEntryList,
IResourceContext context,
int initNumberMaxRawResults,
ICollection searchFromHere,
ISortPropertyName sortProperty)
|
ISearchSession |
AbstractSearchIndexCollection.executeQueryWithSession(IQueryEntryList queryEntryList,
IResourceContext context,
int initNumberMaxRawResults,
ICollection searchFromHere,
ISortPropertyName sortProperty,
java.util.Set languages)
|
ISearchSession |
AbstractSearchIndexCollection.executeQueryWithSession(IQueryEntryList queryEntryList,
IResourceContext context,
int initNumberMaxRawResults,
IRidList searchFromHereList,
ISortPropertyName sortProperty,
java.util.Set languages)
|
abstract ISearchResultList |
AbstractSearchIndexCollection.searchSimilarDocuments(IResourceList searchDocuments,
int maxResults)
|
abstract ISearchSession |
AbstractSearchIndexCollection.searchSimilarDocumentsWithSession(IResourceList searchDocuments)
|
abstract ISearchSession |
AbstractSearchIndexCollection.searchSimilarDocumentsWithSession(IResourceList searchDocuments,
int initNumberMaxRawResults)
|
abstract java.util.Collection |
AbstractSearchIndexCollection.searchSimilarTerms(java.util.Collection terms,
int maxTerms)
|
java.lang.String |
AbstractSearchIndexCollection.getQueryAsString()
Deprecated. as of NW04. |
void |
AbstractSearchIndexCollection.loadQuery(java.util.Properties props)
Deprecated. as of NW04. |
IPropertyDistributionList |
AbstractSearchIndexCollection.getPropertyDistributionOverview(IQueryEntryList queryEntryList,
ICollection searchFromHere,
IResourceContext context,
ISearchIndex index)
|
IPropertyDistributionList |
AbstractSearchIndexCollection.getPropertyDistributionOverview(IQueryEntryList queryEntryList,
ICollection searchFromHere,
IResourceContext context,
java.util.Collection indexList)
|
IPropertyDistributionList |
AbstractSearchIndexCollection.getPropertyDistributionOverview(IQueryEntryList queryEntryList,
ICollection searchFromHere,
IResourceContext context)
|
IPropertyRangeList |
AbstractSearchIndexCollection.getPropertyRanges(IPropertyName propertyName,
IQueryEntryList queryEntryList,
ICollection searchFromHere,
IResourceContext context,
ISearchIndex index)
|
IPropertyRangeList |
AbstractSearchIndexCollection.getPropertyRanges(IPropertyName propertyName,
IQueryEntryList queryEntryList,
ICollection searchFromHere,
IResourceContext context,
java.util.Collection indexList)
|
IPropertyRangeList |
AbstractSearchIndexCollection.getPropertyRanges(IPropertyName propertyName,
IQueryEntryList queryEntryList,
ICollection searchFromHere,
IResourceContext context)
|
java.util.Collection |
AbstractSearchIndexCollection.getPropertyValues(IPropertyName propertyName,
IQueryEntryList queryEntryList,
ICollection searchFromHere,
IResourceContext context,
ISearchIndex index)
|
java.util.Collection |
AbstractSearchIndexCollection.getPropertyValues(IPropertyName propertyName,
IQueryEntryList queryEntryList,
ICollection searchFromHere,
IResourceContext context,
java.util.Collection indexes)
|
java.util.Collection |
AbstractSearchIndexCollection.getPropertyValues(IPropertyName propertyName,
IQueryEntryList queryEntryList,
ICollection searchFromHere,
IResourceContext context)
|
protected ISearchSession |
AbstractSearchIndexCollection.getNewSearchSession(IQueryEntryList queryEntries,
IRidList searchFromHereList,
ISearchIndexCollection searchIndexCollection,
IResourceContext context,
int initMaxRawResults,
ISortPropertyName sortProperty)
Gets a new search session instance |
protected ISearchResult |
AbstractSearchIndexCollection.createSearchResultObject(IResource resource,
float rankValue)
Gets a search result object initialized with the given resource and rank value. |
static ISearchResult |
AbstractSearchIndexCollection.createNewSearchResultObject(IResource resource,
float rankValue)
Creates a new search result object containing the resource and rank values of the parameters. |
protected ISearchSession |
AbstractSearchIndexCollection.getNewSearchSession(IResourceList similarDocsInput,
ISearchIndexCollection searchIndexCollection,
IResourceContext context,
int initMaxRawResults,
ISortPropertyName sortProperty)
Gets a new search session instance |
java.util.List |
IFederatedSearch.getSearchIndexes()
Deprecated. as of NW04. Use getSearchIndexes(IResourceContext) |
java.util.List |
IFederatedSearch.getSearchIndexes(IResourceContext context)
Gets all indexes that contain one ore more repositories where the index is a search index. |
ISearchResultList |
IFederatedSearch.search(IQueryEntryList queryEntryList,
java.util.List indexes,
int maxResults,
IResourceContext context)
Performs a search within a list of search indexes. |
ISearchSession |
IFederatedSearch.searchWithSession(IQueryEntryList queryEntryList,
java.util.List indexes,
IResourceContext context)
Performs a search within a list of search indexes. |
ISearchSession |
IFederatedSearch.searchWithSession(IQueryEntryList queryEntryList,
java.util.List indexes,
IResourceContext context,
ISortPropertyName sortProperty)
Performs a search within a list of search indexes. |
ISearchResultList |
IFederatedSearch.search(IQueryEntryList queryEntryList,
ICollection searchFromHere,
int maxResults,
IResourceContext context)
Performs a search within a list of search indexes restricted by a path. |
ISearchSession |
IFederatedSearch.searchWithSession(IQueryEntryList queryEntryList,
ICollection searchFromHere,
IResourceContext context)
Performs a search within a list of search indexes restricted by a path. |
ISearchSession |
IFederatedSearch.searchWithSession(IQueryEntryList queryEntryList,
ICollection searchFromHere,
IResourceContext context,
ISortPropertyName sortProperty)
Performs a search within a list of search indexes restricted by a path. |
ISearchSession |
IFederatedSearch.searchWithSession(IQueryEntryList queryEntryList,
ICollection searchFromHere,
IResourceContext context,
ISortPropertyName sortProperty,
java.util.Set languages)
Performs a search within a list of search indexes restricted by a path. |
ISearchSession |
IFederatedSearch.searchWithSession(IQueryEntryList queryEntryList,
IRidList searchFromHereList,
IResourceContext context,
ISortPropertyName sortProperty,
java.util.Set languages)
|
ISearchResultList |
IFederatedSearch.searchSimilarDocuments(java.util.List indexes,
IResourceList documents,
int maxResults)
Performs a federated similar document search. |
ISearchSession |
IFederatedSearch.searchSimilarDocumentsWithSession(java.util.List indexes,
IResourceList documents)
Performs a federated similar document search. |
ISearchSession |
IFederatedSearch.searchSimilarDocumentsWithSession(java.util.List indexes,
IResourceList documents,
ISortPropertyName sortProperty)
Performs a federated similar document search. |
java.util.List |
IFederatedSearch.searchSimilarTerms(java.util.List indexes,
java.util.Collection terms,
int maxResults)
Searches for terms to a similar to a collection of terms. |
ISearchResultList |
ISearchSession.getSearchResults(int from,
int to)
List of search results from position a to b in the result list. |
ISearchResultList |
ISearchSession.getSearchResults(int from,
int to,
com.sapportals.wcm.service.resourcelistfilter.IResourceListFilter resourceListFilter,
com.sapportals.wcm.repository.service.layout.customizing.IParameters filterParameters)
List of search results from position a to b in the result list. |
| Constructors in com.sapportals.wcm.service.indexmanagement.retrieval.search that throw WcmException | |
SortPropertyName(IPropertyName propertyName,
PropertyType propertyType,
boolean sortDirection)
|
|
| Uses of WcmException in com.sapportals.wcm.service.landscape |
| Subclasses of WcmException in com.sapportals.wcm.service.landscape | |
class |
CredentialExistsException
(internal use only) Indicates that a credential already exists. |
class |
LandscapeException
(internal use only) Indicates that an internal error occured in the landscape service. |
class |
LandscapePersistenceException
(internal use only) Indicates that an internal error occured in the landscape service while trying to save or retrieve data. |
class |
SystemExistsException
(internal use only) Indicates that a system already exists. |
| Methods in com.sapportals.wcm.service.landscape that throw WcmException | |
static ILandscapeService |
LandscapeServiceFactory.lookup()
Get an instance of the scheduler service. |
static void |
LandscapeServiceFactory.release(ILandscapeService service)
|
ISystemFactory |
ILandscapeService.getSystemFactory()
Get the system factory. |
AutoID |
ILandscapeService.getAutoID(java.lang.String tableName)
Retrieve an auto id object. |
| Constructors in com.sapportals.wcm.service.landscape that throw WcmException | |
AutoID(java.lang.String name)
|
|
| Uses of WcmException in com.sapportals.wcm.service.mimehandler |
| Methods in com.sapportals.wcm.service.mimehandler that throw WcmException | |
IMime |
IMimeHandlerService.get(java.lang.String extension)
Returns a mime type for the given extension. |
IMime |
IMimeHandlerService.getMime(java.lang.String mime)
Returns a mime type for the given mime type string representation. |
IMime |
IMimeHandlerService.get(IResource resource)
Returns a mime type for the given resource. |
IMime |
IMimeHandlerService.get(RID rid)
Returns a mime type for the given RID. |
IMime[] |
IMimeHandlerService.getMimetypes()
Returns all registered mime types. |
| Uses of WcmException in com.sapportals.wcm.service.notificator |
| Methods in com.sapportals.wcm.service.notificator that throw WcmException | |
static void |
MimeUtils.copyContentToOutputstream(IContent content,
java.io.OutputStream out)
|
static IContent |
MimeUtils.getContentFromString(java.lang.String text,
java.lang.String type)
convert a String to a content. |
static java.lang.String |
MimeUtils.getContentAsString(IContent content)
convert a IContent to a string. |
static IContent |
MimeUtils.getContent(javax.mail.internet.MimePart mimepart)
set the content of a MimeMessage to the given body content. |
static javax.mail.internet.MimeMessage |
MimeUtils.setContent(javax.mail.internet.MimeMessage mimemessage,
IContent body)
set the content of a MimeMessage to the given body content. |
static javax.mail.internet.MimeMessage |
MimeUtils.setContent(javax.mail.internet.MimeMessage mimemessage,
IContent body,
IResource[] attachments)
set the content of a MimeMessage to a given body content with
several attachments. |
IContent |
INotification.getContent(IRecipient recipient,
IChannel channel,
java.util.Properties properties)
Get the content (depending on recipient and channel). |
protected RID |
AbstractNotification.getXmlRID(IResourceFactory factory,
java.lang.String templates,
IRecipient recipient)
Get the uri to use for the XML by trying several locale-specific uris. |
protected RID |
AbstractNotification.getXslRID(IResourceFactory factory,
java.lang.String templates,
IChannel channel)
Get the uri to use for the XSL by trying a channel-specific uri first. |
protected IProducer |
AbstractNotification.getXmlProducer(IResourceFactory factory,
RID xmlRID)
Get the XML producer for feeding the pipeline. |
protected IProducer |
AbstractNotification.getXslProducer(IResourceFactory factory,
RID xslRID)
Get the XSL producer for feeding the pipeline. |
IContent |
AbstractNotification.getContent(IRecipient recipient,
IChannel channel,
java.util.Properties properties)
|
java.util.Collection |
INotificatorService.getChannels()
Get a list of available channels for this notificator. |
void |
INotificatorService.send(IRecipient recipient,
IChannel channel,
INotification notification)
Send a notification to a recipient via the specified channel. |
void |
INotificatorService.send(IRecipientList recipients,
IChannel channel,
INotification notification)
|
java.lang.String |
INotificatorService.getDefaultFromAddress(IChannel channel)
Get the default from address for a channel. |
| Uses of WcmException in com.sapportals.wcm.service.objecttypehandler |
| Methods in com.sapportals.wcm.service.objecttypehandler that throw WcmException | |
IObjectTypeHandlerList |
IObjectTypeHandlerService.getEmptyObjectTypeHandlerList()
|
IObjectTypeHandlerList |
IObjectTypeHandlerService.getObjectTypeHandler()
Get the ObjectTypeHandler attribute of the IObjectTypeHandlerService object. |
IObjectTypeHandlerList |
IObjectTypeHandlerService.getObjectTypeHandler(IResource resource)
Get the ObjectTypeHandlerList that matches for this resource. |
IObjectTypeHandlerList |
IObjectTypeHandlerService.getObjectTypeHandler(IResource resource,
IActionType actionType)
Gets the List of ObjectTypeHandlers which are valid for the given resource and which implement the wanted IActionType There are several
internal filters realized a) resourceType b) mimeType (not for ICollection
objects) c) extension (not for ICollection objects) d) actiontype In a
first step, all ObjectTypeHandler for the RID of the resource are returned.
|
void |
IObjectTypeHandlerService.reload()
Reloads all oth definitions. |
IObjectTypeHandlerList |
IObjectTypeHandlerService.getObjectTypeHandlerList(java.util.Vector resourceTypes)
|
void |
IObjectTypeHandler.initialize(java.lang.String name,
java.util.Vector extensions,
java.util.Vector mimeTypes,
java.util.Vector paths,
IActionList actionList,
java.util.Vector resourceTypes,
java.util.Properties props)
TODO: Description of the Method. |
java.lang.String |
IObjectTypeHandler.getName()
Get the Name attribute of the IObjectTypeHandler object. |
URL |
IObjectTypeHandler.getURL(IResource resource,
IActionType actionType)
Get the URL attribute of the IObjectTypeHandler object. |
URL |
IObjectTypeHandler.getURL(IResource resource,
IActionType actionType,
java.util.Properties props)
Get the URL attribute of the IObjectTypeHandler object. |
IActionList |
ObjectTypeHandlerUtil.getMergedActions(IObjectTypeHandlerList list)
|
java.util.Properties |
ObjectTypeHandlerUtil.getMergedProperties(IObjectTypeHandlerList list)
|
java.util.Collection |
ObjectTypeHandlerUtil.getMergedMultiValuedProperties(IObjectTypeHandlerList list,
java.lang.String propertykey)
|
IObjectTypeHandlerList |
ObjectTypeHandlerUtil.rankHandlers(IObjectTypeHandlerList list)
The ranking mechanism works after the following schema: For every selection criteria given in an IObjectTypeHandler , the algorithms gives
points to this handler if a path is given -> 8 points if a resource type is
given -> 4 points if a mimetype is given -> 2 points if an extension is
given -> 1 point If several handlers have the same score after that
procedure, the length of the resource path acts as the tie breaker: The
more folders of the path are specified, the more exact the match naturally
becomes. |
java.lang.String |
GenericObjectTypeHandler.getName()
Get the Name attribute of the GenericObjectTypeHandler object. |
URL |
GenericObjectTypeHandler.getURL(IResource resource,
IActionType actionType)
Get the URL attribute of the GenericObjectTypeHandler object. |
URL |
GenericObjectTypeHandler.getURL(IResource resource,
IActionType actionType,
java.util.Properties props)
Get the URL attribute of the GenericObjectTypeHandler object. |
void |
GenericObjectTypeHandler.initialize(java.lang.String name,
java.util.Vector extensions,
java.util.Vector mimeTypes,
java.util.Vector paths,
IActionList actionList,
java.util.Vector resourceTypes,
java.util.Properties props)
TBD: Description of the Method. |
void |
GenericObjectTypeHandler.startUpOTH()
Must be called in startUp() method of an OTH service. |
| Constructors in com.sapportals.wcm.service.objecttypehandler that throw WcmException | |
ObjectTypeHandlerUtil(IResource res)
|
|
GenericObjectTypeHandler()
Construct object of class GenericObjectTypeHandler. |
|
| Uses of WcmException in com.sapportals.wcm.service.pipeline |
| Methods in com.sapportals.wcm.service.pipeline that throw WcmException | |
IContent |
IXsltPipelineService.handle(IProducer xml,
IProducer xsl,
java.util.Hashtable properties)
This method calls the XSLT processor. |
IContent |
IXsltPipelineService.handle(IProducer xml,
IProducer xsl,
java.util.Hashtable properties,
java.lang.String mime)
This method calls the XSLT processor. |
IContent |
IXsltPipelineService.handle(java.io.InputStream xml,
java.io.InputStream xsl,
java.util.Hashtable properties)
This method calls the XSLT processor. |
IContent |
IXsltPipelineService.handle(java.io.InputStream xml,
java.io.InputStream xsl,
java.util.Hashtable properties,
java.lang.String mime)
This method calls the XSLT processor. |
IContent |
IXsltPipelineService.handle(IProducer xml,
java.lang.String xslUrl,
java.util.Hashtable properties)
This method calls the XSLT processor. |
IContent |
IXsltPipelineService.handle(IProducer xml,
java.lang.String xslUrl,
java.util.Hashtable properties,
java.lang.String mime)
This method calls the XSLT processor. |
IContent |
IXsltPipelineService.handle(java.lang.String xmlUrl,
java.lang.String xslUrl,
java.util.Hashtable properties)
This method calls the XSLT processor. |
IContent |
IXsltPipelineService.handle(java.lang.String xmlUrl,
java.lang.String xslUrl,
java.util.Hashtable properties,
java.lang.String mime)
This method calls the XSLT processor. |
IContent |
IPipelineService.handle(IProducer producer,
IProcessor defaultProcessor,
java.util.Hashtable properties)
|
java.lang.Object |
IPipelineService.getTool(java.lang.String toolName)
this method returns a tool of the PipelineService. |
IXmlParser |
IPipelineService.getXmlParser()
this method returns the XML Parser used by the PipelineService |
IXslTransformer |
IPipelineService.getXslTransformer()
this method returns the XSL transfomer used by the PipelineService |
java.util.Properties |
IPipelineService.getConfiguration()
this method returns the configuration data von the PipelineService |
| Uses of WcmException in com.sapportals.wcm.service.pipeline.producer |
| Methods in com.sapportals.wcm.service.pipeline.producer that throw WcmException | |
protected RequestData |
AbstractProducer.createRequestData(java.io.InputStream inputStream,
java.lang.String mime)
|
protected org.w3c.dom.Document |
AbstractProducer.createEmptyDom()
|
protected org.w3c.dom.Document |
AbstractProducer.createDOM(java.lang.String xml)
|
RequestData |
ProducerFromUrl.getData()
|
RequestData |
IProducer.getData()
This method is responsible to provide a Content object which contains the XML DOM and/or a stream to non XML data; |
RequestData |
ProducerFromResource.getData()
|
RequestData |
ProducerFromStream.getData()
|
| Constructors in com.sapportals.wcm.service.pipeline.producer that throw WcmException | |
ProducerFromString(org.w3c.dom.Document doc)
|
|
ProducerFromString(java.lang.String xmlString)
|
|
ProducerFromResource(IResource resource)
|
|
ProducerFromStream(java.io.InputStream stream,
java.lang.String url,
java.lang.String mimeType)
|
|
| Uses of WcmException in com.sapportals.wcm.service.propertyconfig |
| Subclasses of WcmException in com.sapportals.wcm.service.propertyconfig | |
class |
PropertyConfigurationServiceException
Used to report critical errors which are written into log file by WcmException constructor. |
| Methods in com.sapportals.wcm.service.propertyconfig that throw WcmException | |
java.lang.String |
IPropertyRendererProxy.dispatchableControlIDWithValues(java.util.ArrayList values)
Create an id that contains dispatch information. |
java.lang.String |
IPropertyRendererProxy.dispatchableControlID(java.lang.String value)
Adds a string to the given parameter to ensure a unique id within a DynPage under certain conditions: the idpart given is unique within this proxy. |
java.util.ArrayList |
IPropertyRendererProxy.decodeValues(com.sapportals.htmlb.event.Event event)
Returns the values created via the dispatchableControlIDWithValues or dispatchableControlID methods
and returns the list of parameters in the same order they were when submitting them.
|
| Uses of WcmException in com.sapportals.wcm.service.propertyconfig.renderer |
| Methods in com.sapportals.wcm.service.propertyconfig.renderer that throw WcmException | |
com.sapportals.htmlb.Component |
IStructuredPropertyRenderer.renderMetaProperty(IMetaName metaName,
IMetaContext rendererContext)
Renders a htmlb Component for a given IMetaName and a given IMetaContext
null as returned component is accepted, if the renderer context does not allowed that the IMetaName to be rendered (The permission should be check).
|
java.lang.String[] |
IStructuredPropertyRenderer.processEvent(IMetaName metaName,
com.sapportals.htmlb.event.Event event,
IMetaContext rendererContext,
com.sapportals.htmlb.page.DynPage dynPage)
The property renderer can react to events. |
IPropertyMap |
IStructuredPropertyRenderer.getProperties(IMetaName metaName,
IMetaContext rendererContext,
com.sapportals.htmlb.page.DynPage dynPage)
Gets the properties with their entered values after the response has been returned. |
| Uses of WcmException in com.sapportals.wcm.service.propertystructure |
| Subclasses of WcmException in com.sapportals.wcm.service.propertystructure | |
class |
PropertyStructureServiceException
WcmException that is thrown inside the property structure service. |
| Uses of WcmException in com.sapportals.wcm.service.relation |
| Subclasses of WcmException in com.sapportals.wcm.service.relation | |
class |
RelationQueryException
An exception concerning the IRelationQueryBuilder . |
| Uses of WcmException in com.sapportals.wcm.service.scheduler |
| Methods in com.sapportals.wcm.service.scheduler that throw WcmException | |
ISchedulerEntry |
ISequence.add(ISchedulerEntry entry)
Appends a scheduler entry to the end of the sequence. |
ISchedulerEntry |
ISequence.add(int index,
ISchedulerEntry entry)
Inserts a scheduler entry to the sequence at position index.
|
boolean |
ISequence.remove(ISchedulerEntry entry)
Removes an entry from the sequence. |
void |
ISequence.clear()
Removes all of the elements from this sequence. |
void |
ISchedulerEntry.setPriority(int priority)
Set the priority of the entry. |
boolean |
ISchedulerEntry.isRunning()
Check if the entry is running(currently being executed). |
boolean |
ISchedulerEntry.isSuspended()
Check if the entry is suspended (currently inactive and not waiting). |
boolean |
ISchedulerEntry.isWaiting()
Check if the entry is not suspended and not active. |
ISchedulerTask |
ISchedulerEntry.getTask()
Get the task for the entry. |
void |
ISchedulerEntry.setTask(ISchedulerTask task)
Set the entry's task. |
ISchedulerTimeTable |
ISchedulerEntry.getTimeTable()
Get the timetable for the entry. |
void |
ISchedulerEntry.setTimeTable(ISchedulerTimeTable timetable)
Set the entry's timetable. |
java.util.Properties |
ISchedulerEntry.getProperties()
Get the properties to pass to the task of the entry. |
void |
ISchedulerEntry.setProperties(java.util.Properties properties)
Set the entry's properties to pass to the task. |
void |
ISchedulerEntry.setSystemList(ISystemList systemList)
Sets the ID of the CM system where to run the ISchedulerTask
physically. |
void |
ISchedulerTimeTable.setStartTime(java.util.Date start)
Set the starting date for the timetable. |
void |
ISchedulerTimeTable.setStopTime(java.util.Date stop)
Set the ending date for the timetable. |
void |
ISchedulerTimeTable.setTable(ISchedulerTimeList timelist)
Deprecated. since KM5.0SP6 |
void |
ISchedulerTimeTable.setTable(ISchedulerTime time)
Deprecated. since KM5.0SP6 |
void |
ISchedulerTimeTable.addToTable(ISchedulerTime time)
Add an time to the times of the timetable. |
ISchedulerTime |
ISchedulerTimeTable.removeFromTable(ISchedulerTime time)
|
ISchedulerEntry |
ISchedulerEntryFactory.createSchedulerEntry(java.lang.String entryID,
int priority,
ISchedulerTask task,
ISchedulerTimeTable timetable,
java.util.Properties properties)
Deprecated. |
ISchedulerEntry |
ISchedulerEntryFactory.createSchedulerEntry(java.lang.String entryID,
int priority,
ISchedulerTask task,
ISchedulerTimeTable timetable,
ISystemList systemList,
java.util.Properties properties)
Deprecated. |
ISchedulerEntry |
ISchedulerEntryFactory.createSchedulerEntry(java.lang.String entryID,
int priority,
ISchedulerTask task,
ISchedulerTimeTable timetable,
ISystemList systemList,
java.util.Properties properties,
boolean save)
Deprecated. |
ISchedulerEntry |
ISchedulerEntryFactory.createSchedulerEntry(java.util.Properties properties)
Deprecated. |
java.util.Properties |
ISchedulerEntryFactory.createSchedulerEntryProperties(ISchedulerEntry entry)
Deprecated. |
ISchedulerEntry |
ISchedulerService.createSchedulerEntry(java.lang.String entryID,
int priority,
ISchedulerTask task,
ISchedulerTimeTable timetable,
java.util.Properties properties)
Register an ISchedulerTask to the scheduler as a new ISchedulerEntry.
|
ISchedulerEntry |
ISchedulerService.createSchedulerEntry(java.lang.String entryID,
int priority,
ISchedulerTask task,
ISchedulerTimeTable timetable,
ISystemList systemList,
java.util.Properties properties)
Register an ISchedulerTask to the scheduler as a new
ISchedulerEntry. |
ISchedulerEntry |
ISchedulerService.getSchedulerEntry(java.lang.String entryID)
Get an ISchedulerEntry by ID. |
ISchedulerEntry |
ISchedulerService.deleteSchedulerEntry(ISchedulerEntry entry)
Deregister an ISchedulerEntry from the scheduler. |
ISchedulerEntry |
ISchedulerService.suspendSchedulerEntryTask(ISchedulerEntry entry)
Suspend an ISchedulerEntry (inactivate it). |
ISchedulerEntry |
ISchedulerService.resumeSchedulerEntryTask(ISchedulerEntry entry)
Resume an ISchedulerEntry (activate it from suspended). |
ISchedulerEntry[] |
ISchedulerService.getLocalSchedulerEntries()
Returns all scheduler entries to be performed on system.
|
ISchedulerEntry[] |
ISchedulerService.getSchedulerEntries()
Returns all scheduler entries of the cluster. |
ISequence |
ISchedulerService.createSequence(java.lang.String id)
Creates and registers a new task sequence. |
ISequence |
ISchedulerService.getSequence(java.lang.String id)
Returns a registered sequence or null if the sequence does not exist. |
ISequence[] |
ISchedulerService.getSequences()
Returns all registered sequences. |
ISequence |
ISchedulerService.deleteSequence(ISequence sequence)
Removes a sequence from the scheduler |
ISequence[] |
ISchedulerService.getSequences(ISchedulerEntry entry)
Returns all sequences that contain the entry or an empty array if
the entry does not belong to a sequence or the entry is not registered on the the scheduler service. |
ISchedulerTimeTable |
ISchedulerService.createTimeTable()
Create an (empty) time table. |
ISchedulerTime |
ISchedulerService.createTimeWildcard()
Get a scheduler time for the current time. |
ISchedulerEntry |
ISchedulerService.updateSchedulerEntry(ISchedulerEntry entry)
Deprecated. since EP6.0SP1 |
ISchedulerEntry |
ISchedulerService.addSchedulerEntry(ISchedulerEntry entry)
Deprecated. since EP6.0SP1: new scheduler tasks are already added to the scheduler |
ISchedulerEntryList |
ISchedulerService.getAllSchedulerEntries()
Deprecated. since KM 5.0 SP6. Returns an empty list. |
static ISchedulerService |
SchedulerServiceFactory.lookup()
Get an instance of the scheduler service. |
void |
SchedulerServiceFactory.release(ISchedulerService service)
|
boolean |
ISchedulerTime.setMonthDay(int year,
int month,
int monthday,
int hour,
int minute)
Set the time to the given values for month and monthday. |
boolean |
ISchedulerTime.setWeekDay(int year,
int month,
int weekday,
int hour,
int minute)
Set the time to the given values for weekday. |
boolean |
ISchedulerTime.setWeekOfMonth(int year,
int month,
int weekday,
int weekofmonth,
int hour,
int minute)
Set the time to the given values for the week of the month. |
int |
ISchedulerTime.get(int field)
Get time values, as in Calendar. |
boolean |
ISchedulerTime.set(int field,
int value)
Set time values, as in Calendar. |
boolean |
ISchedulerTime.setAsText(java.lang.String text)
Set the time in a textual representation. |
void |
ISchedulerTime.setTimeZone(java.util.TimeZone zone)
Sets the time zone of this scheduler time belongs to. |
java.util.TimeZone |
ISchedulerTime.getTimeZone()
Returns the time zone this scheduler time belongs to. |
| Uses of WcmException in com.sapportals.wcm.service.taskqueue |
| Subclasses of WcmException in com.sapportals.wcm.service.taskqueue | |
class |
TaskQueueException
An exception wrapper for the task queue service. |
class |
TaskStateTransitionException
An excpetion that is raised on illegal task state tranistions. |
| Methods in com.sapportals.wcm.service.taskqueue that throw WcmException | |
ITask |
ITaskQueueReader.get()
Removes the task at the top of the task queue and returns it. |
ITask |
ITaskQueueReader.get(long timeout)
Removes the task at the top of the task queue and returns it. |
ITask |
ITaskQueueReader.top()
Returns the top elemet of the task queue. |
void |
ITaskQueueReader.setState(ITask task,
TaskState state)
Sets the task's state to a new state . |
static ITaskQueueService |
TaskQueueServiceFactory.lookup()
Get an instance of the task queue service. |
static void |
TaskQueueServiceFactory.release(ITaskQueueService service)
|
ITaskQueueWriter |
ITaskQueueService.getTaskQueueWriter(java.lang.String user,
java.lang.String namespace)
Returns a task queue writer for write acccess to the queue service. |
ITaskQueueReader |
ITaskQueueService.getTaskQueueReader(java.lang.String user,
java.lang.String namespace)
Returns a task queue reader for read acccess to the queue service. |
ITaskQueueIterator |
ITaskQueueService.monitorTaskQueue(java.lang.String namespace)
Returns an iterator for tasks belonging to service . |
ITaskQueueIterator |
ITaskQueueService.monitorTaskQueue(TaskState state)
Returns an iterator for tasks that have task state state .
|
ITask |
ITaskQueueService.monitorTask(java.lang.String id)
Returns a task with id id |
ITaskQueueIterator |
ITaskQueueService.monitorTaskQueues()
Returns an iterator for all queued tasks. |
boolean |
ITaskQueueService.removeTask(ITask task)
Removes a task that is queued by this service. |
ITask |
ITaskQueue.add(ITask task)
Adds an entry to the end of the queue. |
ITask |
ITaskQueue.get()
Removes and returns a task from the head of the queue. |
ITask |
ITaskQueue.top()
Returns a task from the head of the queue. |
boolean |
ITaskQueue.removeTask(ITask task)
Removes a task that is queued by this service. |
boolean |
ITaskQueue.isEmpty()
Indicates if the queue is empty. |
ITask |
ITaskQueueWriter.add(ITask task)
Adds an entry to the end of the queue. |
void |
ITaskQueueWriter.setState(ITask task,
TaskState state)
Sets the task's state to a new state . |
ITask |
ITaskQueueWriter.createTask()
Factory method to create task objects. |
ITask |
ITaskQueueWriter.createTask(java.util.Properties properties)
Factory method to create task objects. |
ITask |
ITaskQueueWriter.createTask(java.util.Properties properties,
java.lang.String description)
Factory method to create task objects. |
ITask |
ITaskQueueWriter.createTask(java.util.Properties properties,
java.lang.String description,
int priority)
Factory method to create task objects. |
| Uses of WcmException in com.sapportals.wcm.service.urimapper |
| Methods in com.sapportals.wcm.service.urimapper that throw WcmException | |
java.lang.String |
IUriMapperService.getConstantID(RID rid)
Maps a given RID onto a constant unique ID. |
java.lang.String |
IUriMapperService.getConstantID(URI uri)
Deprecated. as of NW04. |
java.lang.String[] |
IUriMapperService.getConstantIDs(IRidList ridList)
Maps a list of RIDs to a list of constant unique IDs. |
java.lang.String |
IUriMapperService.getCreateConstantID(RID rid)
Maps a given URI onto a constant unique ID. |
java.lang.String |
IUriMapperService.getCreateConstantID(URI uri)
Deprecated. as of NW04. |
URI |
IUriMapperService.getUriFromConstantID(java.lang.String constantID)
Deprecated. as of NW04. |
RID |
IUriMapperService.getRIDFromConstantID(java.lang.String constantID)
Maps a given constant ID onto the matching RID. |
java.lang.String |
IUriMapperService.getVariableID(URI uri)
Deprecated. as of NW04. |
java.lang.String |
IUriMapperService.getVariableID(RID rid)
Maps a given RID onto a variable unique ID. |
java.lang.String |
IUriMapperService.getCreateVariableID(URI uri)
Deprecated. as of NW04. |
java.lang.String |
IUriMapperService.getCreateVariableID(RID rid)
Maps a given RID onto a variable unique ID. |
URI |
IUriMapperService.getUriFromVariableID(java.lang.String variableID)
Deprecated. as of NW04. |
RID |
IUriMapperService.getRIDFromVariableID(java.lang.String variableID)
Maps a given variable ID onto the matching RID. |
java.lang.String[] |
IUriMapperService.getVariableIDs(IRidList ridList)
Maps a list of RIDs to a list of variable unique IDs. |
void |
IUriMapperService.removeMultipleIDs(URI id)
Deprecated. as of NW04. |
void |
IUriMapperService.removeMultipleIDs(RID id)
Remove mapping for the given RID and all descendants, e.g. id/*. |
boolean |
IUriMapperService.removeSingleID(URI id)
Deprecated. as of NW04. |
boolean |
IUriMapperService.removeSingleID(RID id)
Remove mapping for the given RID. |
void |
IUriMapperService.renameMultipleIDs(URI fromId,
URI toId)
Deprecated. as of NW04. |
void |
IUriMapperService.renameMultipleIDs(RID fromId,
RID toId)
Rename mapping for the given RID and all descendants, e.g. id/*. |
boolean |
IUriMapperService.renameSingleID(URI fromId,
URI toId)
Deprecated. as of NW04. |
boolean |
IUriMapperService.renameSingleID(RID fromId,
RID toId)
Rename mapping for the given RID. |
| Uses of WcmException in com.sapportals.wcm.service.urlgenerator |
| Subclasses of WcmException in com.sapportals.wcm.service.urlgenerator | |
class |
AlreadyRegisteredException
Copyright (c) SAP AG |
| Methods in com.sapportals.wcm.service.urlgenerator that throw WcmException | |
IUriReference |
IURLGeneratorService.getRelativeUri(PathKey key)
Gets the relative URI of the path referred by key . |
IHierarchicalUri |
IURLGeneratorService.getAbsoluteUri(PathKey key)
Gets the absolute URI of the path referred by key . |
IHierarchicalUri |
IURLGeneratorService.getAlternativeAbsoluteUri(PathKey key)
Gets the absolute URI of the path referred by key . |
IHierarchicalUri |
IURLGeneratorService.createAbsoluteUri(IUriReference relativeUri)
Creates an absolute URI out of the specified relative URI (containing an absolute path) by prepending the configured protocol, server and port. |
IHierarchicalUri |
IURLGeneratorService.createAlternativeAbsoluteUri(IUriReference relativeUri)
Creates an absolute URI out of the specified relative URI (containing an absolute path) by prepending the configured (alternative) protocol, server and port. |
java.lang.String |
IURLGeneratorService.getNameOfConfigfile()
Returns the name of the XML file which is set as default in the CM configuration and used for the wdf-navigation. |
IUriReference |
IURLGeneratorService.getImageUri(java.lang.String filename)
Gets the relative URI of the image filename . |
IUriReference |
IURLGeneratorService.getBusinessCardUri(java.lang.String userId)
Deprecated. As of Netweaver '04 SP6, replaced by IURLGeneratorService.getBusinessCardUri(String, IResourceContext) |
IUriReference |
IURLGeneratorService.getBusinessCardUri(java.lang.String userId,
IResourceContext context)
Gets the relative URI for bringing up the business card of the user specified by userId . |
IUriReference |
IURLGeneratorService.getResourcePageUri(PathKey key,
RID resourceRID,
RID startRID)
Gets the relative URI for bringing up a page handling the resource specified by resourceRID . |
IUriReference |
IURLGeneratorService.getServicePageUri(java.util.List queryParameters)
Gets the relative URI for bringing up a service which may immediately carry out some instructions (e.g. delete a resource or display a dialog). |
IUriReference |
IURLGeneratorService.getUsermappingPageUri(java.lang.String systemId,
java.lang.String successUrl,
java.lang.String failureUrl,
java.lang.String cancelUrl)
Gets the relative URI of the usermapping maintenance servlet. |
RID |
IURLGeneratorService.getUserHomeRID(com.sapportals.portal.security.usermanagement.IUser user)
Gets the RID of the user's home folder. |
RID |
IURLGeneratorService.getUserFolderRID(com.sapportals.portal.security.usermanagement.IUser user,
java.lang.String folder)
Gets the RID of the specified subfolder of the user's home folder. |
IRidSet |
IURLGeneratorService.getPrincipalCollectionRidSet()
Gets a set of RIDs of all collections representing principals (user, groups, roles). |
RID |
IURLGeneratorService.getUserResourceRID(com.sapportals.portal.security.usermanagement.IUser user)
Gets the RID of a resource representing the specified user. |
RID |
IURLGeneratorService.getUserResourceRID(com.sapportals.portal.security.usermanagement.IUser user,
java.lang.String format)
Gets the RID of a resource in the specified format representing the specified user. |
RID |
IURLGeneratorService.getUserResourceRID(java.lang.String userId)
Gets the RID of a resource representing the specified user. |
RID |
IURLGeneratorService.getUserResourceRID(java.lang.String userId,
java.lang.String format)
Gets the RID of a resource in the specified format representing the specified user. |
RID |
IURLGeneratorService.getGroupResourceRID(com.sapportals.portal.security.usermanagement.IGroup group)
Gets the RID of a collection representing the specified group. |
RID |
IURLGeneratorService.getGroupResourceRID(java.lang.String groupId)
Gets the RID of a collection representing the specified group. |
RID |
IURLGeneratorService.getRoleResourceRID(com.sapportals.portal.security.usermanagement.IRole role)
Gets the RID of a collection representing the specified role. |
RID |
IURLGeneratorService.getRoleResourceRID(java.lang.String roleId)
Gets the RID of a collection representing the specified role. |
RID |
IURLGeneratorService.mapUri(IUri uri)
Gets the RID of the CM resource which represents the given URI (e.g. http resource). |
IUri |
IURLGeneratorService.mapRID(RID rid)
Gets the URI of the CM resource (e.g. http resource) represented by the given RID. |
RID |
IURLGenerator.getUserHomeRID(com.sapportals.portal.security.usermanagement.IUser user)
Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getUserHomeRID(IUser) |
RID |
IURLGenerator.getUserFolderRID(com.sapportals.portal.security.usermanagement.IUser user,
java.lang.String folder)
Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getUserFolderRID(IUser, String) |
RID |
IURLGenerator.getCompleteRIDToShowFolder(ICollection folder)
Deprecated. as of EP 5.0 SP2, replaced by IURLGenerator.createLinkToExplorerPageRID(RID) |
RID |
IURLGenerator.createServletCallRID(java.util.Properties properties)
Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getServicePageUri(java.util.List) |
java.lang.String |
IURLGenerator.getUsermappingServlet(java.lang.String systemId,
java.lang.String successUrl,
java.lang.String failureUrl,
java.lang.String cancelUrl)
Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getUsermappingPageUri(String, String, String,
String) |
RID |
IURLGenerator.createLinkToExplorerPageRID(RID resourceRID)
Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getResourcePageUri(PathKey, RID, RID) with parameter constant PathKey.EXPLORER_PAGE |
RID |
IURLGenerator.createLinkToExplorerPageRID(RID resourceRID,
RID startRID)
Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getResourcePageUri(PathKey, RID, RID) with parameter constant PathKey.EXPLORER_PAGE |
RID |
IURLGenerator.getUserResourceRID(com.sapportals.portal.security.usermanagement.IUser user)
Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getUserResourceRID(IUser) |
RID |
IURLGenerator.getUserResourceRID(com.sapportals.portal.security.usermanagement.IUser user,
java.lang.String format)
Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getUserResourceRID(IUser, String) |
RID |
IURLGenerator.getUserResourceRID(java.lang.String uid)
Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getUserResourceRID(String) |
RID |
IURLGenerator.getUserResourceRID(java.lang.String uid,
java.lang.String format)
Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getUserResourceRID(String, String) |
RID |
IURLGenerator.getGroupResourceRID(com.sapportals.portal.security.usermanagement.IGroup group)
Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getGroupResourceRID(IGroup) |
RID |
IURLGenerator.getGroupResourceRID(java.lang.String gid)
Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getGroupResourceRID(String) |
RID |
IURLGenerator.getRoleResourceRID(com.sapportals.portal.security.usermanagement.IRole role)
Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getRoleResourceRID(IRole) |
RID |
IURLGenerator.getRoleResourceRID(java.lang.String rid)
Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getRoleResourceRID(String) |
RID |
IURLGenerator.getBusinessCardAppRID(com.sapportals.portal.security.usermanagement.IUser user)
Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getBusinessCardUri(String) |
RID |
IURLGenerator.getBusinessCardAppRID(java.lang.String uid)
Deprecated. as of EP 5.0 SP5, replaced by IURLGeneratorService.getBusinessCardUri(String) |
URI |
IURLGenerator.getUserFolder(com.sapportals.portal.security.usermanagement.IUser user,
java.lang.String folder)
Deprecated. as of EP 5.0 SP2, replaced by IURLGenerator.getUserFolderRID(IUser,
String) |
URI |
IURLGenerator.getUserHome(com.sapportals.portal.security.usermanagement.IUser user)
Deprecated. as of EP 5.0 SP2, replaced by IURLGenerator.getUserHomeRID(IUser) |
URI |
IURLGenerator.getCompleteURIToShowFolder(ICollection folder)
Deprecated. as of EP 5.0 SP2, replaced by IURLGenerator.getCompleteRIDToShowFolder(ICollection) |
URI |
IURLGenerator.createServletCall(java.util.Properties properties)
Deprecated. as of EP 5.0 SP2, replaced by IURLGenerator.createServletCallRID(Properties) |
URI |
IURLGenerator.createLinkToExplorerPage(URI resourceURI)
Deprecated. as of EP 5.0 SP2, replaced by IURLGenerator.createLinkToExplorerPageRID(RID) |
URI |
IURLGenerator.getUserResource(com.sapportals.portal.security.usermanagement.IUser user)
Deprecated. as of EP 5.0 SP2, replaced by IURLGenerator.getUserResourceRID(IUser) |
URI |
IURLGenerator.getUserResource(com.sapportals.portal.security.usermanagement.IUser user,
java.lang.String format)
Deprecated. as of EP 5.0 SP2, replaced by IURLGenerator.getUserResourceRID(IUser,
String) |
URI |
IURLGenerator.getUserResource(java.lang.String uid)
Deprecated. as of EP 5.0 SP2, replaced by IURLGenerator.getUserResourceRID(String) |
URI |
IURLGenerator.getUserResource(java.lang.String uid,
java.lang.String format)
Deprecated. as of EP 5.0 SP2, replaced by IURLGenerator.getUserResourceRID(String, String) |
URI |
IURLGenerator.getGroupResource(com.sapportals.portal.security.usermanagement.IGroup group)
Deprecated. as of EP 5.0 SP2, replaced by IURLGenerator.getGroupResourceRID(IGroup) |
URI |
IURLGenerator.getGroupResource(java.lang.String gid)
Deprecated. as of EP 5.0 SP2, replaced by IURLGenerator.getGroupResourceRID(String) |
URI |
IURLGenerator.getRoleResource(com.sapportals.portal.security.usermanagement.IRole group)
Deprecated. as of EP 5.0 SP2, replaced by IURLGenerator.getRoleResourceRID(IRole) |
URI |
IURLGenerator.getRoleResource(java.lang.String rid)
Deprecated. as of EP 5.0 SP2, replaced by IURLGenerator.getRoleResourceRID(String) |
URI |
IURLGenerator.getBusinessCardApp(com.sapportals.portal.security.usermanagement.IUser user)
Deprecated. as of EP 5.0 SP2, replaced by IURLGenerator.getBusinessCardAppRID(IUser) |
URI |
IURLGenerator.getBusinessCardApp(java.lang.String uid)
Deprecated. as of EP 5.0 SP2, replaced by IURLGenerator.getBusinessCardAppRID(String) |
| Uses of WcmException in com.sapportals.wcm.service.xcrawler |
| Subclasses of WcmException in com.sapportals.wcm.service.xcrawler | |
class |
XCrawlerException
Exception which is thrown in case of crawler errors. |
| Uses of WcmException in com.sapportals.wcm.service.xmlforms |
| Subclasses of WcmException in com.sapportals.wcm.service.xmlforms | |
class |
XMLFormException
Exception handlerfor xml forms |
| Methods in com.sapportals.wcm.service.xmlforms that throw WcmException | |
java.lang.String |
IXMLFormsService.getFormTypeFromResource(IResource res)
Deprecated. Get from id from resource type |
java.util.HashMap |
IXMLFormsService.getFormTypes()
Deprecated. Get all defined form IDs from the xmlforms framework |
java.util.HashMap |
IXMLFormsService.getFormTypes(IResource collection)
Deprecated. Get defined form IDs from the xmlforms framework |
void |
IXMLFormsService.reloadAllFormTypes()
Deprecated. reload all defined form IDs from the xmlforms framework this can be used by the XL Forms Builder or a repository to update the IDs collection when new porjects have been created, or old projects have been deleted if a project name is supplied, reload is only done if the project is not already known |
void |
IXMLFormsService.reloadAllFormTypes(java.lang.String NewProject)
Deprecated. |
boolean |
IXMLFormsService.isApplicable(IResource res)
Deprecated. check if applicabel on resource |
| Uses of WcmException in com.sapportals.wcm.service.xmlforms.validation |
| Methods in com.sapportals.wcm.service.xmlforms.validation that throw WcmException | |
void |
IPropertyLocalizer.insertLocalizedPropsToDOM(org.w3c.dom.Document doc,
org.w3c.dom.Element insertNode,
java.lang.Object resProps,
IPropertyMap props,
java.util.HashMap ns2alias,
java.util.Properties updated,
java.util.Map requiredValues)
start the validation |
| Uses of WcmException in com.sapportals.wcm.util.acl |
| Subclasses of WcmException in com.sapportals.wcm.util.acl | |
class |
AclException
Superclass for all exceptions thrown by IAcl s, IAclEntry
s and IAclManager . |
class |
AclExistsException
An AclException that indicates that a specific IAcl
already exists. |
class |
AclLoadClassException
An AclException that indicates that a IAclManager
could not be loaded by the AclManagerFactory . |
class |
AclNotFoundException
An AclException that indicates that a specific IAcl
was not found. |
class |
AclPersistenceException
An AclException that indicates that an error occured during
access of the IAclManager 's persistence layer. |
class |
AlreadyAssignedToAclException
An AclException that indicates that a specific IAclEntry
is already assigned to an IAcl . |
class |
InvalidClassException
An AclException that indicates that the classname given for
IAclManager is invalid. |
class |
InvalidConfigException
An AclException that indicates that the config-id for a
IAclManager is not valid for within the AclManagerFactory
. |
class |
LastOwnerException
An AclException that indicates that a principal is the last
owner of an IAcl and can not be removed. |
class |
NoAclException
No longer used. |
class |
NotAuthenticatedException
An AclException that indicates that a principal is not
authenticated. |
class |
NotAuthorizedException
An AclException that indicates that a principal is not
authorized. |
class |
PermissionExistsException
An AclException that indicates that a specific
IAclPermission already exists. |
class |
PermissionNotSupportedException
An AclException that indicates that a specific
IAclPermission is not supported by the IAclManager . |
class |
PermissionUsedException
An AclException that indicates that a specific
IAclPermission is used and can not be removed. |
class |
PredefinedPermissionException
An AclException that indicates that a specific
IAclPermission is predefined by the IAclManager . |
| Constructors in com.sapportals.wcm.util.acl that throw WcmException | |
UMPrincipalRaw(int type,
java.lang.String id)
|
|
| Uses of WcmException in com.sapportals.wcm.util.cache |
| Subclasses of WcmException in com.sapportals.wcm.util.cache | |
class |
CacheException
Base class for exceptions in this cache package. |
| Uses of WcmException in com.sapportals.wcm.util.channels |
| Subclasses of WcmException in com.sapportals.wcm.util.channels | |
class |
PartialSendException
The PartialSendException indicates, that some recipients
couldn't be addressed. |
| Methods in com.sapportals.wcm.util.channels that throw WcmException | |
abstract java.lang.String |
AbstractChannel.getRecipientAddress(IRecipient recipient)
Get the address for the specified recipient. |
javax.mail.internet.MimeMessage |
AbstractChannel.getEmptyMessage()
Get an empty mime message for this channel. |
abstract void |
AbstractChannel.sendTo(java.lang.String address,
java.lang.String from,
java.lang.String title,
java.lang.String messagetext,
java.lang.String type)
Send a message via this channel to the given address. |
void |
AbstractChannel.sendTo(java.lang.String[] addresses,
java.lang.String from,
java.lang.String title,
java.lang.String messagetext,
java.lang.String type)
Send a message via this channel to the given addresses. |
void |
AbstractChannel.sendTo(java.lang.String[] addresses,
java.lang.String from,
java.lang.String title,
java.lang.String messagetext,
java.lang.String type,
java.lang.String encoding)
Send a message via this channel to the given addresses. |
abstract void |
AbstractChannel.sendTo(java.lang.String address,
java.lang.String from,
javax.mail.internet.MimeMessage mimemessage)
Send a mime message via this channel to the given recipient. |
void |
AbstractChannel.sendTo(java.lang.String[] addresses,
java.lang.String from,
javax.mail.internet.MimeMessage mimemessage)
Send a mime message via this channel. |
static ChannelFactory |
ChannelFactory.getInstance()
Get a new instance of the factory. |
IChannel |
ChannelFactory.getChannel(java.lang.String id)
Get an IChannel instance for a specific id. |
IChannelList |
ChannelFactory.getChannelForType(java.lang.String type)
Get a list of IChannel s for a given type. |
IChannel |
ChannelFactory.getFirstChannelForType(java.lang.String type)
Get the first instance of an IChannel for a given type. |
IChannelList |
ChannelFactory.getChannels()
Get a list with all available IChannel s. |
static java.lang.String[] |
ChannelFactory.getRecipientAdresses(IChannel channel,
IRecipientList recipients)
Utility method to convert an array of recipients to an array of addresses in a specific channel format. |
IChannelList |
ChannelFactory.createChannelList()
Create an empty IChannelList . |
IRecipientList |
IRecipientList.expand()
|
static RecipientFactory |
RecipientFactory.getInstance()
Get an instance of the RecipientFactory . |
IRecipient |
RecipientFactory.getRecipient(com.sapportals.portal.security.usermanagement.IUMPrincipal principal)
Get an IRecipient for the given user-management object. |
IRecipient |
RecipientFactory.getRecipient(java.lang.String id,
int type)
Get a IRecipient for the given id and type. |
IRecipientList |
RecipientFactory.createRecipientList()
Create an empty IRecipientList . |
java.util.Locale |
IRecipient.getLocale()
Get the recipient's locale. |
com.sapportals.portal.security.usermanagement.IUMPrincipal |
IRecipient.getUserManagementObject()
Get the associated user object ( IUser , IGroup or
IRole ). |
boolean |
IRecipient.isGroup()
Test if the recipient is a group and contains other recipients. |
IRecipientList |
IRecipient.getGroupMembers()
Get all the members of a group or role. |
boolean |
IRecipient.contains(IRecipient recipient)
Test if a given recipient is a member of a group. |
IChannel |
IRecipient.getChannel(java.lang.String id)
Get the recipient's channel for a given channel id. |
IChannelList |
IRecipient.getChannels()
Get all available channels. |
IChannel |
IRecipient.getDefaultChannel()
Get the default channel. |
void |
IRecipient.sendTo(IChannel channel,
java.lang.String from,
java.lang.String title,
java.lang.String messagetext,
java.lang.String type)
Send a message text via the specified channel. |
void |
IRecipient.sendTo(IChannel channel,
java.lang.String from,
javax.mail.internet.MimeMessage mimemessage)
Send a mime message via the specified channel. |
java.lang.String |
IChannel.getRecipientAddress(IRecipient recipient)
Get the given recipient's channel address in the channel's specific format. |
javax.mail.internet.MimeMessage |
IChannel.getEmptyMessage()
Get an empty internet mime message. |
void |
IChannel.sendTo(java.lang.String to,
java.lang.String from,
java.lang.String title,
java.lang.String messagetext,
java.lang.String type)
Send a message text via this channel to the given address. |
void |
IChannel.sendTo(java.lang.String to,
java.lang.String from,
java.lang.String title,
java.lang.String messagetext,
java.lang.String type,
java.lang.String encoding)
Send a message text via this channel to the given address. |
void |
IChannel.sendTo(java.lang.String[] to,
java.lang.String from,
java.lang.String title,
java.lang.String messagetext,
java.lang.String type)
Send a message text via this channel to the given addresses. |
void |
IChannel.sendTo(java.lang.String[] to,
java.lang.String from,
java.lang.String title,
java.lang.String messagetext,
java.lang.String type,
java.lang.String encoding)
Send a message text via this channel to the given addresses. |
void |
IChannel.sendTo(java.lang.String to,
java.lang.String from,
javax.mail.internet.MimeMessage mimemessage)
Send a mime message via this channel to the given address. |
void |
IChannel.sendTo(java.lang.String[] to,
java.lang.String from,
javax.mail.internet.MimeMessage mimemessage)
Send a mime message via this channel to the given addresses. |
| Constructors in com.sapportals.wcm.util.channels that throw WcmException | |
AbstractChannel(java.lang.String id,
java.util.Properties properties)
Create a channel with a specific id from the given properties. |
|
ChannelFactory(java.lang.String id)
Create a ChannelFactory with a given id. Note : This constructor has to be public (although it should be protected), to allow dynamic creation via the AbstractClassFactory()
. |
|
RecipientFactory(java.lang.String id)
Create a RecipientFactory with a given id.Note : This constructor has to be public (although it should be protected), to allow dynamic creation via AbstractClassFactory()
. |
|
| Uses of WcmException in com.sapportals.wcm.util.content |
| Subclasses of WcmException in com.sapportals.wcm.util.content | |
class |
ContentException
TBD: Description of the class. |
| Uses of WcmException in com.sapportals.wcm.util.controlstatus |
| Subclasses of WcmException in com.sapportals.wcm.util.controlstatus | |
class |
ControlStatusException
|
| Methods in com.sapportals.wcm.util.controlstatus that throw WcmException | |
StatusInformation |
IControlStatus.execute(IExecutable executable)
carries out the action described by the given parameter. |
StatusInformation |
IControlStatus.execute(java.lang.String execution)
different signature for this method. |
void |
PrincipalsField.addPrincipalToList(java.lang.String id,
int typeoflist)
|
void |
PrincipalsField.addPrincipalsToList(java.lang.String[] ids,
int typeoflist)
|
java.lang.String[] |
PrincipalsField.getNonUniqueIDs(int typeoflist)
|
| Uses of WcmException in com.sapportals.wcm.util.events |
| Methods in com.sapportals.wcm.util.events that throw WcmException | |
void |
IEventBroker.send(IEvent event,
IEventSender sender)
Sends the specified event to all receivers that have registered for this kind of event. |
void |
IEventBroker.register(IEventSender sender)
Registers an event sender instance. |
void |
IEventBroker.register(IEventReceiver receiver,
IEvent template)
Registers an event receiver. |
void |
IEventBroker.register(IEventReceiver receiver,
IEvent template,
IEventMapper mapping)
See the general contract of the IEventBroker.register(IEventReceiver, IEvent)
method. |
void |
IEventBroker.register(IEventReceiver receiver,
IEvent template,
int priority,
boolean async)
See the general contract of the IEventBroker.register(IEventReceiver, IEvent)
method. |
void |
IEventBroker.register(IEventReceiver receiver,
IEvent template,
IEventMapper mapping,
int priority,
boolean async)
See the general contract of the IEventBroker.register(IEventReceiver, IEvent)
method. |
void |
IEventBroker.unregister(IEventSender sender)
Unregisteres the event sender instance. |
void |
IEventBroker.unregister(IEventReceiver receiver,
IEvent template)
Unregisters an event receiver/template tuple. |
| Constructors in com.sapportals.wcm.util.events that throw WcmException | |
AbstractEventMapper(java.lang.String id,
java.util.Properties properties)
Create a mapper with a specific id from the given properties. |
|
| Uses of WcmException in com.sapportals.wcm.util.factories |
| Methods in com.sapportals.wcm.util.factories that throw WcmException | |
java.util.Collection |
AbstractObjectFactory.getAllObjectInstances()
Get a list with one instance for each available object class. |
protected java.lang.Object[] |
AbstractObjectFactory.getObjectConstructorParameters(java.lang.String id,
java.util.Properties properties)
Get the actual parameter for the object's constructor. |
protected java.lang.Object |
AbstractObjectFactory.getObjectInstance(java.lang.String id)
Create a new instance from the ObjectClassEntry for the given
id. |
protected java.util.HashMap |
AbstractObjectFactory.loadObjectMap(java.lang.String list,
java.lang.String listSeparator,
java.util.Properties properties)
Load the object classes into a map with pairs of id ,
ObjectEntry s. |
protected java.util.HashMap |
AbstractObjectFactory.loadObjectMap(com.sapportals.config.fwk.IConfigurable[] configurables)
|
protected static AbstractObjectFactory |
AbstractObjectFactory.getFactoryInstance(java.lang.String id,
java.lang.Class classObject,
int instanceType)
Get an initialized instance of a factory for the given id . |
static java.lang.Class |
ReflectionUtils.loadClass(java.lang.String logName,
java.lang.String className)
Deprecated. as of NW04. Use CrtClassLoaderRegistry
instead. |
static java.lang.reflect.Constructor |
ReflectionUtils.loadConstructor(java.lang.String logName,
java.lang.Class classObject,
java.lang.Class[] parameterTypes)
Get a classes' constructor. |
static java.lang.reflect.Method |
ReflectionUtils.loadMethod(java.lang.String logName,
java.lang.Class classObject,
java.lang.String methodName,
java.lang.Class[] parameterTypes)
Get a classes' method. |
static java.lang.Object |
ReflectionUtils.callMethod(java.lang.String logName,
java.lang.Object object,
java.lang.reflect.Method method,
java.lang.Object[] parameters)
Call an object's / classes' method. |
static java.lang.Object |
ReflectionUtils.callStaticMethod(java.lang.String logName,
java.lang.reflect.Method method,
java.lang.Object[] parameters)
Call a classes' static method. |
static java.lang.Object |
ReflectionUtils.newObject(java.lang.String logName,
java.lang.reflect.Constructor constructor,
java.lang.Object[] parameters)
Create a new object from a class. |
java.lang.Object |
AbstractObjectFactory.ObjectClassEntry.getObjectInstance()
get an instance of an object from this object class. |
| Constructors in com.sapportals.wcm.util.factories that throw WcmException | |
AbstractObjectFactory(java.lang.String id)
Create an AbstractObjectFactory for a given factory-id
. |
|
AbstractObjectFactory(java.lang.String logName,
java.lang.String id)
Create an AbstractObjectFactory for a given factory-id
. |
|
| Uses of WcmException in com.sapportals.wcm.util.html |
| Subclasses of WcmException in com.sapportals.wcm.util.html | |
class |
HTMLException
HTMLException is the base class for all exceptions in this package. |
| Methods in com.sapportals.wcm.util.html that throw WcmException | |
void |
HtmlTag.parse(java.lang.String token)
|
| Constructors in com.sapportals.wcm.util.html that throw WcmException | |
HtmlTag(java.lang.String token)
|
|
| Uses of WcmException in com.sapportals.wcm.util.http |
| Subclasses of WcmException in com.sapportals.wcm.util.http | |
class |
ConnectException
Signals connection problems. |
| Methods in com.sapportals.wcm.util.http that throw WcmException | |
boolean |
ICredentials.apply(IRequester requester,
java.lang.String uri,
IRequest request,
java.lang.String headerName)
Calculate the credentials for this HTTP Request |
boolean |
ICredentials.setup(IRequester requester,
java.lang.String header)
Set the credentials for this context depending on the header information (received from a 401 response). |
boolean |
ICredentials.setup(IRequester requester,
java.lang.String header,
boolean retry)
Set the credentials for this context depending on the header information (received from a 401 response). |
void |
ICredentials.got(IRequester requester,
IResponse response)
Process authenticate information in the response message, like Authenticate-Info. |
static byte[] |
Base64.decode(java.lang.String buffer)
Base64 decode the string in the buffer according to RFC 2045. |
static java.lang.String |
Base64.decodeString(java.lang.String buffer)
Base64 decode the string in the buffer according to RFC 2045. |
IRequester |
IRequesterFactory.getRequester(IContext context)
|
IResponse |
IRequester.perform(IRequest request)
Send a HTTP request to the remote server and deliver the response back to the caller. |
boolean |
IContext.applyCredentials(IRequester requester,
java.lang.String uri,
IRequest request)
Apply the credentials for a HTTP request. |
boolean |
IContext.setupCredentials(IRequester requester,
Headers header)
Set the credentials for this context depending on the header information (received from a 401 response). |
boolean |
IContext.setupProxyCredentials(IRequester requester,
Headers header)
Set the credentials for this context depending on the header information (received from a 407 response). |
void |
IContext.responseCredentials(IRequester requester,
IResponse response)
Give the context the possiblity to process authenticate information in the response message, like Authenticate-Info. |
static int |
HttpStatus.getCode(java.lang.String line)
Return code from a HTTP status line |
void |
HttpStatus.parse(java.lang.String line)
Reinitialize the WDStatus from the given line |
| Constructors in com.sapportals.wcm.util.http that throw WcmException | |
HttpStatus(java.lang.String statusLine)
Construct a new status from the given line |
|
| Uses of WcmException in com.sapportals.wcm.util.http.slim |
| Methods in com.sapportals.wcm.util.http.slim that throw WcmException | |
IRequester |
SlimRequesterFactory.getRequester(IContext context)
|
| Uses of WcmException in com.sapportals.wcm.util.systemconfig |
| Constructors in com.sapportals.wcm.util.systemconfig that throw WcmException | |
SystemPrincipal(java.lang.String principalId,
int principalType,
boolean isLockBreaker,
boolean hasServiceAcls,
java.util.Set mappedPermissions,
boolean canChangePermissions)
Construct a SystemPrincipal |
|
| Uses of WcmException in com.sapportals.wcm.util.uri |
| Methods in com.sapportals.wcm.util.uri that throw WcmException | |
RID |
RID.addPathSegment(java.lang.String segment)
Adds a path segment. |
| Uses of WcmException in com.sapportals.wcm.util.usermanagement |
| Methods in com.sapportals.wcm.util.usermanagement that throw WcmException | |
void |
SelectionUserManager.setList(java.lang.String[] ids,
int typeOfList)
fill a collection with ids, create display names |
void |
SelectionUserManager.setList(java.lang.String id,
int typeOfList)
fill a collection with id, create display name |
void |
SelectionUserManager.setList(java.lang.String id,
java.lang.String displayName,
int typeOfList)
fill a collection with id and displayName |
boolean |
SelectionUserManager.initWithString(java.lang.String persistentString)
|
boolean |
SelectionUserManager.addFromInput(java.lang.String userList,
boolean checkInput)
|
boolean |
SelectionUserManager.addEmailFromInput(java.lang.String userList)
Adds a feature to the EmailFromInput attribute of the SelectionUserManager object |
void |
SelectionUserManager.handleAll(java.lang.String userInput)
before calling this method, the SelectionUserManager needs to be initialized with the persistent string, via the method initWithString
. |
| Constructors in com.sapportals.wcm.util.usermanagement that throw WcmException | |
SelectionUser(java.lang.String id,
java.lang.String displayName,
int type)
|
|
SelectionUser(java.lang.String id,
int type)
|
|
|
SAP NetWeaver '04 | |||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||