- getIntId
- Gets the integer identifier of this item type view.
Overrides: getIntId() in class
DKComponentTypeViewDefICM. Returns: the identifier of
this item type view.
virtual long getIntId();
- setIntId
- Sets the identifier for of this item type view. Overrides
: setIntId() in class DKComponentTypeViewDefICM.
Parameters: id - the identifier to be assigned to this item
type view.
virtual void setIntId(long itemTypeViewId);
- getAclCode
- Gets the access list code to associate with this view.
Returns: the ACL code.
long getAclCode();
- setAclCode
- Sets the access control list code for this item type view.
Parameters: acl - the ACL code. See
getAclCode()
void setAclCode(long aclCode);
- getAclName
- Gets the access list code to associate with this view.
DKString getAclName();
- setAclName
- Sets the access control list code for this item type view.
void setAclName(const char* aclName);
- getClassification
- Gets the classification of this item type view. The valid 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 that 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.
Returns: The item type view classification.
short getClassification();
- setClassification
- 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
getClassification()
void setClassification(short itemTypeClass);
- setVersioningType
- Sets the item type versioning type to the given value.
Parameters: versioningType -versioning type of one of the
following values:
- DK_ICM_DOC_NO_VERSIONING: no verioning.
- DK_ICM_ITEM_VERSIONING_OPTIMIZED: optimized versioning model where
attributes are not versioned.
- DK_ICM_ITEM_VERSIONING_FULL: fully versioning model where attributes
can be versioned.
void setVersioningType(short versioningType);
- getVersioningType
- Gets the item versioning type. Returns:
versioningType of one of the following values:
- DK_ICM_DOC_NO_VERSIONING: no verioning.
- DK_ICM_ITEM_VERSIONING_OPTIMIZED: optimized versioning model where
attributes are not versioned.
- DK_ICM_ITEM_VERSIONING_FULL: fully versioning model where attributes
can be versioned.
short getVersioningType();
- getDefaultCollCode
- Gets the default collection to store a 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.
short getDefaultCollCode();
- setDefaultCollCode
- Sets the default collection to store resource objects for this item
type. Parameters: dfltCollCode - the default
collection code.
void setDefaultCollCode(short dfltCollCode);
- 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. Throws:
DKException See setDefaultRMCode(short)
short getDefaultRMCode();
- setDefaultRMCode
- 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 - default -
resource manager code. Throws: DKException
void setDefaultRMCode(short dfltRMCode);
- 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. Returns: the XDO classification name, or
an empty string. See setXDOClassName(const char*)
DKString getXDOClassName();
- setXDOClassName
- Sets the name of the XDO class used to represent this item type view in
the object model. This method is only applicable to items type views,
resource item view or document part view. Parameters:
xdoClassName - the XDO classification name. See
getXDOClassName()
void setXdoClassName(const char* xdoClassName);
- 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.
long getXDOClassID();
- setXDOClassID
- Sets the XDO classification ID identifier. See the method
getXDOClassID() for more information. Parameters:
XDOClassID - the XDO class identifier. See getXDOClassID()
void setXDOClassID(long dfltXDOClassID);
- getTextIndexDef
- Gets the text search index properties of this item type view.
Returns null, if the text search inddex is not defined.
Returns: the text index definition, DKTextIndexDefICM object,
or null.
DKTextIndexDefICM* getTextIndexDef();
- setTextIndexDef
- 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: DKException.
void setTextIndexDef(DKTextIndexDewfICM* textIndexDef);
- getVersionControl
- Gets the version control rules for this item type view. There are
three possible values:
- DK_ICM_VERSION_CONTROL_NEVER : versioning is not supported under
this item type.
- DK_ICM_VERSION_CONTROL_ALWAYS: always create a new version.
- DK_ICM_VERSION_CONTROL_BY_APPLICATION: application determines when
to create a new version or update in place.
Returns: the version control rules.
short getVersionControl();
- setVersionControl
- 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().
Throws: DKException See getVersionControl()
void setVersionControl(short versionControl);
- getVersionMax
- Gets the maximum number of versions for each item instance under this item
type view. Returns: the maximum number of versions
allowed. See setVersionMax(short)
short getVersionMax();
- setVersionMax
- 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.
Throws: DKException
void setVersionMax(short versionMax);
- isRoot
- Checks if this object is a root component. Returns true if this
item type view is the 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.
DKBoolean isRoot();
- isTextSearchable
- Checks if this item type view is enabled for text search.
Overrides: isTextSearchable() in class dkEntityDef.
Returns: true, if this item type view is text
searchable.
DKBoolean isTextSearchable();
- setTextSearchable
- Enables this item type view for text search.
Overrides: setTextSearchable in class dkEntityDef.
Parameters: isTextSearchable - true or false; true makes
this item type view text searchable.
void setTextSearchable(DKBoolean isTextSearchable);
- getTextSearchAttr
- Gets the text search attribute of this item type view. Returns
null, if it is not defined. Returns: an attribute
definition object, DKAttrDefICM, or null.
DKAttrDefICM* getTextSearchAttr();
- 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.
virtual dkEntityDef* clone();