|
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.dkAbstractEntityDef | +--com.ibm.mm.sdk.common.DKComponentTypeDefICM | +--com.ibm.mm.sdk.common.DKItemTypeDefICM
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
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.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 |
public static final short DK_ICM_ITEMACL_BIND_AT_ITEMTYPE
public static final short DK_ICM_ITEMACL_BIND_AT_ITEM
public static final short DK_ICM_RETENTION_UNIT_YEAR
public static final short DK_ICM_ITEM_RETRENTION_NO_EXPIRE
public static final short DK_ICM_ITEM_EVENT_CURD_DISABLED
public static final int DK_ICM_ALL_VIEW_NAMES
public static final int DK_ICM_VIEW_NAMES_EXCEPT_BASE
Constructor Detail |
public DKItemTypeDefICM()
public DKItemTypeDefICM(dkDatastore ds)
ds
- the ICM datastorepublic DKItemTypeDefICM(DKItemTypeDefICM itemType)
itemType
- an item type definition object, DKItemTypeDefICMMethod Detail |
public java.lang.Object clone()
clone
in class DKComponentTypeDefICM
public boolean isRoot()
isRoot
in class DKComponentTypeDefICM
public int getIntId()
getIntId
in class DKComponentTypeDefICM
public void setIntId(int id)
setIntId
in class DKComponentTypeDefICM
id
- the item type identifierpublic short getClassification()
public void setClassification(short itemTypeClass)
itemTypeClass,
- the item type classificationgetClassification()
public short getItemLevelACLFlag()
setItemlevelACLFlag(short)
public void setItemLevelACLFlag(short itemLevelACLFlag)
itemLevelACLFlag
- the item type ACL binding level. Valid values are:
public int getItemTypeACLCode() throws DKException, java.lang.Exception
setItemTypeACLCode(int)
public void setItemTypeACLCode(int itemTypeACLCode)
itemTypeACLCode
- - the item type ACL codegetItemTypeACLCode()
public java.lang.String getItemTypeACLName() throws DKException, java.lang.Exception
setItemTypeACLName(String)
public void setItemTypeACLName(java.lang.String itemTypeACLName)
itemTypeACLName
- - the item type ACL namegetItemTypeACLName()
public short getDefaultRMCode()
public void setDefaultRMCode(short dfltRMCode)
dfltRMCode
- default resource manager codepublic short getDefaultCollCode()
setDefaultCollCode(short)
public void setDefaultCollCode(short dfltCollCode)
DfltCollCode
- the default collection codepublic short getDefaultPrefchCollCode()
public void setDefaultPrefchCollCode(short dfltPrefchCollCode)
default
- prefetch collection code#getDefaultPrefecthCollCode()
public short getDefaultRetentionUnit()
public void setDefaultRetentionUnit(short dfltRetentionUnit)
dfltRetentionUnit
- the default unit of retention period.getDefaultRetentionUnit()
public int getDefaultItemRetention()
getDefaultRetentionUnit()
public void setDefaultItemRetention(int dfltItemRetension)
dfltItemRetension
- - the default retention period for item instances
under this item typegetDefaultItemRetention()
public int getXDOClassID()
public void setXDOClassID(int XDOClassID)
XDOClassID
- - the XDO class identifiergetXDOClassID()
public java.lang.String getJavaXDOClassName()
getXDOClassID()
public void setJavaXDOClassName(java.lang.String javaXDOClassName)
javaXDOClassName
- the name of the Java XDO classpublic java.lang.String getXDOClassName()
setJavaXDOClassName(java.lang.String)
public void setXDOClassName(java.lang.String xdoClassName)
xdoClassName
- the XDO class namegetXDOClassName()
,
setJavaXDOClassName(java.lang.String)
public boolean getAutoLinkEnable()
public void setAutoLinkEnable(boolean autoLinkEnable)
autoLinkEnable
- - true or false; true will enable autolinkgetAutoLinkEnable()
public short getAutoLinkSMS()
setAutoLinkSMS(short)
public void setAutoLinkSMS(short autoLinkSMS)
autoLinkSMS
- - the autolink SMS rule as described in the method getAutoLinkSMS()getAutoLinkSMS()
public short getVersionControl()
setVersionControl(short)
public void setVersionControl(short versionControl)
VersionControl
- - the version control rule as described in the method getVersionControl().getVersionControl()
public short getVersionMax()
setVersionMax(short)
public void setVersionMax(short versionMax)
versionMax
- the maximum number of versions allowedpublic short getItemEventFlag()
setItemEventFlag(short)
public void setItemEventFlag(short itemEventFlag)
itemEventFlag
- - the flag setting as described abovepublic boolean isTextSearchable()
isTextSearchable
in class dkAbstractEntityDef
public void setTextSearchable(boolean isTextSearchable) throws DKException, java.lang.Exception
setTextSearchable
in class dkAbstractEntityDef
isTextSearchable
- - true or false; true make this item type text-searchablepublic DKTextIndexDefICM getTextIndexDef()
public DKAttrDefICM getTextSearchAttr()
public void setTextIndexDef(DKTextIndexDefICM textIndexDef)
textIndexDef
- the text search index definition.public void addAutoLinkRule(DKAutoLinkDefICM alDef) throws DKException, java.lang.Exception
alDef
- - the auto link rule objectgetAutoLinkEnable()
public void addAutoLinkRule(dkCollection autoLinkCollection) throws DKException, java.lang.Exception
autoLinkCollection
- - a collection of DKAutoLinkDefICM objectspublic void addItemTypeView(DKItemTypeViewDefICM itViewObj) throws DKException, java.lang.Exception
itViewObj
- - the definition of an item type view object.if
- an error occurslistItemTypeViews()
public void removeItemTypeView(java.lang.String itViewName) throws DKNotExistException, DKException
itViewName
- - name of the item type view to be removed from this item typeif
- the item type view definition to be removed doesn't exist
in the in-memory representation of this item typepublic dkCollection listItemTypeViews() throws DKException, java.lang.Exception
if
- an error occurspublic java.lang.String[] listItemTypeViewNames() throws DKException, java.lang.Exception
if
- an error occurspublic java.lang.String[] listItemTypeViewNames(int option) throws DKException, java.lang.Exception
option,
- the valid option values are:
if
- an error occurspublic void deleteAutoLinkRule(DKAutoLinkDefICM al) throws DKException, java.lang.Exception
al
- - the autolink rule definition object, DKAutoLinkDefICMRule, to be deletedif
- an error occurspublic void deleteAutoLinkRule(dkCollection alColl) throws DKException, java.lang.Exception
alColl
- - a collection of autolink rule objects, DKAutoLinkDefICM, to be deletedif
- an error occurspublic void updateAutoLinkRule(DKAutoLinkDefICM al) throws DKException, java.lang.Exception
al
- - the autolink rule definition object, DKAutoLinkRule, to be updatedif
- an error occurspublic void updateAutoLinkRule(dkCollection alColl) throws DKException, java.lang.Exception
alColl
- - a collection of autolink rule objects, DKAutoLinkDefICM,
to be updatedif
- an error occurspublic void addItemTypeRelation(DKItemTypeRelationDefICM aRel) throws DKAlreadyExistException, DKException, java.lang.Exception
aRel
- - the item type relation definition to be addedpublic void removeItemTypeRelation(java.lang.String tgtEntityName) throws DKNotExistException, DKException, java.lang.Exception
tgtEntityName
- - the item type relation name to be removedif
- the item type relation definition to be removed doesn't exist
in the in-memory representation of this item typepublic void updateItemTypeRelation(DKItemTypeRelationDefICM itRel) throws DKException, java.lang.Exception
itRel
- - item type relation object to be updatedif
- the item type relation definition to be updated doesn't exist
in the in-memory representation of this item typepublic dkCollection listItemTypeRelations() throws DKException, java.lang.Exception
if
- an error occurspublic dkCollection retrieveItemTypeRelations() throws DKException, java.lang.Exception
if
- an error occurspublic DKItemTypeRelationDefICM retrieveItemTypeRelation(int tgtItemTypeID) throws DKException, java.lang.Exception
tgtItemTypeID
- - the target item type identifier as a criteria
for selecting the item type relationsif
- an error occurspublic void add(DKItemTypeRelationDefICM itRelationObj) throws DKException, java.lang.Exception
itRelationObj
- - the item type relation object to be added.if
- an error occurspublic void add(dkCollection relColl) throws DKException, java.lang.Exception
relColl
- the collection of the item type relation objects to be added.if
- an error occurspublic void del(DKItemTypeRelationDefICM itRelationObj) throws DKException, java.lang.Exception
itRelationObj
- - the item type relation object to be deleted.if
- an error occurspublic void del(dkCollection relColl) throws DKException, java.lang.Exception
relColl
- - the collection of item type relation objects to be deleted.if
- an error occurspublic void update(DKItemTypeRelationDefICM itRelationObj) throws DKException, java.lang.Exception
itRelationObj
- the item type relation object to be updated.if
- an error occurspublic void update(dkCollection relColl) throws DKException, java.lang.Exception
relColl
- the collection of the item type relation objects to be updated.if
- an error occurspublic java.lang.String getDescription(java.lang.String langCode) throws DKException, java.lang.Exception
getDescription
in class DKComponentTypeDefICM
langCode
- the language code. e.g. ENUif
- an error occurspublic void setDescription(java.lang.String desc, java.lang.String langCode) throws DKException, java.lang.Exception
setDescription
in class DKComponentTypeDefICM
desc
- item type descriptionlangCode
- the language code e.g. ENU
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |