IBM Information Integrator for Content V8.2 APIs

com.ibm.mm.sdk.common.infomining
Class DKIKFLibrary

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.infomining.DKIKFLibrary

public abstract class DKIKFLibrary
extends java.lang.Object

The library represents the information mining database and maintains a collection of catalogs.


Constructor Summary
protected DKIKFLibrary()
          Objects can be obtained from DKIKFService objects.
 
Method Summary
abstract  boolean catalogExists(java.lang.String name)
          Checks if there is a catalog with the specified name.
abstract  DKIKFCatalog getCatalog(java.lang.String name)
          Returns the catalog with the specified name.
abstract  java.lang.String[] getCatalogNames()
          Returns the names of all catalogs in the library.
abstract  DKIKFService getService()
          Returns the service object used by this library object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKIKFLibrary

protected DKIKFLibrary()
Objects can be obtained from DKIKFService objects.
Method Detail

getCatalogNames

public abstract java.lang.String[] getCatalogNames()
Returns the names of all catalogs in the library.
Returns:
the catalog names
Throws:
DKIKFAuthorizationException - if the user or group does not have the privilege IKFRetrieveCatalog
See Also:
catalogExists(String), getCatalog(String)

catalogExists

public abstract boolean catalogExists(java.lang.String name)
Checks if there is a catalog with the specified name.
Parameters:
name - a catalog name
Returns:
true if the catalog exists; false otherwise
Throws:
DKIKFAuthorizationException - if the user or group does not have the privilege IKFRetrieveCatalog
See Also:
getCatalogNames(), getCatalog(String)

getCatalog

public abstract DKIKFCatalog getCatalog(java.lang.String name)
                                 throws DKIKFNoSuchCatalogException
Returns the catalog with the specified name.
Parameters:
name - the name of the catalog to be returned
Returns:
the catalog
Throws:
DKIKFNoSuchCatalogException - if there is no catalog with the specified name
DKIKFAuthorizationException - if the user or group does not have the privilege IKFRetrieveCatalog
See Also:
catalogExists(String), getCatalogNames()

getService

public abstract DKIKFService getService()
Returns the service object used by this library object.
Returns:
the current service object

IBM Information Integrator for Content V8.2 APIs

© Copyright International Business Machines Corporation 1996, 2003 IBM Corp. All rights reserved.