Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKItemTypeViewDefICM

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
All Implemented Interfaces:
DKConstant, DKConstantICM, dkEntityDef, DKMessageId, DKMessageIdICM, java.io.Serializable

public class DKItemTypeViewDefICM
extends DKComponentTypeViewDefICM
implements DKConstantICM, DKMessageIdICM, java.io.Serializable

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

See Also:
Serialized Form

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.DKComponentTypeDefICM
addAttr, addAttrGroup, addForeignKey, addSubEntity, createAttr, createAttrGroup, createForeignKey, getAttr, getAttrGroup, getCardinalityMax, getCardinalityMin, getComponentTypeId, getComponentTypeIndex, getComponentTypeName, getDeleteRule, getDescription, 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, setDescription, setId, setItemTypeName, setParent, setParentId, 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
 

Constructor Detail

DKItemTypeViewDefICM

public DKItemTypeViewDefICM()
Constructs an instance of item type view definition class

DKItemTypeViewDefICM

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

DKItemTypeViewDefICM

public DKItemTypeViewDefICM(DKItemTypeViewDefICM itemTypeView)
A copy constructor for the item type view definition object. The new instance of item type view definition class will contain all information copied from the original
Parameters:
itemTypeView - an item type view definition object
Method Detail

clone

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

getIntId

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

setIntId

public void setIntId(int id)
Sets the identifier for this item type view
Overrides:
setIntId in class DKComponentTypeViewDefICM
Parameters:
id - - the identifier to be assigned to this item type view

getAclCode

public int getAclCode()
Gets the access control list code associated with this item type view
Returns:
ACL code

setAclCode

public void setAclCode(int aclCode)
Sets the access control list code for this item type view
Parameters:
aclCode - - the ACL code
See Also:
getAclCode()

getAclName

public java.lang.String getAclName()
                            throws DKException,
                                   java.lang.Exception
Gets the access control list name associated with this view
Returns:
the ACL name
Throws:
if - an error occurs

setAclName

public void setAclName(java.lang.String aclName)
Sets the access control list name for this item type view
Parameters:
aclName - - the ACL name
See Also:
#getACLName()

isRoot

public boolean isRoot()
Checks if this object is a root component. Returns true if this item type view is a root component, false otherwise. This call will always return true since item type views are always root component type views
Overrides:
isRoot in class DKComponentTypeDefICM
Returns:
always return true

getClassification

public short getClassification()
Gets the classification of this tem type view The valide values for item type view classification are:
Returns:
item type view classification

setClassification

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

getDefaultCollCode

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

setDefaultCollCode

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

getDefaultRMCode

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

setDefaultRMCode

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

getJavaXDOClassName

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

setJavaXDOClassName

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

getTextIndexDef

public DKTextIndexDefICM getTextIndexDef()
Gets the text search index properties of this item type view. Returns null, if the text search inddex is not defined.
Returns:
textIndexDef the text index definition, DKTextIndexDefICM object,or null

setTextIndexDef

public void setTextIndexDef(DKTextIndexDefICM textIndexDef)
                     throws DKException
Sets the text search index properties of this item type view. Setting to null will remove the text index definition, thus disable text search
Parameters:
textIndexDef - the text search index definition.
Throws:
if - the attribute data type is not string type

getVersionControl

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

setVersionControl

public void setVersionControl(short versionControl)
Sets the version control rule applicable to this item type view. See 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 view
Returns:
the maximum number of versions allowed
See Also:
setVersionMax(short)

setVersionMax

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

getXDOClassID

public int getXDOClassID()
Gets the XDO class identifier used to represent this item type view. This method is only applicable to item type views 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, or zero if not applicable

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()

getXDOClassName

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

setXDOClassName

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

isTextSearchable

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

setTextSearchable

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

EIP Java APIs

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