Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKComponentTypeViewDefICM

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.dkAbstractEntityDef
        |
        +--com.ibm.mm.sdk.common.DKComponentTypeDefICM
              |
              +--com.ibm.mm.sdk.common.DKComponentTypeViewDefICM
All Implemented Interfaces:
DKConstant, DKConstantICM, dkEntityDef, DKMessageId, DKMessageIdICM, java.io.Serializable
Direct Known Subclasses:
DKItemTypeViewDefICM

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

A component type view is a view used to control access to component types and their contained attributes. Component type views maintain the parent-child hierarchy like the component types on which they are based. Component type views are owned by an item type view that controls access to them. The DKComponentTypeViewDefICM class is used to represent component type views in Content Manager. It defines methods for accessing component type view information. Multiple views can be defined on the same component type. A user cannot delete the view that has the same ID as the component type (i.e. the base view)

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
DKComponentTypeViewDefICM()
          Default constructor for the component type view object.
DKComponentTypeViewDefICM(DKComponentTypeViewDefICM cpView)
          Copy constructor for the component type view object.
DKComponentTypeViewDefICM(dkDatastore ds)
          Constructs the definition of the component type view definition object for the given ICM datastore
 
Method Summary
 void add()
          Adds this component type view definition to the persistent store.
 java.lang.Object clone()
          Clones the component type view definition object
 dkEntityDef createSubEntity()
          Creates a new child component view definition under this component view definition
 void del()
          Deletes this component type view definition from the persistent store.
 int getAccessModuleResult()
          Retrieves the result of the access module.
 short getAccessModuleStatus()
          Retrieves the status of the access module generation process,
 short getAccessModuleVers()
          Retrieves the version number for the last access module generated for this component type view.
 int getComponentViewId()
          Retrieves the identifier for this component type view object
 DKTimestamp getCreatedTimestamp()
          Gets the time stamp representing the time at which this component type view was created.
 int getIntId()
          Retrieves the integer identifier of the component type view definition object getIntId in class DKComponentTypeDefICM
 int getItemTypeViewId()
          Retrieves the identifier for the item type view to which this component type view belongs
 java.lang.String getPrevAccessModule()
          Retrieves the name of the last access module that was active before an attempt was made to create a new access module
 boolean hasSubEntityViews()
          Return true if this component type view entity has child component type views under it; false otherwise.
 void setIntId(int id)
          Sets the integer-based identifer of the component type view object to the specified value
 void update()
          Updates the entity definition for this component type view in the persistent store.
 
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, isRoot, 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, isTextSearchable, setDatastore, setDescription, setName, setParentEntityName, setTextSearchable, setType
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKComponentTypeViewDefICM

public DKComponentTypeViewDefICM()
Default constructor for the component type view object. Constructs the definition of the component type view

DKComponentTypeViewDefICM

public DKComponentTypeViewDefICM(dkDatastore ds)
Constructs the definition of the component type view definition object for the given ICM datastore
Parameters:
ds - - teh ICM datastore as an instance of DKDatastoreICM

DKComponentTypeViewDefICM

public DKComponentTypeViewDefICM(DKComponentTypeViewDefICM cpView)
Copy constructor for the component type view object. Creates a component type view definition object using the component type view object in the input parameter as a template
Parameters:
cpView - component type view to be used as a template for creating the new instance
Method Detail

clone

public java.lang.Object clone()
Clones the component type view definition object
Overrides:
clone in class DKComponentTypeDefICM
Returns:
A component type view definition object as a clone of this object

getIntId

public int getIntId()
Retrieves the integer identifier of the component type view definition object getIntId in class DKComponentTypeDefICM
Overrides:
getIntId in class DKComponentTypeDefICM
Returns:
integer based identifier of the component type view definition object

setIntId

public void setIntId(int id)
Sets the integer-based identifer of the component type view object to the specified value
Overrides:
setIntId in class DKComponentTypeDefICM
Parameters:
id - integer based identifier to use to set the component type view object identifier

getComponentViewId

public int getComponentViewId()
Retrieves the identifier for this component type view object
Overrides:
getComponentViewId in class DKComponentTypeDefICM
Returns:
identifier for this component type view object

getItemTypeViewId

public int getItemTypeViewId()
Retrieves the identifier for the item type view to which this component type view belongs
Returns:
the integer based identifier for the item type view to which this component type view belongs

getAccessModuleStatus

public short getAccessModuleStatus()
Retrieves the status of the access module generation process,
Returns:
status of the access module generation process. The valid values are:
  • a negative value: the access module has not yet been generated
  • 0 : the access module has been generated and is available for use.
  • a positive value: an error occured when generating the access module. The status value is the return code from the access module generation process

getAccessModuleResult

public int getAccessModuleResult()
Retrieves the result of the access module. When the access module status returned from a call to the getAccessModuleStatus() method on this object contains a positive value, the access module result indicated the type of error that occured when generating the access module Zero indicated generate the access module successfully
Returns:
access module result

getAccessModuleVers

public short getAccessModuleVers()
Retrieves the version number for the last access module generated for this component type view. When a component type definition is changed by the installation, the library server uses the new type definition to generated a new access module
Returns:
the new access module version

getPrevAccessModule

public java.lang.String getPrevAccessModule()
Retrieves the name of the last access module that was active before an attempt was made to create a new access module
Returns:
name of the last active access module for this component type view

getCreatedTimestamp

public DKTimestamp getCreatedTimestamp()
Gets the time stamp representing the time at which this component type view was created. This timestamp entry is automatically generated by the library server and so the user cannot update the value.
Returns:
timestamp representing the time at which this component type view was generated

createSubEntity

public dkEntityDef createSubEntity()
                            throws DKException,
                                   java.lang.Exception
Creates a new child component view definition under this component view definition
Overrides:
createSubEntity in class DKComponentTypeDefICM
Returns:
new definition of a child component type view object under this component view definition as an instance of DKComponentTypeVewDefICM.
Throws:
DKException - if this method call did not create a new sub entity

add

public void add()
         throws DKException,
                java.lang.Exception
Adds this component type view definition to the persistent store.
Overrides:
add in class DKComponentTypeDefICM
Throws:
DKException - when an error is encountered

del

public void del()
         throws DKException,
                java.lang.Exception
Deletes this component type view definition from the persistent store.
Overrides:
del in class DKComponentTypeDefICM
Throws:
DKException - when an error is encountered

update

public void update()
            throws DKException,
                   java.lang.Exception
Updates the entity definition for this component type view in the persistent store.
Overrides:
update in class DKComponentTypeDefICM
Throws:
DKException - when an error is encountered

hasSubEntityViews

public boolean hasSubEntityViews()
                          throws DKException,
                                 java.lang.Exception
Return true if this component type view entity has child component type views under it; false otherwise.
Returns:
true if this component type view has child component type view; false otherwise.

EIP Java APIs

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