Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKItemTypeDefICM

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.dkAbstractEntityDef
        |
        +--com.ibm.mm.sdk.common.DKComponentTypeDefICM
              |
              +--com.ibm.mm.sdk.common.DKItemTypeDefICM
All Implemented Interfaces:
dkEntityDef, DKMessageId, java.io.Serializable

public class DKItemTypeDefICM
extends DKComponentTypeDefICM
implements java.io.Serializable

DKItemTypeDefICM: This class is used to represent item type definition in Content Manager server. An item-type is the basic entity in Content Manager server. It has attributes, which can be regular attributes, group attributes, or reference attributes. If an item type represents a hierarchy, then the item type is a root component for the hierarchy with some child components defined under it. An item type may have a resource object stored in a resource manager. In this case, the item type need to have information related to resource object, such as, the resource manager information and the class to repesent the object. If an item type supports text search on its attributes or resource, then it will need to specify the text indexing information for enabling text search. An item type representing document model type has a set of item relation information defining document part items in this document. This class also has methods to define autolinking with another item type, to specify version control rules, to specify event logging on operations on this item type, and so forth. See related classes DKAttrDefICM, DKAttrGroupDefICM, DKComponentTypeDefICM, and DKItemTypeViewDefICM. Since: Version 8

See Also:
Serialized Form

Field Summary
static int DK_ICM_ALL_VIEW_NAMES
           
static short DK_ICM_ITEM_EVENT_CURD_DISABLED
           
static short DK_ICM_ITEM_RETRENTION_NO_EXPIRE
           
static short DK_ICM_ITEMACL_BIND_AT_ITEM
           
static short DK_ICM_ITEMACL_BIND_AT_ITEMTYPE
           
static short DK_ICM_RETENTION_UNIT_YEAR
           
static int DK_ICM_VIEW_NAMES_EXCEPT_BASE
           
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKItemTypeDefICM()
          Constructs an instance of item type definition class
DKItemTypeDefICM(dkDatastore ds)
          Constructs an instance of item type definition class for the given ICM datastore
DKItemTypeDefICM(DKItemTypeDefICM itemType)
          A copy constructor for the item-type definition object.
 
Method Summary
 void add(dkCollection relColl)
          Adds a collection of item type relations to the definition of this item type in the persistent store.
 void add(DKItemTypeRelationDefICM itRelationObj)
          Adds an item type relation to the definition of this item type in the persistent store
 void addAutoLinkRule(DKAutoLinkDefICM alDef)
          Adds an auto link rule to this item type
 void addAutoLinkRule(dkCollection autoLinkCollection)
          Adds a collection of auto link rules to this item type
 void addItemTypeRelation(DKItemTypeRelationDefICM aRel)
          Adds an item type relation to this entity item type.
 void addItemTypeView(DKItemTypeViewDefICM itViewObj)
          Adds a new definition of an item type view to this item type.
 java.lang.Object clone()
          Clone this item type definition object
 void del(dkCollection relColl)
          Deletes the given a collection of item type relations objects from the definition of this item type in the persistent store.
 void del(DKItemTypeRelationDefICM itRelationObj)
          Deletes an item type relation from the definition of this item type in the persistent store.
 void deleteAutoLinkRule(DKAutoLinkDefICM al)
          Deletes the definition of the auto link rule for this item type from the persistent store
 void deleteAutoLinkRule(dkCollection alColl)
          Deletes the collection of auto link rules for this item type from the persistent store
 boolean getAutoLinkEnable()
          Checks if autolink is enabled in this item type.
 short getAutoLinkSMS()
          Gets the SMS configuration rule used in autolink for this item type.
 short getClassification()
          Gets the classification for this item type The value of item type classification are: DK_ICM_ITEMTYPE_CLASS_ITEM :Indicates that this item type is a non-resource item type DK_ICM_ITEMTYPE_CLASS_RESOURCE_ITEM :Indicates that this item type is a resource item type DK_ICM_ITEMTYPE_CLASS_DOC_MODEL :Indicates that this item type is of type document model item type and may owns a set of parts DK_ICM_ITEMTYPE_CLASS_DOC_PART :Indicates that this item type is a document part item type, which may belong to a document model item type
 short getDefaultCollCode()
          Gets the default collection to store resource objects for this item type.
 int getDefaultItemRetention()
          Gets the default retention period for item instances under this item type.
 short getDefaultPrefchCollCode()
          Gets the default prefecth collection for storing resource objects for this item type.
 short getDefaultRetentionUnit()
          Gets the default unit of retention period for this item type.
 short getDefaultRMCode()
          Gets the default resource manager assigned to store resource objects for this item type.
 java.lang.String getDescription(java.lang.String langCode)
          Gets the item type description in the given langauge
 int getIntId()
          Gets the integer identifier of this item type.
 short getItemEventFlag()
          Gets the event flags setting for this item type.
 short getItemLevelACLFlag()
          Gets the flag which indicate the ACL binding level for this item type.
 int getItemTypeACLCode()
          Gets the ACL code for binding at this item type level.
 java.lang.String getItemTypeACLName()
          Gets the ACL name for binding at this item type level.
 java.lang.String getJavaXDOClassName()
          Gets the name of the Java class used to represent this item type in the object model.
 DKTextIndexDefICM getTextIndexDef()
          Gets the text search index properties of this item type.
 DKAttrDefICM getTextSearchAttr()
          Gets the text search attribute if specified.
 short getVersionControl()
          Gets the version control rules for this item type.
 short getVersionMax()
          Gets the maximum number of versions for each item instance under this item type.
 int getXDOClassID()
          Gets the XDO classification ID identifier used to represent this item type.
 java.lang.String getXDOClassName()
          Gets the name of the XDO class used to represent this item type in the object model.
 boolean isRoot()
          Checks if this object is a root component of an item type.
 boolean isTextSearchable()
          Checks if this item type is enabled for text search.
 dkCollection listItemTypeRelations()
          Lists all item type relations in this item type from the persistent store.
 java.lang.String[] listItemTypeViewNames()
          Lists the names of user-defined item type views from the persistent store
 java.lang.String[] listItemTypeViewNames(int option)
          Lists the names of item type views from the persistent store
 dkCollection listItemTypeViews()
          Lists item type views assoicated with this item type from the persistent store
 void removeItemTypeRelation(java.lang.String tgtEntityName)
          Removes an item type relation from this item type.
 void removeItemTypeView(java.lang.String itViewName)
          Removes a definition of the item type view from this item type.
 DKItemTypeRelationDefICM retrieveItemTypeRelation(int tgtItemTypeID)
          Retrieves item type relations having the given target item type identifier from the persistent store.
 dkCollection retrieveItemTypeRelations()
          Retrieves all item type relations in this item type.
 void setAutoLinkEnable(boolean autoLinkEnable)
          Sets the autolink property of this item type.
 void setAutoLinkSMS(short autoLinkSMS)
          Sets the SMS configuration rule used in autolink for this item type.
 void setClassification(short itemTypeClass)
          Sets the classification of this item type to the given value.
 void setDefaultCollCode(short dfltCollCode)
          Sets the default collection to store resource objects for this item type.
 void setDefaultItemRetention(int dfltItemRetension)
          Sets the default retention period for item instances under this item type.
 void setDefaultPrefchCollCode(short dfltPrefchCollCode)
          Sets the default prefecth collection for storing resource objects for this item type.
 void setDefaultRetentionUnit(short dfltRetentionUnit)
          Sets the default unit of retention period for this item type.
 void setDefaultRMCode(short dfltRMCode)
          Sets the default resource manager for this item type.
 void setDescription(java.lang.String desc, java.lang.String langCode)
          Sets the item type description for the given language
 void setIntId(int id)
          Sets the integer identifier for this item type
 void setItemEventFlag(short itemEventFlag)
          Sets the event flags to enable logging for operations on this item type.
 void setItemLevelACLFlag(short itemLevelACLFlag)
          Sets the flag to indicate the ACL binding level for this item type
 void setItemTypeACLCode(int itemTypeACLCode)
          Sets the ACL code for biniding at this item type level This ACL binding works as follows: At the item type level, this ACL is enforced so that all items in this item type are bound to this ACL At the item level, this code is used as the default ACL , if the default binding is configured at item type level
 void setItemTypeACLName(java.lang.String itemTypeACLName)
          Sets the ACL name for biniding at this item type level This ACL binding works as follows: At the item type level, this ACL is enforced so that all items in this item type are bound to this ACL At the item level, this name is used as the default ACL, if the default binding is configured at item type level
 void setJavaXDOClassName(java.lang.String javaXDOClassName)
          Sets the name of the Java XDO class used to represent this item type.
 void setTextIndexDef(DKTextIndexDefICM textIndexDef)
          Sets the text search index properties of this item type.
 void setTextSearchable(boolean isTextSearchable)
          Enables this item type for text search override setTextSearchable in class dkAbstractEntityDef
 void setVersionControl(short versionControl)
          Sets the version control rule applicable to this item type.
 void setVersionMax(short versionMax)
          Sets the maximum number of allowable versions for each item instances in this item type Zero means no limits.
 void setXDOClassID(int XDOClassID)
          Sets the XDO class identifier.
 void setXDOClassName(java.lang.String xdoClassName)
          Sets the name of the XDO class used to represent this item type in the object model.
 void update(dkCollection relColl)
          Updates the given a collection of item type relations in the definition of this item type in persistent store.
 void update(DKItemTypeRelationDefICM itRelationObj)
          Updates an item type relation in the definition of this item type in persistent store.
 void updateAutoLinkRule(DKAutoLinkDefICM al)
          Updates the auto link rule for this item type in the persistent store
 void updateAutoLinkRule(dkCollection alColl)
          Updates the collection of auto link rules in the persistent store
 void updateItemTypeRelation(DKItemTypeRelationDefICM itRel)
          Updates the item type relation in this item type.
 
Methods inherited from class com.ibm.mm.sdk.common.DKComponentTypeDefICM
add, addAttr, addAttrGroup, addForeignKey, addSubEntity, createAttr, createAttrGroup, createForeignKey, createSubEntity, del, getAttr, getAttrGroup, getCardinalityMax, getCardinalityMin, getComponentTypeId, getComponentTypeIndex, getComponentTypeName, getComponentViewId, getDeleteRule, getForeignKey, getId, getItemTypeId, getItemTypeName, getParent, getParentId, getSubEntity, isView, listAttrGroupNames, listAttrGroupNames, listAttrGroups, listAttrGroups, listAttrNames, listAttrNames, listAttrs, listAttrs, listComponentTypeIndexes, listComponentTypeIndexNames, listForeignKeyNames, listForeignKeys, listSubEntities, listSubEntities, listSubEntityNames, listSubEntityNames, removeAttr, removeAttrGroup, removeForeignKey, removeSubEntity, retrieveAttr, retrieveAttrGroup, retrieveComponentTypeIndex, retrieveForeignKey, retrieveParent, retrieveSubEntity, setCardinalityMax, setCardinalityMin, setComponentTypeName, setDeleteRule, setId, setItemTypeName, setParent, setParentId, update, updateAttr, updateAttrGroup, updateForeignKey, updateSubEntity
 
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractEntityDef
add, add, clearCache, datastoreName, datastoreType, del, del, deleteAttr, deleteSubEntity, getDatastore, getDescription, getName, getParentEntityName, getType, hasSubEntities, isSearchable, setDatastore, setDescription, setName, setParentEntityName, setType
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DK_ICM_ITEMACL_BIND_AT_ITEMTYPE

public static final short DK_ICM_ITEMACL_BIND_AT_ITEMTYPE

DK_ICM_ITEMACL_BIND_AT_ITEM

public static final short DK_ICM_ITEMACL_BIND_AT_ITEM

DK_ICM_RETENTION_UNIT_YEAR

public static final short DK_ICM_RETENTION_UNIT_YEAR

DK_ICM_ITEM_RETRENTION_NO_EXPIRE

public static final short DK_ICM_ITEM_RETRENTION_NO_EXPIRE

DK_ICM_ITEM_EVENT_CURD_DISABLED

public static final short DK_ICM_ITEM_EVENT_CURD_DISABLED

DK_ICM_ALL_VIEW_NAMES

public static final int DK_ICM_ALL_VIEW_NAMES

DK_ICM_VIEW_NAMES_EXCEPT_BASE

public static final int DK_ICM_VIEW_NAMES_EXCEPT_BASE
Constructor Detail

DKItemTypeDefICM

public DKItemTypeDefICM()
Constructs an instance of item type definition class

DKItemTypeDefICM

public DKItemTypeDefICM(dkDatastore ds)
Constructs an instance of item type definition class for the given ICM datastore
Parameters:
ds - the ICM datastore

DKItemTypeDefICM

public DKItemTypeDefICM(DKItemTypeDefICM itemType)
A copy constructor for the item-type definition object. The new instance of the item type definition will contain all the information copied from the original one.
Parameters:
itemType - an item type definition object, DKItemTypeDefICM
Method Detail

clone

public java.lang.Object clone()
Clone this item type definition object
Overrides:
clone in class DKComponentTypeDefICM
Returns:
an item type definition object, the clone of this object

isRoot

public boolean isRoot()
Checks if this object is a root component of an item type. Returns true if this object is a root component. Otherwise, returns false.
Overrides:
isRoot in class DKComponentTypeDefICM
Returns:
always returns true, since an item type is also a root component type

getIntId

public int getIntId()
Gets the integer identifier of this item type.
Overrides:
getIntId in class DKComponentTypeDefICM
Returns:
the item type identifier

setIntId

public void setIntId(int id)
Sets the integer identifier for this item type
Overrides:
setIntId in class DKComponentTypeDefICM
Parameters:
id - the item type identifier

getClassification

public short getClassification()
Gets the classification for this item type The value of item type classification are:
Returns:
the item type classification

setClassification

public void setClassification(short itemTypeClass)
Sets the classification of this item type to the given value. See the method getClassification() in this class for valid values of item type classification and their meaning.
Parameters:
itemTypeClass, - the item type classification
See Also:
getClassification()

getItemLevelACLFlag

public short getItemLevelACLFlag()
Gets the flag which indicate the ACL binding level for this item type. ACL bindings can be configured at
Returns:
the ACL binding level for this item type
See Also:
setItemlevelACLFlag(short)

setItemLevelACLFlag

public void setItemLevelACLFlag(short itemLevelACLFlag)
Sets the flag to indicate the ACL binding level for this item type
Parameters:
itemLevelACLFlag - the item type ACL binding level. Valid values are:
  • 0 - binding is at item level
  • 1 - binding item type ACL binding is at item type level

getItemTypeACLCode

public int getItemTypeACLCode()
                       throws DKException,
                              java.lang.Exception
Gets the ACL code for binding at this item type level. See the method setItemTypeACLCode(int) for more information.
Returns:
teh item type ACL code
See Also:
setItemTypeACLCode(int)

setItemTypeACLCode

public void setItemTypeACLCode(int itemTypeACLCode)
Sets the ACL code for biniding at this item type level This ACL binding works as follows: At the item type level, this ACL is enforced so that all items in this item type are bound to this ACL At the item level, this code is used as the default ACL , if the default binding is configured at item type level
Parameters:
itemTypeACLCode - - the item type ACL code
See Also:
getItemTypeACLCode()

getItemTypeACLName

public java.lang.String getItemTypeACLName()
                                    throws DKException,
                                           java.lang.Exception
Gets the ACL name for binding at this item type level. See the method setItemTypeACLName(String) for more information.
Returns:
teh item type ACL name
See Also:
setItemTypeACLName(String)

setItemTypeACLName

public void setItemTypeACLName(java.lang.String itemTypeACLName)
Sets the ACL name for biniding at this item type level This ACL binding works as follows: At the item type level, this ACL is enforced so that all items in this item type are bound to this ACL At the item level, this name is used as the default ACL, if the default binding is configured at item type level
Parameters:
itemTypeACLName - - the item type ACL name
See Also:
getItemTypeACLName()

getDefaultRMCode

public short getDefaultRMCode()
Gets the default resource manager assigned to store resource objects for this item type. This method is only applicable if this item type is a resource item or a part.
Returns:
the default resource manager code. Return 0, if this item typeis not a resource item type

setDefaultRMCode

public void setDefaultRMCode(short dfltRMCode)
Sets the default resource manager for this item type. This method is only applicable if this item type is a resource item or a part
Parameters:
dfltRMCode - default resource manager code

getDefaultCollCode

public short getDefaultCollCode()
Gets the default collection to store resource objects for this item type. This method is only applicable if this item type is a resource item or a document part.
Returns:
the default collection code
See Also:
setDefaultCollCode(short)

setDefaultCollCode

public void setDefaultCollCode(short dfltCollCode)
Sets the default collection to store resource objects for this item type.
Parameters:
DfltCollCode - the default collection code

getDefaultPrefchCollCode

public short getDefaultPrefchCollCode()
Gets the default prefecth collection for storing resource objects for this item type. A prefecth collection - usually defined in a fast disk - functions like a cache. That is, it is used to holds a copy of object stored in a slow device like optical drive or tape, so that once the object is loaded to this collection, the access would be much faster. Currently, this feature is only supported in OS/390 platform.
Returns:
the default prefetch collection code

setDefaultPrefchCollCode

public void setDefaultPrefchCollCode(short dfltPrefchCollCode)
Sets the default prefecth collection for storing resource objects for this item type. See the method getDefaultPrefetchCollCode() for more information. You need to define the prefetch collection using system administration commands.
Parameters:
default - prefetch collection code
See Also:
#getDefaultPrefecthCollCode()

getDefaultRetentionUnit

public short getDefaultRetentionUnit()
Gets the default unit of retention period for this item type. The unit is measured in:
Returns:
the default unit as described above

setDefaultRetentionUnit

public void setDefaultRetentionUnit(short dfltRetentionUnit)
Sets the default unit of retention period for this item type. See the method getDefaultRetentionUnit() for the valid value for the unit.
Parameters:
dfltRetentionUnit - the default unit of retention period.
See Also:
getDefaultRetentionUnit()

getDefaultItemRetention

public int getDefaultItemRetention()
Gets the default retention period for item instances under this item type. Number zero indicates that the item instances are never expired. Positive number greater than zero indicates the retention period for the item instances. The units (day, week, month, year) applicable to this number can be obtained by calling getDefaultRetentionUnit().
Returns:
the default retention period for item instances under this item type
See Also:
getDefaultRetentionUnit()

setDefaultItemRetention

public void setDefaultItemRetention(int dfltItemRetension)
Sets the default retention period for item instances under this item type. See the method getDefaultItemRetention() for more information.
Parameters:
dfltItemRetension - - the default retention period for item instances under this item type
See Also:
getDefaultItemRetention()

getXDOClassID

public int getXDOClassID()
Gets the XDO classification ID identifier used to represent this item type. This method is only applicable to item type resource item or document part, which is represented in the object model using a specific XDO subclass having this XDO class identifier.
Returns:
the XDO class identifier

setXDOClassID

public void setXDOClassID(int XDOClassID)
Sets the XDO class identifier. See the method getXDOClassID() for more information.
Parameters:
XDOClassID - - the XDO class identifier
See Also:
getXDOClassID()

getJavaXDOClassName

public java.lang.String getJavaXDOClassName()
Gets the name of the Java class used to represent this item type in the object model. See the method setJavaXDOClassName for more information.
Returns:
the name of Java class used to represent this item type, or an empty string
See Also:
getXDOClassID()

setJavaXDOClassName

public void setJavaXDOClassName(java.lang.String javaXDOClassName)
Sets the name of the Java XDO class used to represent this item type. This method is only applicable to items types resource item or document part.
Parameters:
javaXDOClassName - the name of the Java XDO class

getXDOClassName

public java.lang.String getXDOClassName()
Gets the name of the XDO class used to represent this item type in the object model. See method setXDOClassName() for more information.
Returns:
the XDO class name, or an empty string
See Also:
setJavaXDOClassName(java.lang.String)

setXDOClassName

public void setXDOClassName(java.lang.String xdoClassName)
Sets the name of the XDO class used to represent this item type in the object model. This name is used by non-Java program. This method is only applicable to items types resource item or document part.
Parameters:
xdoClassName - the XDO class name
See Also:
getXDOClassName(), setJavaXDOClassName(java.lang.String)

getAutoLinkEnable

public boolean getAutoLinkEnable()
Checks if autolink is enabled in this item type. Returns true if auto-linking or auto-foldering is enabled. Otherwise, returns false. When auto-foldering is enabled, each item added to this item type will also be automatically added to the specified folder, if the constraint is met.
Returns:
true or false

setAutoLinkEnable

public void setAutoLinkEnable(boolean autoLinkEnable)
Sets the autolink property of this item type.
Parameters:
autoLinkEnable - - true or false; true will enable autolink
See Also:
getAutoLinkEnable()

getAutoLinkSMS

public short getAutoLinkSMS()
Gets the SMS configuration rule used in autolink for this item type. The valid rules to configure SMS in auto-linking or auto-foldering are as follows. Assume that an item instance item-A is automatically added to folder-B by auto-foldering.
Returns:
the SMS rule for autolink
See Also:
setAutoLinkSMS(short)

setAutoLinkSMS

public void setAutoLinkSMS(short autoLinkSMS)
Sets the SMS configuration rule used in autolink for this item type. See the method getAutoLinkSMS() for information on the SMS configuration rules.
Parameters:
autoLinkSMS - - the autolink SMS rule as described in the method getAutoLinkSMS()
See Also:
getAutoLinkSMS()

getVersionControl

public short getVersionControl()
Gets the version control rules for this item type. There are three possible values:

setVersionControl

public void setVersionControl(short versionControl)
Sets the version control rule applicable to this item type. See the method getVersionControl() for valid values of version control rule.
Parameters:
VersionControl - - the version control rule as described in the method getVersionControl().
See Also:
getVersionControl()

getVersionMax

public short getVersionMax()
Gets the maximum number of versions for each item instance under this item type.
Returns:
the maximum number of versions allowed
See Also:
setVersionMax(short)

setVersionMax

public void setVersionMax(short versionMax)
Sets the maximum number of allowable versions for each item instances in this item type Zero means no limits. One is not valid if version rule is DK_ICM_VERSION_CONTROL_ALWAYS.
Parameters:
versionMax - the maximum number of versions allowed

getItemEventFlag

public short getItemEventFlag()
Gets the event flags setting for this item type. The flags indicate which CRUD (create, retrieve, update, delete) operations on instances of this item type are logged as events. The default is to disable logging. See setItemEventFlag(short) for information on the flag values.
Returns:
the item event flag setting
See Also:
setItemEventFlag(short)

setItemEventFlag

public void setItemEventFlag(short itemEventFlag)
Sets the event flags to enable logging for operations on this item type. The flags indicate which CRUD (create, retrieve, update, delete) operations on instances of this item type are logged as events. The default is to disable logging. Valid flag settings are:

isTextSearchable

public boolean isTextSearchable()
Checks if this item type is enabled for text search.
Overrides:
isTextSearchable in class dkAbstractEntityDef
Returns:
true, if this item type is enabled for text search

setTextSearchable

public void setTextSearchable(boolean isTextSearchable)
                       throws DKException,
                              java.lang.Exception
Enables this item type for text search override setTextSearchable in class dkAbstractEntityDef
Overrides:
setTextSearchable in class dkAbstractEntityDef
Parameters:
isTextSearchable - - true or false; true make this item type text-searchable

getTextIndexDef

public DKTextIndexDefICM getTextIndexDef()
Gets the text search index properties of this item type. Returns null, if it is defined
Returns:
attribute definition object DKAttrDefICM, or null

getTextSearchAttr

public DKAttrDefICM getTextSearchAttr()
Gets the text search attribute if specified. If not specified, null is returned.
Returns:
textIndexDef the text index definition.

setTextIndexDef

public void setTextIndexDef(DKTextIndexDefICM textIndexDef)
Sets the text search index properties of this item type. Setting to null will remove the text index, thus disable text search.
Parameters:
textIndexDef - the text search index definition.

addAutoLinkRule

public void addAutoLinkRule(DKAutoLinkDefICM alDef)
                     throws DKException,
                            java.lang.Exception
Adds an auto link rule to this item type
Parameters:
alDef - - the auto link rule object
See Also:
getAutoLinkEnable()

addAutoLinkRule

public void addAutoLinkRule(dkCollection autoLinkCollection)
                     throws DKException,
                            java.lang.Exception
Adds a collection of auto link rules to this item type
Parameters:
autoLinkCollection - - a collection of DKAutoLinkDefICM objects

addItemTypeView

public void addItemTypeView(DKItemTypeViewDefICM itViewObj)
                     throws DKException,
                            java.lang.Exception
Adds a new definition of an item type view to this item type. This is a in-memory operation only.
Parameters:
itViewObj - - the definition of an item type view object.
Throws:
if - an error occurs
See Also:
listItemTypeViews()

removeItemTypeView

public void removeItemTypeView(java.lang.String itViewName)
                        throws DKNotExistException,
                               DKException
Removes a definition of the item type view from this item type. This is in-memory operation only.
Parameters:
itViewName - - name of the item type view to be removed from this item type
Throws:
if - the item type view definition to be removed doesn't exist in the in-memory representation of this item type

listItemTypeViews

public dkCollection listItemTypeViews()
                               throws DKException,
                                      java.lang.Exception
Lists item type views assoicated with this item type from the persistent store
Returns:
a collection of item type view definition objects DKItemTypeViewDefICM belong to this item type
Throws:
if - an error occurs

listItemTypeViewNames

public java.lang.String[] listItemTypeViewNames()
                                         throws DKException,
                                                java.lang.Exception
Lists the names of user-defined item type views from the persistent store
Returns:
a string array of user-defined item type view names defined on this item type
Throws:
if - an error occurs

listItemTypeViewNames

public java.lang.String[] listItemTypeViewNames(int option)
                                         throws DKException,
                                                java.lang.Exception
Lists the names of item type views from the persistent store
Parameters:
option, - the valid option values are:
  • DK_ICM_ALL_VIEW_NAMES: Lists names of all item type views defined on this item type
  • DK_ICM_VIEW_NAMES_EXCEPT_BASE: Lists names of all item type views excluding base views defined on this item type
Returns:
an array of item type view names defined on this item type
Throws:
if - an error occurs

deleteAutoLinkRule

public void deleteAutoLinkRule(DKAutoLinkDefICM al)
                        throws DKException,
                               java.lang.Exception
Deletes the definition of the auto link rule for this item type from the persistent store
Parameters:
al - - the autolink rule definition object, DKAutoLinkDefICMRule, to be deleted
Throws:
if - an error occurs

deleteAutoLinkRule

public void deleteAutoLinkRule(dkCollection alColl)
                        throws DKException,
                               java.lang.Exception
Deletes the collection of auto link rules for this item type from the persistent store
Parameters:
alColl - - a collection of autolink rule objects, DKAutoLinkDefICM, to be deleted
Throws:
if - an error occurs

updateAutoLinkRule

public void updateAutoLinkRule(DKAutoLinkDefICM al)
                        throws DKException,
                               java.lang.Exception
Updates the auto link rule for this item type in the persistent store
Parameters:
al - - the autolink rule definition object, DKAutoLinkRule, to be updated
Throws:
if - an error occurs

updateAutoLinkRule

public void updateAutoLinkRule(dkCollection alColl)
                        throws DKException,
                               java.lang.Exception
Updates the collection of auto link rules in the persistent store
Parameters:
alColl - - a collection of autolink rule objects, DKAutoLinkDefICM, to be updated
Throws:
if - an error occurs

addItemTypeRelation

public void addItemTypeRelation(DKItemTypeRelationDefICM aRel)
                         throws DKAlreadyExistException,
                                DKException,
                                java.lang.Exception
Adds an item type relation to this entity item type. This is in-memory operation.
Parameters:
aRel - - the item type relation definition to be added

removeItemTypeRelation

public void removeItemTypeRelation(java.lang.String tgtEntityName)
                            throws DKNotExistException,
                                   DKException,
                                   java.lang.Exception
Removes an item type relation from this item type. This is in-memory operation.
Parameters:
tgtEntityName - - the item type relation name to be removed
Throws:
if - the item type relation definition to be removed doesn't exist in the in-memory representation of this item type

updateItemTypeRelation

public void updateItemTypeRelation(DKItemTypeRelationDefICM itRel)
                            throws DKException,
                                   java.lang.Exception
Updates the item type relation in this item type. This is in-memory operation.
Parameters:
itRel - - item type relation object to be updated
Throws:
if - the item type relation definition to be updated doesn't exist in the in-memory representation of this item type

listItemTypeRelations

public dkCollection listItemTypeRelations()
                                   throws DKException,
                                          java.lang.Exception
Lists all item type relations in this item type from the persistent store.
Returns:
a collection of item type relation definitions objects, DKItemTypeRelationDefICM
Throws:
if - an error occurs

retrieveItemTypeRelations

public dkCollection retrieveItemTypeRelations()
                                       throws DKException,
                                              java.lang.Exception
Retrieves all item type relations in this item type.
Returns:
a collection of item type relation objects for this item type
Throws:
if - an error occurs

retrieveItemTypeRelation

public DKItemTypeRelationDefICM retrieveItemTypeRelation(int tgtItemTypeID)
                                                  throws DKException,
                                                         java.lang.Exception
Retrieves item type relations having the given target item type identifier from the persistent store.
Parameters:
tgtItemTypeID - - the target item type identifier as a criteria for selecting the item type relations
Returns:
a collection of item type relation objects, DKItemTypeRelationDefICM
Throws:
if - an error occurs

add

public void add(DKItemTypeRelationDefICM itRelationObj)
         throws DKException,
                java.lang.Exception
Adds an item type relation to the definition of this item type in the persistent store
Parameters:
itRelationObj - - the item type relation object to be added.
Throws:
if - an error occurs

add

public void add(dkCollection relColl)
         throws DKException,
                java.lang.Exception
Adds a collection of item type relations to the definition of this item type in the persistent store.
Parameters:
relColl - the collection of the item type relation objects to be added.
Throws:
if - an error occurs

del

public void del(DKItemTypeRelationDefICM itRelationObj)
         throws DKException,
                java.lang.Exception
Deletes an item type relation from the definition of this item type in the persistent store.
Parameters:
itRelationObj - - the item type relation object to be deleted.
Throws:
if - an error occurs

del

public void del(dkCollection relColl)
         throws DKException,
                java.lang.Exception
Deletes the given a collection of item type relations objects from the definition of this item type in the persistent store.
Parameters:
relColl - - the collection of item type relation objects to be deleted.
Throws:
if - an error occurs

update

public void update(DKItemTypeRelationDefICM itRelationObj)
            throws DKException,
                   java.lang.Exception
Updates an item type relation in the definition of this item type in persistent store.
Parameters:
itRelationObj - the item type relation object to be updated.
Throws:
if - an error occurs

update

public void update(dkCollection relColl)
            throws DKException,
                   java.lang.Exception
Updates the given a collection of item type relations in the definition of this item type in persistent store.
Parameters:
relColl - the collection of the item type relation objects to be updated.
Throws:
if - an error occurs

getDescription

public java.lang.String getDescription(java.lang.String langCode)
                                throws DKException,
                                       java.lang.Exception
Gets the item type description in the given langauge
Overrides:
getDescription in class DKComponentTypeDefICM
Parameters:
langCode - the language code. e.g. ENU
Returns:
the item type description
Throws:
if - an error occurs

setDescription

public void setDescription(java.lang.String desc,
                           java.lang.String langCode)
                    throws DKException,
                           java.lang.Exception
Sets the item type description for the given language
Overrides:
setDescription in class DKComponentTypeDefICM
Parameters:
desc - item type description
langCode - the language code e.g. ENU

EIP Java APIs

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