Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKXDOClassificationDefICM

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

public class DKXDOClassificationDefICM
extends java.lang.Object

Use this class to represent a XDO classification and to manage the XDO classification in the ICM datastore.


Constructor Summary
DKXDOClassificationDefICM(dkDatastore ds)
          Constructs the XDO Classification object and initializes with the datastore object where this object persists.
 
Method Summary
 void add()
          Adds this XDO Classification object to the persistent store.
 void addCompileOptionForSystemTypeOnFactory(short systemType, short compileOption, java.lang.String cppFactory)
          Adds the C++ factory that would handle resources that are of this type of XDO classification.
 void del()
          Deletes this XDO classification object from the persistent store.
 java.lang.String getAttrGroupName()
          Gets the attribute group name of the XDO Classification See setName() in DKAttrGroupDefICM for the attribute group name definition The attribute group name can be RESOURCEBLOB, RESOURCETEXT, RESOURCEIMAGE, RESOURCEMEDIA and the user definied attribute group.
 dkDatastore getDatastore()
          Gets the datastore where this XDO classification would be persisted.
 java.lang.String getDescription()
          Gets the description of this XDO Classification
 int getId()
          Gets the identifier of XDO Classification that is assigned by the ICM datastore
 java.lang.String getJavaXdoClassName()
          Gets the java class that handles resources that are of this type of XDO Classification
 java.lang.String getName()
          Gets the name of this XDO classification
 dkCollection listCompileOptionForSystemType()
          Lists the C++ factory that would handle resources that are of this type of XDO classification.
 void removeCompileOptionForSystemType(short systemType, short compileOption)
          Removes the C++ factory that would handle resources that are of this type of XDO classification.
 void setAttrGroupName(java.lang.String attrGroupName)
          Sets the attribute group name for this XDO classification
 void setDatastore(dkDatastore ds)
          Sets datastore where this XDO classification would be persisted when this object is added.
 void setDescription(java.lang.String desc)
          Sets the description of this XDO Classification.
 void setJavaXdoClassName(java.lang.String javaXdoClassName)
          Sets the java class that handles resources that are of this type of XDO Classification
 void setName(java.lang.String name)
          Sets the name of this XDO Classification to the specified name.
 void update()
          Updates this XDO classification in the persistent store.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKXDOClassificationDefICM

public DKXDOClassificationDefICM(dkDatastore ds)
Constructs the XDO Classification object and initializes with the datastore object where this object persists.
Parameters:
ds - the ICM datastore
Method Detail

add

public void add()
         throws DKException,
                java.lang.Exception
Adds this XDO Classification object to the persistent store.
Throws:
if - an error occurs

del

public void del()
         throws DKException,
                java.lang.Exception
Deletes this XDO classification object from the persistent store.
Throws:
if - an error occurs

update

public void update()
            throws DKException,
                   java.lang.Exception
Updates this XDO classification in the persistent store. Can not update the name and identifier.
Throws:
if - an error occurs

getDatastore

public dkDatastore getDatastore()
Gets the datastore where this XDO classification would be persisted.
Returns:
the datastore object associated with the XDO classification object

setDatastore

public void setDatastore(dkDatastore ds)
Sets datastore where this XDO classification would be persisted when this object is added.
Parameters:
ds - the datastore object associated with this XDO classification object

getId

public int getId()
Gets the identifier of XDO Classification that is assigned by the ICM datastore
Returns:
identifier of this XDO Classification

getName

public java.lang.String getName()
Gets the name of this XDO classification
Returns:
string name of the XDO classification

setName

public void setName(java.lang.String name)
Sets the name of this XDO Classification to the specified name. The name can be up to 254 characters long
Parameters:
name - - name to be assigned to this XDO classification

getDescription

public java.lang.String getDescription()
Gets the description of this XDO Classification
Returns:
string description of the XDO Classification

setDescription

public void setDescription(java.lang.String desc)
Sets the description of this XDO Classification. The description can be up to 254 characters long.
Parameters:
desc - description to be set for this XDO classification

getAttrGroupName

public java.lang.String getAttrGroupName()
Gets the attribute group name of the XDO Classification See setName() in DKAttrGroupDefICM for the attribute group name definition The attribute group name can be RESOURCEBLOB, RESOURCETEXT, RESOURCEIMAGE, RESOURCEMEDIA and the user definied attribute group.
Returns:
string attribute group name of this XDO Classification

setAttrGroupName

public void setAttrGroupName(java.lang.String attrGroupName)
Sets the attribute group name for this XDO classification
Parameters:
attrGroupName - attribute group name to be set to this XDO classification
See Also:
in this class for detail information

getJavaXdoClassName

public java.lang.String getJavaXdoClassName()
Gets the java class that handles resources that are of this type of XDO Classification
Returns:
string java XDO class name of the XDO classification

setJavaXdoClassName

public void setJavaXdoClassName(java.lang.String javaXdoClassName)
Sets the java class that handles resources that are of this type of XDO Classification
Parameters:
javaXdoClassName - xdo class name to be set to this XDO classification The java xdo class name can be DKLobICM, DKTextICM, DKImageICM, DKStreamICM, DKViedoStreamICM.

addCompileOptionForSystemTypeOnFactory

public void addCompileOptionForSystemTypeOnFactory(short systemType,
                                                   short compileOption,
                                                   java.lang.String cppFactory)
                                            throws DKException
Adds the C++ factory that would handle resources that are of this type of XDO classification. Also set the compiler debug option as well as the operating system of the C++ factory.
Parameters:
systemType - - Operating system type to be set to this C++ factory either Window or AIX
compileOption - compile option for this C++ factory. either Non-Debug version or Debug
cppFactory - - the C++ factory that would handle resources.

removeCompileOptionForSystemType

public void removeCompileOptionForSystemType(short systemType,
                                             short compileOption)
                                      throws DKException
Removes the C++ factory that would handle resources that are of this type of XDO classification. Also set the compiler debug option as well as the operating system of the C++ factory.
Parameters:
systemType - - Operating system type to be set to this C++ factory either Window or AIX
compileOption - compile option for this C++ factory. either Non-Debug version or Debug

listCompileOptionForSystemType

public dkCollection listCompileOptionForSystemType()
                                            throws DKException,
                                                   java.lang.Exception
Lists the C++ factory that would handle resources that are of this type of XDO classification. Also set the compiler debug option as well as the operating system of the C++ factory.
Returns:
vector containing an array of 3 strings String[0] indicates the system type Window or AIX String[1] indicates the compile option Non-Debug or Debug String[2] indicates the CPP factory.

EIP Java APIs

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.