Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKItemTypeRelationDefICM

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

public class DKItemTypeRelationDefICM
extends java.lang.Object

DKItemTypeRelationDefICM is used to represent an item type relations that can be assigned to item types which are of the "Document" class.


Field Summary
static short DK_ICM_VERSION_CONTROL_NERVER
           
 
Constructor Summary
DKItemTypeRelationDefICM()
          Constructs an item type relation object
DKItemTypeRelationDefICM(dkDatastore ds)
          Constructs an item type relation object and initializes it with the ICM datastore
DKItemTypeRelationDefICM(DKItemTypeRelationDefICM itRel)
          A copy constructor which makes a copy of the specified item type relation object.
 
Method Summary
 void add()
          Adds this current item type relation object to the persistent store.
 void del()
          Deletes this item type relation object from the persistent store
 dkDatastore getDatastore()
          Gets the datastore where this item type relation object would be persisted.
 int getDefaultACLCode()
          Retrieves the default ACL code assigned to the item resources assoicated with this item type relation.
 short getDefaultCollCode()
          Gets the default resource manager SMS collection where item resources assoicated with this item type relation are stored
 short getDefaultPrefetchCollCode()
          Gets the default prefetch resource manager SMS collection code where item resources associated with this item type relation are stored.
 short getDefaultRMCode()
          Retrieves the default resource manager where item assoicated with this item type relation are stored
 int getSourceItemTypeID()
          Gets the item type identifier to which this item type relation applies to.
 java.lang.String getSourceItemTypeName()
          Gets item type name to which this item type relation applies.
 int getTargetItemTypeID()
          Retrieves the target item type identifier The class of the target item type requires to be DK_ICM_ITEMTYPE_CLASS_DOC_PART
 java.lang.String getTargetItemTypeName()
          Gets the target item type name See the method setTargetItemTypeName for the detail information
 short getVersionControl()
          Gets the versioning policy for the item resource associated with this item type relations.
 void setDatastore(dkDatastore ds)
          Sets the datastore where this item type relation object would be persisted when this object is added.
 void setDefaultACLCode(int dfltACLCode)
          Sets the default ACL code assigned to the item resources assoicated with this item type relation.
 void setDefaultCollCode(short dfltCollCode)
          Sets the default resource manager SMS collection code where item resources associated with this item type relation are to be stored
 void setDefaultPrefetchCollCode(short dfltPrefetchCollCode)
          Sets the default prefetch resource manager SMS collection code where item resources assoicated with this item type relation are to be stored
 void setDefaultRMCode(short dfltRMCode)
          Sets default resource manager code to the specified code
 void setSourceItemTypeID(int srcItemTypeID)
          Sets the item type identifier to which this item type relation is being added.
 void setSourceItemTypeName(java.lang.String srcItemTypeName)
          Sets the source item type name to the item type name to which this item type relation is applied.
 void setTargetItemTypeName(java.lang.String tgtItemTypeName)
          Sets the target item type name to the specified name Name of the target item type can be ICMBASE, ICMBASETEXT, ICMBASESTREAM, ICMNOTELOG, ICMANNOTATION and the user defined item type with the class of DK_ICM_ITEMTYPE_CLASS_DOC_PART
 void setVersionControl(short versionControl)
          Sets the versioning policy for the item resources assoicated with this item type relations.
 void update()
          Updates this item type relation object in the persistent store
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DK_ICM_VERSION_CONTROL_NERVER

public static final short DK_ICM_VERSION_CONTROL_NERVER
Constructor Detail

DKItemTypeRelationDefICM

public DKItemTypeRelationDefICM()
Constructs an item type relation object

DKItemTypeRelationDefICM

public DKItemTypeRelationDefICM(dkDatastore ds)
                         throws DKException,
                                java.lang.Exception
Constructs an item type relation object and initializes it with the ICM datastore
Parameters:
ds - - A reference to a datastore object where the item type, whose item type relation this object represents, is defined.
Throws:
if - an error occurs

DKItemTypeRelationDefICM

public DKItemTypeRelationDefICM(DKItemTypeRelationDefICM itRel)
                         throws DKException,
                                java.lang.Exception
A copy constructor which makes a copy of the specified item type relation object.
Parameters:
itRel - - item type relation object to be used as a template for creating the new object
Method Detail

setDatastore

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

getDatastore

public dkDatastore getDatastore()
Gets the datastore where this item type relation object would be persisted.
Returns:
an ICM datastore

setSourceItemTypeID

public void setSourceItemTypeID(int srcItemTypeID)
Sets 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

getSourceItemTypeID

public int getSourceItemTypeID()
                        throws DKException,
                               java.lang.Exception
Gets the item type identifier to which this item type relation applies to.
Returns:
item type identifier of the item type to which this item type relation applies to.
Throws:
if - neither source item type identifier nor source item type name exists in the persistent store

getTargetItemTypeID

public int getTargetItemTypeID()
                        throws DKException,
                               java.lang.Exception
Retrieves the target item type identifier The class of the target item type requires to be DK_ICM_ITEMTYPE_CLASS_DOC_PART
Parameters:
tgtItemTypeID - the identifier of the target item type
Throws:
if - neither target item type identifier nor target item type name exists in the persistent store

setSourceItemTypeName

public void setSourceItemTypeName(java.lang.String srcItemTypeName)
Sets the source item type name to the item type name to which this item type relation is applied.
Parameters:
srcItemTypeName - item type name to which this item type relation is applied. This name can be up to 15 characters long.
See Also:
class DKAttrDefICM for the detail information

getSourceItemTypeName

public java.lang.String getSourceItemTypeName()
                                       throws DKException,
                                              java.lang.Exception
Gets item type name to which this item type relation applies.
Returns:
item type name
Throws:
if - neither source item type identifier nor source item type name exists in the persistent store

setTargetItemTypeName

public void setTargetItemTypeName(java.lang.String tgtItemTypeName)
Sets the target item type name to the specified name Name of the target item type can be ICMBASE, ICMBASETEXT, ICMBASESTREAM, ICMNOTELOG, ICMANNOTATION and the user defined item type with the class of DK_ICM_ITEMTYPE_CLASS_DOC_PART
Parameters:
tgtItemTypeName - target item type name

getTargetItemTypeName

public java.lang.String getTargetItemTypeName()
                                       throws DKException,
                                              java.lang.Exception
Gets the target item type name See the method setTargetItemTypeName for the detail information
Returns:
target item type name

getDefaultRMCode

public short getDefaultRMCode()
Retrieves the default resource manager where item assoicated 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.

setDefaultRMCode

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

getDefaultACLCode

public int getDefaultACLCode()
Retrieves the default ACL code assigned to the item resources assoicated with this item type relation.
Returns:
default ACL code assigned to the item resources assoicated with this item type relation.

setDefaultACLCode

public void setDefaultACLCode(int dfltACLCode)
Sets the default ACL code assigned to the item resources assoicated with this item type relation.
Parameters:
default - ACL code

getDefaultCollCode

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

setDefaultCollCode

public void setDefaultCollCode(short dfltCollCode)
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 SMS collection code where item resources assoicated with this item type relation are to be stored.

getDefaultPrefetchCollCode

public short 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 resource associated with this item type relation are stored

setDefaultPrefetchCollCode

public void setDefaultPrefetchCollCode(short dfltPrefetchCollCode)
Sets the default prefetch resource manager SMS collection code where item resources assoicated 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

getVersionControl

public short getVersionControl()
Gets the versioning policy for the item resource associated with this item type relations. The value returned is one of:
Returns:
version control

setVersionControl

public void setVersionControl(short versionControl)
Sets the versioning policy for the item resources assoicated with this item type relations. The valid values are
Parameters:
versionControl - - versioning policy

add

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

del

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

update

public void update()
            throws DKException,
                   java.lang.Exception
Updates this item type relation object in the persistent store
Throws:
if - an error occurs

EIP Java APIs

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