com.sapportals.wcm.service.crawler
Interface ICrawlerProfile

[contained in: com.sap.km.cm.service.base.par - km.shared.service.crawler_api.jar] Deprecated. as of NW04. The crawler service was replaced by the xcrawler service com.sapportals.wcm.service.xcrawler

public interface ICrawlerProfile

A parameter-set for a ICrawler.

Copyright 2004 SAP AG

Method Summary

boolean	getCaseSensitiveFlag() Deprecated. Get the case sensitive flag.
long	getContentSizeLimit() Deprecated. Get the content size limit.
java.lang.String	getCrawlerType() Deprecated. Get the crawler type to use for the crawl.
int	getDepth() Deprecated. Get the maximum crawling depth to use for the crawl.
java.lang.String	getDescription(java.util.Locale locale) Deprecated. Get the profile's description.
int	getExternalLinkDepth() Deprecated. Get the maximum crawling depth for external links to use for the crawl.
int	getHierarchicalCrawlMode() Deprecated. Get the mode for a hierachical crawl.
java.lang.String	getID() Deprecated. Get the profile ID.
boolean	getIncludeVersionsFlag() Deprecated. Check if the flag to include versions of resources is set.
int	getInternalLinkDepth() Deprecated. Get the maximum crawling depth for internal links to use for the crawl.
int	getNiceness() Deprecated. Get the niceness factor to use for the crawl.
int	getPriority() Deprecated. Get the priority to use for the crawl.
IGenericQuery	getPropertyQuery() Deprecated. Get the query expression for searching the properties.
long	getTimeLimit() Deprecated. Get the time limit to use for the crawl.

Method Detail

getID

public java.lang.String getID()

Deprecated.

Get the profile ID.

Returns:

a String with the profile's unique ID.

getDescription

public java.lang.String getDescription(java.util.Locale locale)

Deprecated.

Get the profile's description.

Returns:

a String with the profile's description.

getCrawlerType

public java.lang.String getCrawlerType()
                                throws WcmException

Deprecated.

Get the crawler type to use for the crawl.

Returns:

a String with type of the crawler to use or null if the crawler service' default type should be used.

Throws:

WcmException - if the type cannot be retrieved.

getDepth

public int getDepth()
             throws WcmException

Deprecated.

Get the maximum crawling depth to use for the crawl.

Returns:

an int with the maximum depth to crawl.

Throws:

WcmException - if the depth cannot be retrieved.

getInternalLinkDepth

public int getInternalLinkDepth()
                         throws WcmException

Deprecated.

Get the maximum crawling depth for internal links to use for the crawl.

Returns:

an int with the maximum depth to crawl for internal links.

Throws:

WcmException - if the depth cannot be retrieved.

getExternalLinkDepth

public int getExternalLinkDepth()
                         throws WcmException

Deprecated.

Get the maximum crawling depth for external links to use for the crawl.

Returns:

an int with the maximum depth to crawl for external links.

Throws:

WcmException - if the depth cannot be retrieved.

getIncludeVersionsFlag

public boolean getIncludeVersionsFlag()
                               throws WcmException

Deprecated.

Check if the flag to include versions of resources is set.

Returns:

a boolean true if the flag is set and all versions should also be crawled, false if not.

Throws:

WcmException - if the flag cannot be retrieved.

getPropertyQuery

public IGenericQuery getPropertyQuery()
                               throws WcmException

Deprecated.

Get the query expression for searching the properties.

Returns:

a IGenericQuery with the query expression for the property search, null if not set.

Throws:

WcmException - if the query cannot be retrieved.

getHierarchicalCrawlMode

public int getHierarchicalCrawlMode()
                             throws WcmException

Deprecated.

Get the mode for a hierachical crawl.

Parameters:

an - int with the mode used for the crawl: HIERARCHICAL_OFF if crawling should follow the links from the HREF properties, HIERARCHICAL_ON to follow the hierarchical structure given by collections and resources, HIERARCHICAL_AUTO to use both mechanisms.

Throws:

WcmException - if the mode cannot be retrieved.

getNiceness

public int getNiceness()
                throws WcmException

Deprecated.

Get the niceness factor to use for the crawl.

Returns:

an int with the niceness factor to use.

Throws:

WcmException - if the niceness factor cannot be retrieved.

getPriority

public int getPriority()
                throws WcmException

Deprecated.

Get the priority to use for the crawl.

Returns:

an int with the priority to use.

Throws:

WcmException - if the priority cannot be retrieved.

getTimeLimit

public long getTimeLimit()
                  throws WcmException

Deprecated.

Get the time limit to use for the crawl.

Returns:

a long with the time limit for the crawl in msec.

Throws:

WcmException - if the time limit cannot be retrieved.

getCaseSensitiveFlag

public boolean getCaseSensitiveFlag()
                             throws WcmException

Deprecated.

Get the case sensitive flag.

Returns:

a boolean true if the crawler should be case sensitive, false if RIDs are not case sensitive.

Throws:

WcmException - if the case sensitive flag cannot be retrieved.

getContentSizeLimit

public long getContentSizeLimit()
                         throws WcmException

Deprecated.

Get the content size limit.

Returns:

a long with the content size limit in bytes.

Throws:

WcmException - if the content sizelimt cannot be retrieved.