|
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.DKComponentTypeViewDefICM | +--com.ibm.mm.sdk.common.DKItemTypeViewDefICM
This class is used to represent item type view definition in Content Manager server. An item type view defines a visible subset of attributes and child components of the base item type. This concept is similar to a relational database view, except that the base item type where the view is defined may have a hierarchy of a root and child components. Therefore the view would be a subtree of the base item type hierarchy. See also related classes DKAttrDefICM, DKAttrGroupDefICM, DKComponentTypeDefICM, and DKItemTypeDefICM. Since: Version 8
Fields inherited from interface com.ibm.mm.sdk.common.DKConstantICM |
For details, see the class or interface |
Fields inherited from interface com.ibm.mm.sdk.common.DKConstant |
For details, see the class or interface |
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageIdICM |
For details, see the class or interface |
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId |
For details, see the class or interface |
Constructor Summary | |
DKItemTypeViewDefICM()
Constructs an instance of item type view definition class |
|
DKItemTypeViewDefICM(dkDatastore ds)
Constructs an instance of item type view definition class for a given ICM datastore |
|
DKItemTypeViewDefICM(DKItemTypeViewDefICM itemTypeView)
A copy constructor for the item type view definition object. |
Method Summary | |
java.lang.Object |
clone()
Clones this item type view definition object |
int |
getAclCode()
Gets the access control list code associated with this item type view |
java.lang.String |
getAclName()
Gets the access control list name associated with this view |
short |
getClassification()
Gets the classification of this tem type view The valide values for item type view classification are: DK_ICM_ITEMTYPE_CLASS_ITEM: Indicates that this item type view is a non-resource item type view DK_ICM_ITEMTYPE_CLASS_RESOURCE_ITEM: Indicates that this item type view is a resource item type view DK_ICM_ITEMTYPE_CLASS_DOC_MODEL: Indicates this item type view is a document model item type or view, and may own a set of parts DK_ICM_ITEMTYPE_CLASS_DOC_PART: Indicates that this item type view is a document part item type view, which may belong to a document model item type view |
short |
getDefaultCollCode()
Gets the default collection to store resource object for this item type. |
short |
getDefaultRMCode()
Gets the default resource manager assigned to store resource objects for this item type view. |
int |
getIntId()
Gets the integer identifier of this item type view |
java.lang.String |
getJavaXDOClassName()
Gets the name of the Java XDO class used to represent this item type view in the object model. |
DKTextIndexDefICM |
getTextIndexDef()
Gets the text search index properties of this item type view. |
short |
getVersionControl()
Gets the version control rules for this item type view. |
short |
getVersionMax()
Gets the maximum number of versions for each item instance under this item type view |
int |
getXDOClassID()
Gets the XDO class identifier used to represent this item type view. |
java.lang.String |
getXDOClassName()
Gets the name of the XDO class used to represent this item type view in the object model. |
boolean |
isRoot()
Checks if this object is a root component. |
boolean |
isTextSearchable()
Checks if this item type view is enabled for text search. |
void |
setAclCode(int aclCode)
Sets the access control list code for this item type view |
void |
setAclName(java.lang.String aclName)
Sets the access control list name for this item type view |
void |
setClassification(short itemTypeClass)
Sets the classification of this item type view to the given value. |
void |
setDefaultCollCode(short dfltCollCode)
Sets the default collection to store resource objects for this item type. |
void |
setDefaultRMCode(short dfltRMCode)
Sets the default resource manager for this item type view. |
void |
setIntId(int id)
Sets the identifier for this item type view |
void |
setJavaXDOClassName(java.lang.String javaXDOClassName)
Sets the name of the Java XDO class used to represent this item type view. |
void |
setTextIndexDef(DKTextIndexDefICM textIndexDef)
Sets the text search index properties of this item type view. |
void |
setTextSearchable(boolean isTextSearchable)
Enables this item type view for text search. |
void |
setVersionControl(short versionControl)
Sets the version control rule applicable to this item type view. |
void |
setVersionMax(short versionMax)
Sets the maximum number of versions for each item instance in this item type view. |
void |
setXDOClassID(int XDOClassID)
Sets the XDO class identifier See the method getXDOClassID() for more information |
void |
setXDOClassName(java.lang.String xdoClassName)
Sets the name of the XDO class used to represent this item type view in the object model. |
Methods inherited from class com.ibm.mm.sdk.common.DKComponentTypeViewDefICM |
add, createSubEntity, del, getAccessModuleResult, getAccessModuleStatus, getAccessModuleVers, getComponentViewId, getCreatedTimestamp, getItemTypeViewId, getPrevAccessModule, hasSubEntityViews, update |
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 |
Constructor Detail |
public DKItemTypeViewDefICM()
public DKItemTypeViewDefICM(dkDatastore ds)
ds
- ICM datastorepublic DKItemTypeViewDefICM(DKItemTypeViewDefICM itemTypeView)
itemTypeView
- an item type view definition objectMethod Detail |
public java.lang.Object clone()
clone
in class DKComponentTypeViewDefICM
public int getIntId()
getIntId
in class DKComponentTypeViewDefICM
public void setIntId(int id)
setIntId
in class DKComponentTypeViewDefICM
id
- - the identifier to be assigned to this item type viewpublic int getAclCode()
public void setAclCode(int aclCode)
aclCode
- - the ACL codegetAclCode()
public java.lang.String getAclName() throws DKException, java.lang.Exception
if
- an error occurspublic void setAclName(java.lang.String aclName)
aclName
- - the ACL name#getACLName()
public boolean isRoot()
isRoot
in class DKComponentTypeDefICM
public short getClassification()
public void setClassification(short itemTypeClass)
itemTypeClass
- - the item type classificationgetClassification()
public short getDefaultCollCode()
getDefaultCollCode()
public void setDefaultCollCode(short dfltCollCode)
dfltCollCode
- - the default collection codepublic short getDefaultRMCode()
public void setDefaultRMCode(short dfltRMCode)
dfltRMCode
- - the default resource manager codepublic java.lang.String getJavaXDOClassName()
setJavaXDOClassName(java.lang.String)
public void setJavaXDOClassName(java.lang.String javaXDOClassName)
javaXDOClassName
- - the name of Java XDO classpublic DKTextIndexDefICM getTextIndexDef()
public void setTextIndexDef(DKTextIndexDefICM textIndexDef) throws DKException
textIndexDef
- the text search index definition.if
- the attribute data type is not string typepublic short getVersionControl()
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 int getXDOClassID()
public void setXDOClassID(int XDOClassID)
XDOClassID
- the XDO class identifiergetXDOClassID()
public java.lang.String getXDOClassName()
xdoClassName
- - the XDO class name, or an empty stringsetXDOClassName(java.lang.String)
public void setXDOClassName(java.lang.String xdoClassName)
xdoClassName
- - the XDO class namesetJavaXDOClassName(java.lang.String)
,
getXDOClassName()
public 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 makes this item type view text searchable
override setTextSearchable in class dkAbstractEntityDef
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |