Index

DKXDOClassificationDefICM

Purpose:

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

Since: Version 8

Class summary:

class DKEXPORT DKXDOClassificationDefICM
{
 public:                
                                DKXDOClassificationDefICM(dkDatastore* ds);
                                DKXDOClassificationDefICM(const DKXDOClassificationDefICM& xdoObj);
    virtual                     ~DKXDOClassificationDefICM();
                void            add();
                void            del();
                void            update();
                dkDatastore*    getDatastore();
                void            setDatastore(dkDatastore* ds);
                long            getId();
                void            setId(long id);
                DKString        getName();
                void            setName(const char* name);
                DKString        getDescription();
                void            setDescription(const char* desc);
                DKString        getAttrGroupName();
                void            setAttrGroupName(const char* attrGroupName);
                DKString        getCppXdoClassName();
                void            setCppXdoClassName(const char* XdoClassName);
                void            addCompileOptionForSystemTypeOnFactory(short systemType, 
                short           compileOption, const char* cppFactory);
                void            removeCompileOptionForSystemType(short systemType, short compileOption);
                dkCollection*   listCompileOptionForSystemType();       
 };

Members:

Constructors and destructor
DKXDOClassificationDefICM(dkDatastore* ds)

Constructs the XDO Classification object and initializes with the datastore object where this object persists.

Parameters: ds - datastore object as an instance of Datastore ICM Copy Constructor

DKXDOClassificationDefICM(const DKXDOClassificationDefICM& xdoObj)

A copy constructor which makes a copy of XDO classification object.

Parameters: xdoObj- a XDO classification object Destructor

virtual ~DKXDOClassificationDefICM()

Destructor for this object.

add
Adds this XDO Classification object to the persistent datastore and local cache.

Throws: DKException- if an error occurs

void add();

del
Deletes this XDO classification object from the persistent store and local cache.

Throws: DKException- if an error occurs

void del();

update
Updates this XDO classification in the persistent store and local cache. Can not update the name and identifier.

Throws: DKException- if an error occurs

void update();

getDatastore
Gets the datastore where this XDO classification would be persisted.

Returns: the datastore object associated with the XDO classification object

dkDatastore* getDatastore();

setDatastore
Sets datastore object where this XDO classification would be persisted when this object is added.

Parameters: ds - the datastore object associated with this XDO classification object

void setDatastore(dkDatastore* ds);

getId
Gets the identifier of XDO Classification that is assigned by the ICM datastore.

Returns: identifier of this XDO Classification

long getId();

setId
Sets the XDO Classification code value.

Parameters: id - XDO Classification code to be assigned to this XDO Classification

 void setId(long id);

getName
Gets the name of this XDO Classification.

Returns: string name of the XDO Classification

DKString getName();

setName
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

void setName(const char* name);

getDescription
Gets the description of this XDOClassification.

Returns: description of the XDO Classification

DKString getDescription();

setDescription
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

void setDescription(const char* desc);

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: attribute group name of this XDO classification

DKString getAttrGroupName();

setAttrGroupName
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 detailed information

void setAttrGroupName(const char* attrGroupName);

getCppXdoClassName
Gets the CPP class that handles resources that are of this type of XDO Classification.

Returns: iCPP XDO class name of the XDO classification

DKString getCppXdoClassName();

setCppXdoClassName
Sets the CPP class that handles resources that are of this type of XDO Classification.

Parameters:XdoClassName - xdo class name to be set to this XDO classification The CPP xdo class name can be DKLobICM, DKTextICM, DKImageICM, DKStreamICM, DKViedoStreamICM

void setCppXdoClassName(const char* XdoClassName);

addCompileOptionForSystemTypeOnFactory
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
void            addCompileOptionForSystemTypeOnFactory(short systemType, short compileOption, const char* cppFactory);

removeCompileOptionForSystemType
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
void removeCompileOptionForSystemType(short systemType, short compileOption);

listCompileOptionForSystemType
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: dkCollection containing an array of 3 strings

  • String[0]: indicates the system type Window or AIX
  • String[1]:String[1] indicates the compile option Non-Debug or Debug
  • String[2]:indicates the CPP factory
dkCollection* listCompileOptionForSystemType();

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