Overview

Package

Class

Tree

Serialized

Deprecated

Index

Help

PREV class NEXT class

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.lotus.cs
Class DiscoveryServerService

java.lang.Object
  com.lotus.cs.DiscoveryServerService

All Implemented Interfaces:

CSBaseService

public class DiscoveryServerService

extends java.lang.Object

implements CSBaseService

DiscoveryServerService is used to retrieve data from a Discovery Server.

The DiscoveryServerService methods fall into the following categories:
- Search APIs
- APIs which return URLs for use in UI
- APIs which return core Discovery Server objects from a Discovery Server.

The following information presents examples of some common search queries for the Search APIs (that correspond to the options found in the K-map user interface):
- Searching for everything about a subject:
To search for "knowledge management", pass "knowledge management OR knowledge* AND management*" as the query to searchDocuments, searchPeople, searchCategories, and searchPlaces (if places are installed and configured with K-station).
- Searching for documents about a subject:
To search for "knowledge management", pass "knowledge management OR knowledge* AND management*" as the query to searchDocuments.
- Searching for documents authored by a specific person:
To search for "John Doe", pass "[$UpdatedBy] CONTAINS John Doe" as the query to searchDocuments.
- Searching for people by name:
To search for, "John Doe", pass "[fullname] CONTAINS John Doe" as the query to searchPeople.
- Searching for people who know about a specific subject:
To search for"knowledge management", pass "[AffinityPublishedLeaf] CONTAINS knowledge management OR knowledge* AND management*" as the query to searchPeople.
- Searching for people whose Profile contains a specific piece of information:
To search for "knowledge management", pass "knowledge management OR knowledge* AND management*" as the query to searchPeople.
- Searching Categories for specific information:
To search for "knowledge management", pass "knowledge management OR knowledge* AND management*" as the query to searchCategories.
- Searching Places for specific information (when installed and configured with K-station):
To search for "knowledge management", pass "knowledge management OR knowledge* AND management*" as the query to searchPlaces.- People related information (almost all methods use HTTP)

Method Summary
void	cleanup() Always call the cleanup() method when finished with the Service object.
java.util.HashMap[]	findDocuments(java.lang.String currentQuery, int start, int limit) Returns results from a specified document search.
java.util.HashMap[]	findPeople(java.lang.String currentQuery, int start, int limit) Returns results from a specified people search.
java.util.HashMap[]	findPlaces(java.lang.String currentQuery, int start, int limit) Returns results from a specified place search.
com.lotus.KDSAPI.KDSCursor	getCursor() Returns the specified Discovery Server object.
java.util.HashMap[]	getDocsCreatedByUser(java.lang.String userName, java.lang.String currentQuery, int start, int limit) Returns information about the set of documents created by the specified user.
java.lang.String	getDSControlCenterURL() Returns the URL to the Discovery Control Center UI.
com.lotus.KDSAPI.KDSFTSearch	getFTSearch() Returns the specified Discovery Server object.
static java.lang.String	getKMapURL_DS11(java.lang.String server) Returns the URL to the Discovery Server1.1 K-map UI.
java.lang.String	getKMapURL() Returns the URL to the Discovery Server K-map UI.
java.lang.String	getKMapURL(java.lang.String categoryId) Returns the URL to the Discovery Server K-map UI for the requested category.
com.lotus.KDSAPI.KDSMetrics	getMetrics() Returns the specified Discovery Server object.
static java.lang.String	getProfileURL_DS11(java.lang.String server, java.lang.String commonName) Returns the URL to the profile for a specified user in Discovery Server version 1.1 .
static java.lang.String	getProfileURL_DS20(java.lang.String server, java.lang.String commonName) Returns the URL to the profile for a specified user in Discovery Server version 2.0 .
java.lang.String	getProfileURL(java.lang.String fullName) Returns the URL to the profile for a specified user.
com.lotus.KDSAPI.KDSRepository	getRepository() Returns the specified Discovery Server object.
com.lotus.KDSAPI.KDSRepositoryInfo	getRepositoryInfo() Returns the specified Discovery Server object.
com.lotus.KDSAPI.KDSTaxEdit	getTaxEdit() Returns the specified Discovery Server object.
com.lotus.KDSAPI.KDSTaxonomyData	getTaxonomyData() Returns the specified Discovery Server object.
com.lotus.KDSAPI.KDSWorkQueueReader	getWorkQueueReader(java.lang.String queueName) Returns the specified Discovery Server object.
com.lotus.KDSAPI.KDSWorkQueueWriter	getWorkQueueWriter(java.lang.String queueName, com.lotus.KDSAPI.KDSWorkQueueAction action, int blocksize) Returns the specified Discovery Server object.
void	init(CSCredentials cred, java.lang.String server, java.lang.String protocol) Do not call the init() method.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

init

public void init(CSCredentials cred,
                 java.lang.String server,
                 java.lang.String protocol)

Do not call the init() method. init is called internally by CSFactory as part of the getService.

Specified by:

init in interface CSBaseService

See Also:

CSBaseService.init(com.lotus.cs.CSCredentials, java.lang.String, java.lang.String)

getCursor

public com.lotus.KDSAPI.KDSCursor getCursor()

Returns the specified Discovery Server object. import com.lotus.KDSAPI.* in order to use this method. Refer to the Discovery Server javadoc for full information about this object.

Returns:

the specified Discovery Server object.

getFTSearch

public com.lotus.KDSAPI.KDSFTSearch getFTSearch()

Returns the specified Discovery Server object. import com.lotus.KDSAPI.* in order to use this method. Refer to the Discovery Server javadoc for full information about this object.

Returns:

the specified Discovery Server object.

getMetrics

public com.lotus.KDSAPI.KDSMetrics getMetrics()

Returns the specified Discovery Server object. import com.lotus.KDSAPI.* in order to use this method. Refer to the Discovery Server javadoc for full information about this object. Note: This method is not supported with DS 1.1.x. It is supported with DS 2.0 (and kdsapi.jar, version 2.0).

Returns:

the specified Discovery Server object.

getRepository

public com.lotus.KDSAPI.KDSRepository getRepository()

Returns the specified Discovery Server object. import com.lotus.KDSAPI.* in order to use this method. Refer to the Discovery Server javadoc for full information about this object.

Returns:

the specified Discovery Server object.

getRepositoryInfo

public com.lotus.KDSAPI.KDSRepositoryInfo getRepositoryInfo()

Returns the specified Discovery Server object. import com.lotus.KDSAPI.* in order to use this method. Refer to the Discovery Server javadoc for full information about this object.

Returns:

the specified Discovery Server object.

getTaxEdit

public com.lotus.KDSAPI.KDSTaxEdit getTaxEdit()

Returns the specified Discovery Server object. import com.lotus.KDSAPI.* in order to use this method. Refer to the Discovery Server javadoc for full information about this object. Note: To use this method with DS 1.1.x, the requesting user must have "kmap editor OR admin" privileges.

Returns:

the specified Discovery Server object.

getTaxonomyData

public com.lotus.KDSAPI.KDSTaxonomyData getTaxonomyData()

Returns the specified Discovery Server object. import com.lotus.KDSAPI.Refer to the Discovery Server javadoc for full information about this object. Note: This method is available with DS 2.0 only.

Returns:

the specified Discovery Server object.

getWorkQueueReader

public com.lotus.KDSAPI.KDSWorkQueueReader getWorkQueueReader(java.lang.String queueName)

Returns the specified Discovery Server object. import com.lotus.KDSAPI.Refer to the Discovery Server javadoc for full information about this object. Note: This method is available with Discovery Server 2.0 only.

Parameters:

queueName - The name of the queue to create a Reader for.

Returns:

the specified Discovery Server object.

getWorkQueueWriter

public com.lotus.KDSAPI.KDSWorkQueueWriter getWorkQueueWriter(java.lang.String queueName,
                                                              com.lotus.KDSAPI.KDSWorkQueueAction action,
                                                              int blocksize)

Returns the specified Discovery Server object. import com.lotus.KDSAPI.Refer to the Discovery Server javadoc for full information about this object. Note: This method is available with Discovery Server 2.0 only.

Parameters:

queueName - Specifies the name of the queue to create a Writer for.

action - Specifies how to create the Writer (Open, Create, or Create and Truncate).

blocksize - Specifies the size of the file allocation unit in bytes. Usual values are 256 or 512.

Returns:

the specified Discovery Server object.

cleanup

public void cleanup()

Always call the cleanup() method when finished with the Service object.

Specified by:

cleanup in interface CSBaseService

See Also:

CSBaseService.cleanup()

getProfileURL

public java.lang.String getProfileURL(java.lang.String fullName)

Returns the URL to the profile for a specified user. Note: It is recommended that you use the fully-qualified name (the "fullName" property from the findPeople results).

Returns:

the URL to the profile for a specified user.

See Also:

findPeople(java.lang.String, int, int)

getKMapURL

public java.lang.String getKMapURL()

Returns the URL to the Discovery Server K-map UI.

Returns:

the URL to the Discovery Server K-map UI.

getKMapURL

public java.lang.String getKMapURL(java.lang.String categoryId)

Returns the URL to the Discovery Server K-map UI for the requested category. Note: This method is available with Discovery Server 2.0 only.

Parameters:

categoryId - String, A unique string identifying a category type stored inside Discovery Server. This string can get obtained using Discovery Server APIs, such as KDSCategoryInfo.getCategoryID(). For example, the Home category ID is "0000000012345678".

Returns:

the URL to the Discovery Server K-map UI.

getProfileURL_DS11

public static java.lang.String getProfileURL_DS11(java.lang.String server,
                                                  java.lang.String commonName)

Returns the URL to the profile for a specified user in Discovery Server version 1.1 . This an optimized version (with minimal error checking) for use with Discovery Server 1.1 only.

Parameters:

server - String, The fully qualified domain name of the Discovery Server version 1.1

commonName - String, common name of the user

Returns:

the URL to the profile for a specified user.

See Also:

getProfileURL(java.lang.String)

getProfileURL_DS20

public static java.lang.String getProfileURL_DS20(java.lang.String server,
                                                  java.lang.String commonName)

Returns the URL to the profile for a specified user in Discovery Server version 2.0 . This an optimized version (with minimal error checking) for use with Discovery Server 2.0 only.

Parameters:

server - String, The fully qualified domain name of the Discovery Server version 2.0

commonName - String, common name of the user

Returns:

the URL to the profile for a specified user.

See Also:

getProfileURL(java.lang.String)

getKMapURL_DS11

public static java.lang.String getKMapURL_DS11(java.lang.String server)

Returns the URL to the Discovery Server1.1 K-map UI. This an optimized version (with minimal error checking) for use with Discovery Server 1.1 only.

Returns:

the URL to the Discovery Server K-map UI.

See Also:

getKMapURL()

getDSControlCenterURL

public java.lang.String getDSControlCenterURL()

Returns the URL to the Discovery Control Center UI.

Returns:

the URL to the Discovery Control Center UI.

findPeople

public java.util.HashMap[] findPeople(java.lang.String currentQuery,
                                      int start,
                                      int limit)

Returns results from a specified people search.

Parameters:

currentQuery - String, contains query text to search on. Refer to the DiscoveryServerService class description for more details.

start - int, indicates location (index) where result set should begin. Start with 1.

limit - int, number of results to return

Returns:

HashMap array. Each element in the array contains a HashMap with the following information about each person who was found in the search: department (String), jobTitle (String), location (String), fullName (String), name (String), profile (String), summary (String), rank (Double).

See Also:

DiscoveryServerService

findPlaces

public java.util.HashMap[] findPlaces(java.lang.String currentQuery,
                                      int start,
                                      int limit)

Returns results from a specified place search.

Parameters:

currentQuery - String, contains query text to search on. Refer to the DiscoveryServerService class description for more details.

Returns:

HashMap array. Each element in the array contains a HashMap with the following information about each place which was found in the search: description (String), name (String), owner (String), ID (String), URL (String), rank (Double).

See Also:

DiscoveryServerService

findDocuments

public java.util.HashMap[] findDocuments(java.lang.String currentQuery,
                                         int start,
                                         int limit)

Returns results from a specified document search. Note (for DS 2.0): Make sure the limit is set sufficiently high, to get better search results.

Parameters:

currentQuery - String, contains query text to search on. Refer to the DiscoveryServerService class description for more details.

start - int, indicates location (index) where result set should begin. Start with 1.

limit - int, number of results to return

Returns:

HashMap array. Each element in the array contains a HashMap with the following information about each document which was found in the search: modifiedDate (String), createDate (String), author (String), title (String), docType (String), URL (String), ID (String), summary (String), rank (Double).

See Also:

DiscoveryServerService

getDocsCreatedByUser

public java.util.HashMap[] getDocsCreatedByUser(java.lang.String userName,
                                                java.lang.String currentQuery,
                                                int start,
                                                int limit)

Returns information about the set of documents created by the specified user. Note (for DS 2.0): Make sure the limit is set sufficiently high, to get better search results.

Parameters:

userName - String, name of the user

currentQuery - String, contains query text to search on. Refer to the DiscoveryServerService class description for more details.

start - int, indicates location (index) where result set should begin. Start with 1.

limit - int, number of results to return

Returns:

HashMap array. Each element in the array contains a HashMap with the following information about each document which was found in the search: createDate (String), title (String), URL (String), summary (String), rank (Double).

See Also:

DiscoveryServerService, findDocuments(java.lang.String, int, int)