Index

DKItemTypeRelationDefICM

Purpose:

Use this class to represent item type relations that can be assigned to item types which are of the "Document" class.

Since: Version 8

Class summary:

class DKEXPORT DKItemTypeRelationDefICM 
 {
 public:
     DKItemTypeRelationDefICM();
     DKItemTypeRelationDefICM(dkDatastore* ds);
     DKItemTypeRelationDefICM(const DKItemTypeRelationDefICM& itemTypeRel);
     virtual ~DKItemTypeRelationDefICM();
     virtual void add();
     virtual void del();
     virtual void update();
     void setDatastore(dkDatastore* ds);
     dkDatastore* getDatastore();
     void setSourceItemTypeID(long srcItemTypeID);
     long getSourceItemTypeID();
     void setTargetItemTypeID(long tgtItemTypeID);
     long getTargetItemTypeID();
     short getDefaultRMCode();
     void setDefaultRMCode(short dfltRMCode);
     long getDefaultACLCode();
     void setDefaultACLCode(long dfltACLCode);
     short getDefaultCollCode();
     void setDefaultCollCode(short dfltCollCode);
     short getDefaultPrefetchCollCode();
     void setDefaultPrefetchCollCode(short dfltPrefetchCollCode);
     short getVersionControl();
     void setVersionControl(short versionControl);
     void setSourceItemTypeName(const char* srcItemTypeName);
     DKString getSourceItemTypeName();
     void setTargetItemTypeName(const char* tgtItemTypeName);
     DKString getTargetItemTypeName();
 };

Members:

Constructors and destructor
DKItemTypeRelationDefICM();

Default constructor. Constructs an item type relation object.

DKItemTypeRelationDefICM(dkDatastore* ds);
 

Constructs an item type relation object and initializes it with the datastore. Parameters: ds - A reference to a datastore object where the item type, whose item type relation this object represents, is defined.

DKItemTypeRelationDefICM(const DKItemTypeRelationDefICM& itemTypeRel);
 

A copy constructor that makes a copy of the specified item type relation object. Parameters: itemTypeRel - an item type relation object.

virtual ~DKItemTypeRelationDefICM();

Destructor for this object.

Member functions

add
Adds this item type relation to the persistent store. Throws: DKException - if error occurs.
virtual void   add();

del
Deletes this item type relation from the persistant store. Throws: DKException - if error occurs.
virtual void    del();

update
Updates this item type relation in the persistant store. Throws: DKException - if error occurs.
virtual void    update();

setDatastore
Sets the datastore where this item type relation object would be persisted when this object is added. Parameters: ds - datastore
void setDatastore(dkDatastore* ds);

getDatastore
Gets the datastore where this item type relation object would be persisted. Returns: dkDatastore datastore.
dkDatastore*  getDatastore();

setSourceItemTypeID
The item type identifier to which this item type relation is being added. Parameters: srcItemTypeID - item type identifier of the item type to which this item type relation is added. Throws: DKException - if error occurs.
void setSourceItemTypeID(long srcItemTypeID);

getSourceItemTypeID
Gets the item type Identifier to which this item type relation applies. Returns: item type identifier of the item type to which this item type relation applies to.
long    getSourceItemTypeID();

setTargetItemTypeID
Sets the target item type identifier. Parameters: tgtItemTypeID Throws: DKException - if error occurs.
void setTargetItemTypeID(long tgtItemTypeID);

getTargetItemTypeID
Gets the target item type identifier. Returns: target item type identifier.
long  getTargetItemTypeID();

getDefaultRMCode
Gets the default resource manager where item resources associated with this item type relation are stored. Returns: default resource manager code where the item resources associated with this item type relation will be stored.
short           getDefaultRMCode();

setDefaultRMCode
Sets default resource manager code to the given code. Parameters: DfltRMCode - resource manager code where the item resources associated with this item type relation will be stored.
void setDefaultRMCode(short dfltRMCode);

getDefaultACLCode
Gets the default ACL code assigned to the where item resources associated with this item type relation. Returns: default ACL code assigned to the item resources associated with this item type relation.
long            getDefaultACLCode();

setDefaultACLCode
Sets the default ACL code assigned to the item resources associated with this item type relation. Parameters: dfltACLCode - default ACL code assigned to the item resources associated with this item type relation.
void setDefaultACLCode(long dfltACLCode);

getDefaultCollCode
Gets the default resource manager SMS collection where item resources associated with this item type relation are to be stored. Returns: default resource manager SMS collection code where the item resources associated with this item type relation are stored.
short           getDefaultCollCode();

setDefaultCollCode
Sets the default resource manager SMS collection code where item resources associated with this item type relation are to be stored. Parameters: DfltCollCode - default resource manager SMScollection code where item resources associated with this item type relation are to be stored.
void  setDefaultCollCode(short dfltCollCode);

getDefaultPrefetchCollCode
Gets the default prefetch resource manager SMS collection code where item resources associated with this item type relation are stored. Returns: the default prefetch resource manager SMS collection code where the item resources associated with this item type relation are stored.
short           getDefaultPrefetchCollCode();

setDefaultPrefetchCollCode
Sets the default prefetch resource manager SMS collection code where item resources associated with this item type relation are to be stored. Parameters: dfltPrefetchCollCode - default prefetch resource manager SMS collection code where item resources associated with this item type relation are to be stored
void setDefaultPrefetchCollCode(short dfltPrefetchCollCode);

getVersionControl
Gets the value versioning policy for the item resources associated with this item type relations. The value returned is one of:
  • DK_ICM_VERSION_CONTROL_NEVER: versioning is not supported under this item type.
  • DK_ICM_VERSION_CONTROL_ALWAYS: always create a new version.
  • DK_ICM_VERSION_CONTROL_BY_APPLICATION: application determines to create a new version or just perform replacement.

Returns: version control.

short  getVersionControl();

setVersionControl
Sets the versioning policy for the item resources associated with this item type relations. The valid values are:
  • DK_ICM_VERSION_CONTROL_NEVER: versioning is not supported under this item type.
  • DK_ICM_VERSION_CONTROL_ALWAYS: always create a new version.
  • DK_ICM_VERSION_CONTROL_BY_APPLICATION: application determines to create a new version or just perform replacement.

void  setVersionControl(short versionControl);

setSourceItemTypeName
Sets the source item type name to the item type name to which this item type relation is applied. Parameters: srcItemTypeName - source item type name to which this item type relation is applied. This name can be up to 15 characters long. Throws: DKException - if error occurs
void  setSourceItemTypeName(const char* srcItemTypeName);

getSourceItemTypeName
Gets source item type name to which this item type relation applies. Returns: source item type name
DKString getSourceItemTypeName();

setTargetItemTypeName
Sets the target item type name to a given name. Parameters: tgtItemTypeName - target item type name Throws: DKException - if error occurs
void setTargetItemTypeName(const char* tgtItemTypeName);

getTargetItemTypeName
Gets the target item type name. Returns: target item type name
DKString    getTargetItemTypeName();

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