|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.sdk.common.DKItemTypeRelationDefICM
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 |
public static final short DK_ICM_VERSION_CONTROL_NERVER
Constructor Detail |
public DKItemTypeRelationDefICM()
public DKItemTypeRelationDefICM(dkDatastore ds) throws DKException, java.lang.Exception
ds
- - A reference to a datastore object where the item type, whose item type
relation this object represents, is defined.if
- an error occurspublic DKItemTypeRelationDefICM(DKItemTypeRelationDefICM itRel) throws DKException, java.lang.Exception
itRel
- - item type relation object to be used as a template for creating the new objectMethod Detail |
public void setDatastore(dkDatastore ds)
ds
- - the ICM datastorepublic dkDatastore getDatastore()
public void setSourceItemTypeID(int srcItemTypeID)
srcItemTypeID
- item type identifier of the item type to which this item type
relation is addedpublic int getSourceItemTypeID() throws DKException, java.lang.Exception
if
- neither source item type identifier nor source item type name exists
in the persistent storepublic int getTargetItemTypeID() throws DKException, java.lang.Exception
tgtItemTypeID
- the identifier of the target item typeif
- neither target item type identifier nor target item type name exists
in the persistent storepublic void setSourceItemTypeName(java.lang.String srcItemTypeName)
srcItemTypeName
- item type name to which this item type relation is applied.
This name can be up to 15 characters long.class DKAttrDefICM for the
detail information
public java.lang.String getSourceItemTypeName() throws DKException, java.lang.Exception
if
- neither source item type identifier nor source item type name exists
in the persistent storepublic void setTargetItemTypeName(java.lang.String tgtItemTypeName)
tgtItemTypeName
- target item type namepublic java.lang.String getTargetItemTypeName() throws DKException, java.lang.Exception
public short getDefaultRMCode()
public void setDefaultRMCode(short dfltRMCode)
dfltRMCode
- resource manager code where the item resources associated
with this item type relation will be stored.public int getDefaultACLCode()
public void setDefaultACLCode(int dfltACLCode)
default
- ACL codepublic short getDefaultCollCode()
public void setDefaultCollCode(short dfltCollCode)
dfltCollCode
- default resource manager SMS collection code where item resources
assoicated with this item type relation are to be stored.public short getDefaultPrefetchCollCode()
public void setDefaultPrefetchCollCode(short dfltPrefetchCollCode)
dfltPrefetchCollCode
- - default prefetch resource manager SMS collection code
where item resources associated with this item type relation are to be storedpublic short getVersionControl()
public void setVersionControl(short versionControl)
versionControl
- - versioning policypublic void add() throws DKException, java.lang.Exception
if
- an error occurspublic void del() throws DKException, java.lang.Exception
if
- an error occurspublic void update() throws DKException, java.lang.Exception
if
- an error occurs
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |