|
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.dkAbstractDatastoreDef | +--com.ibm.mm.sdk.common.DKDatastoreDefICM
DKDatastoreDefICM implements the interface dkDatastoreDef. It provides the actual functions to access and manipulate Content Manager Version 8 and later datastore metadata and related information. It contains methods for the the creation, deletion, update and listing of item types, item type views, atributes and attribute groups plus methods for managing link type, semantic type, XDO classification, component type index and so on.
Field Summary | |
static int |
DK_ICM_ALL_ITEM_TYPES
|
static int |
DK_ICM_PARTS_ITEM_TYPES
|
static int |
DK_ICM_SYSTEM_ITEM_TYPES
|
static int |
DK_ICM_USER_ITEM_TYPES
|
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId |
For details, see the class or interface |
Constructor Summary | |
DKDatastoreDefICM(dkDatastore ds)
Constructs a datastore definition for Content Manager server. |
Method Summary | |
void |
add(dkAttrDef attrObj)
Adds the given attribute definition to the persistent store. |
int |
add(dkAttrGroupDef attrGroupObj)
Adds the given attribute group to the persistent store. |
void |
add(dkCollection relColl)
Add the given collection of the item type relation objects to the persistent store |
void |
add(DKComponentTypeIndexDefICM ComponentTypeIndexObj)
Adds the given component type index object to the persistent store. |
void |
add(dkEntityDef itemTypeObj)
Adds the given entity definition to the persistent store. |
void |
add(DKItemTypeRelationDefICM itRelationObj)
Adds the given item type relation object to the persistent store |
int |
add(DKLinkTypeDefICM linkTypeObj)
Adds the given link type object to the persistent store. |
int |
add(DKSemanticTypeDefICM semanticTypeObj)
Adds the given semantic type object to the persistent store. |
int |
add(DKXDOClassificationDefICM xdoClassificationObj)
Adds the given XDO classification object to the persistent store. |
dkAttrDef |
createAttr()
Creates a new attribute definition on the object. |
dkAttrGroupDef |
createAttrGroup()
Creates a attribute group definintion and returns it to caller. |
dkAttrGroupDef |
createAttrGroup(int option)
Creates an attribute group defintion based on the option requested and returns it to the caller as a dkAttrGroupDef object. |
dkEntityDef |
createEntity()
Creates a new instance of an entity object and returns it to the caller. |
dkEntityDef |
createItemType()
Creates a new instatnce of DKItemTypeDefICM and returns the object to its caller This is a specific interface for Content Manager server where entities are equivalent to item types. |
dkDatastoreAdmin |
datastoreAdmin()
Gets a datastore administration object for this datastore. |
void |
del(dkAttrDef attrObj)
Deletes the given attribute definition from the persistent store. |
void |
del(dkAttrGroupDef attrGroupObj)
Deletes the given attribute group from the persistent store. |
void |
del(dkCollection relColl)
Deletes the given collection of item type relation objects from the persistent store |
void |
del(DKComponentTypeIndexDefICM componentTypeIndexObj)
Deletes the given component type index object from the persistent store. |
void |
del(dkEntityDef itemTypeObj)
Deletes the definition of an item type from the persistent store. |
void |
del(DKItemTypeRelationDefICM itRelationObj)
Deletes the given item type relation object from the persistent store |
void |
del(DKLinkTypeDefICM linkTypeObj)
Deletes the given link type definition from the persistent store. |
void |
del(DKSemanticTypeDefICM semanticTypeObj)
Deletes the given semantic type object from the persistent store. |
void |
del(DKXDOClassificationDefICM xdoClassificationObj)
Deletes the given XDO classification object from the persistant store. |
DKComponentTypeViewDefICM |
getActiveComponentTypeView(java.lang.String compTypeName)
Gets the active view for the given component type name. |
DKItemTypeViewDefICM |
getActiveItemTypeView(java.lang.String itemTypeName)
Gets the active view for the given item type name. |
dkCollection |
listActiveComponentTypeViews()
Gets a list active views for all the component types the user has access to. |
dkCollection |
listActiveComponentTypeViews(int options)
Gets a list of the active component type view definitions from the persistent store. |
dkCollection |
listActiveItemTypeViews()
Gets a list active views for the user-defined item types the user has access to. |
dkCollection |
listActiveItemTypeViews(int options)
Gets a list of active views from a persistent store. |
dkCollection |
listAttrGroup()
Gets a list of attribute groups defined in the current server. |
dkCollection |
listAttrGroup(int option)
Gets different lists of attributes group defined in the current server according to the option. |
java.lang.String[] |
listAttrGroupNames()
Gets an array of names of the user-defined attribute groups on the current server |
java.lang.String[] |
listAttrGroupNames(int option)
Gets different lists of the attribute group names defined in the current server according to the option value. |
java.lang.String[] |
listAttrNames()
Gets a list of the user-defined attribute names in the datastore. |
java.lang.String[] |
listAttrNames(int option)
Gets different lists of the attribute names defined in the datastore. |
dkCollection |
listAttrs()
Gets a list of user-defined attributes from the datastore. |
dkCollection |
listAttrs(int option)
Gets different lists of attributes defined in the datastore. |
dkCollection |
listComponentTypeIndexes(java.lang.String compTypeName)
Lists component type indexes for the given name defined in this datastore. |
java.lang.String[] |
listComponentTypeIndexNames(java.lang.String compTypeName)
Lists component type index names defined in this datastore. |
java.lang.String[] |
listComponentTypeNames()
Gets a list of user-defined component type names from the persistent store. |
java.lang.String[] |
listComponentTypeNames(int options)
Gets a list of component type names from the persistent store. |
dkCollection |
listComponentTypes()
Gets a list of user-defined component type definitions from a persistent store. |
dkCollection |
listComponentTypes(int options)
Gets a list of component type definitions from a persistent store. |
java.lang.String[] |
listComponentTypeViewNames()
Gets a list of component type view names from the persistent store. |
dkCollection |
listComponentTypeViews()
Gets a list of componnent type views from persistent store |
java.lang.String[] |
listDefinedPartTypeNames()
Gets a list of part item type names. |
dkCollection |
listEntities()
Gets a list of user defined item type definitions from a persistent store. |
dkCollection |
listEntities(DKNVPair[] options)
Gets a list of item type definitions from the persistent store. |
dkCollection |
listEntities(int options)
Gets a list of item type definitions from the persistent store. |
dkCollection |
listEntityAttrGroup(java.lang.String entityName)
Gets a list of the attributes groups for a given item type. |
java.lang.String[] |
listEntityAttrGroupNames(java.lang.String entityName)
Gets a list of the attribute group names for a given item type. |
java.lang.String[] |
listEntityAttrNames(java.lang.String entityName)
Gets a list of the attribute names for a given item type. |
dkCollection |
listEntityAttrs(java.lang.String entityName)
Gets a list of the attribute definitions for a given item type. |
java.lang.String[] |
listEntityNames()
Gets a list of user defined item type names from a persistent store. |
java.lang.String[] |
listEntityNames(int options)
Gets an array of item type names from the persistent store. |
dkCollection |
listItemTypeRelations()
List all item type relation definitions from the persistent store |
dkCollection |
listItemTypeViews()
Gets a list of Item type views from persistent store |
java.lang.String[] |
listLinkTypeNames()
Lists the link type names defined in this datastore. |
dkCollection |
listLinkTypes()
Lists link types defined in this datastore. |
java.lang.String[] |
listSemanticTypeNames()
Lists semantic type names defined in this datastore. |
dkCollection |
listSemanticTypes()
Lists semantic types defined in this datastore. |
java.lang.String[] |
listXdoClassificationNames()
Lists the XDO classification names defined in this datastore. |
dkCollection |
listXdoClassifications()
Lists the XDO classification definitions in this datastore. |
void |
makeViewActive(DKItemTypeViewDefICM itemTypeView)
Sets the given item type view as the active view. |
void |
makeViewsActive(dkCollection views)
Sets a collection of item type view as the active view. |
void |
rebuildComponentType(java.lang.String compTypeName)
Rebuilds the neccessary dynamic linked library for access module functions for a given component type name. |
void |
reorgTextIndexes(int lCompTypeId)
Reorganizes a text index, to optimize performance. |
dkAttrDef |
retrieveAttr(java.lang.String attrName)
Retrieves an attribute definition from the persistent store by name. |
dkAttrGroupDef |
retrieveAttrGroup(java.lang.String attrGroupName)
Retrieves an attribute group with the persistent store. |
DKComponentTypeDefICM |
retrieveComponentType(java.lang.String compTypeName)
Retrieves the component type definition with the given name from the persistent store. |
DKComponentTypeIndexDefICM |
retrieveComponentTypeIndex(java.lang.String ComponentTypeIndexName,
java.lang.String compTypeName)
Retrieves the definition of the component type index for the given component type index for the given name from the persistent store. |
dkEntityDef |
retrieveComponentTypeView(java.lang.String cpViewName)
Retrieves the definition for the given component type view name from the persistent store. |
dkEntityDef |
retrieveEntity(java.lang.String entityName)
Gets the definition for the given item type name from the persistent store |
DKItemTypeRelationDefICM |
retrieveItemTypeRelation(int srcItemTypeID,
int tgtItemTypeID)
Retrieves the item type relation definition for the given source item type and target item type from the persistent store |
dkCollection |
retrieveItemTypeRelations(int srcItemTypeID)
Retrieves a collection of the item type relation objects for the given source item type id from the persistent store |
DKItemTypeViewDefICM |
retrieveItemTypeView(java.lang.String itViewName)
Retrieves the definition for the given item type view from the persistent store. |
DKLinkTypeDefICM |
retrieveLinkType(java.lang.String linkTypeName)
retrieves the link type object for a given name from persistent store. |
DKSemanticTypeDefICM |
retrieveSemanticType(java.lang.String semanticTypeName)
Retrieves the semantic type object for the given name from the persistent store. |
DKXDOClassificationDefICM |
retrieveXdoClassification(java.lang.String xdoClassificationName)
Gets the definition of XDO classification object for the given name from the persistent store. |
void |
update(dkAttrDef attrObj)
Updates the definition of the specified attribute on the current datastore. |
void |
update(dkAttrGroupDef attrGroupObj)
Updates the given attribute group in the persistent store. |
void |
update(dkCollection relColl)
Updates the given collection of item type relation objects in the persistent store |
void |
update(dkEntityDef itemTypeObj)
Updates the item type defintion in the persistent store. |
void |
update(DKItemTypeRelationDefICM itRelationObj)
Updates the given item type relation object in the persistent store |
void |
update(DKLinkTypeDefICM linkTypeObj)
Updates the given link type definition in the persistent store. |
void |
update(DKSemanticTypeDefICM semanticTypeObj)
Updates the given semantic type object in the persistent store. |
void |
update(DKXDOClassificationDefICM xdoClassificationObj)
Updates the given XDO classification object in the persistent store. |
void |
updateTextIndexes(int lCompTypeId)
Forces text index to process documents in the queue. |
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractDatastoreDef |
clearCache, datastoreName, datastoreType, deleteEntity, getDatastore, getEntity, listEntityNames, listSearchableEntities, listSearchableEntities, listSearchableEntities, listSearchableEntityNames, listSearchableEntityNames, listSearchableEntityNames, listSearchTemplateNames, listSearchTemplates, setDatastore |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int DK_ICM_USER_ITEM_TYPES
public static final int DK_ICM_ALL_ITEM_TYPES
public static final int DK_ICM_SYSTEM_ITEM_TYPES
public static final int DK_ICM_PARTS_ITEM_TYPES
Constructor Detail |
public DKDatastoreDefICM(dkDatastore ds)
ds
- datastoreMethod Detail |
public dkEntityDef createEntity() throws DKException, java.lang.Exception
createEntity
in class dkAbstractDatastoreDef
if
- an error occurscreateItemType()
public dkEntityDef createItemType() throws DKException, java.lang.Exception
if
- an error occurscreateEntity()
public void add(dkEntityDef itemTypeObj) throws DKException, java.lang.Exception
add
in class dkAbstractDatastoreDef
itemTypeObj
- item type object to be created in the persistent store. It
can be DKItemTypeDefICM or DKItemTypeViewDefICM objectDKException
- if the item type object is invalid
or an error occurs in the server.public void del(dkEntityDef itemTypeObj) throws DKException, java.lang.Exception
del
in class dkAbstractDatastoreDef
itemTypeObj
- a dkEntityDef object to delete. In datastore ICM, the entity
def object can be either DKItemTypeDefICM or DKItemTypeViewDefICM object.DKException
- if the itemTypeObj is invalid or the entity does
not exist in the server.public void update(dkEntityDef itemTypeObj) throws DKException, java.lang.Exception
itemTypeObj
- the dkEntityDef object to be updated. In datastore ICM, the entityDef object
can be either DKItemTypeDefICM or DKItemTypeViewDefICM objectDKException
- if the itemTypeObj is invalid or the entity does
not exist in the server.public dkEntityDef retrieveEntity(java.lang.String entityName) throws DKException, java.lang.Exception
retrieveEntity
in class dkAbstractDatastoreDef
entityName
- the name of the item type to be retrieved.DKException
- if if error occurs.public dkCollection listEntities(int options) throws DKException, java.lang.Exception
listEntities
in class dkAbstractDatastoreDef
options
- to filter the results. See above list for valid option values.DKException
- if error occurs.public dkCollection listEntities() throws DKException, java.lang.Exception
listEntities
in class dkAbstractDatastoreDef
DKException
- if error occurs.public dkCollection listEntities(DKNVPair[] options) throws DKException, java.lang.Exception
listEntities
in class dkAbstractDatastoreDef
options
- DKNVPair[] options for listEntitiesDKConstant.DK_ICM_ENTITY_TYPE
, VALUE: integer_item_type_filter
DKConstant.DK_ICM_BASE
Lists base item type definitions
DKConstant.DK_ICM_VIEW
Lists item type view definitions
DKConstant.DK_ICM_BASE_AND_VIEW
List base item type definitions and view definitionsDKConstant.DK_ICM_PRIV_TYPE
, VALUE: String[]
DKException
- if error occurs.public java.lang.String[] listEntityNames(int options) throws DKException, java.lang.Exception
listEntityNames
in class dkAbstractDatastoreDef
options
- based on which item types are filtered.DKException
- if error occurs.public java.lang.String[] listEntityNames() throws DKException, java.lang.Exception
listEntityNames
in class dkAbstractDatastoreDef
DKException
- if an error occurs.public java.lang.String[] listDefinedPartTypeNames() throws DKException, java.lang.Exception
DKException
- if an error occurs.public dkCollection listEntityAttrs(java.lang.String entityName) throws DKException, java.lang.Exception
listEntityAttrs
in class dkAbstractDatastoreDef
entityName
- the name of item type which has the attributes.DKException
- if the item type name does not exist in the persistent storepublic java.lang.String[] listEntityAttrNames(java.lang.String entityName) throws DKException, java.lang.Exception
listEntityAttrNames
in class dkAbstractDatastoreDef
entityName
- the name of the item type which has the attributes.DKException
- if the item type name does not exist.public dkCollection listEntityAttrGroup(java.lang.String entityName) throws DKException, java.lang.Exception
entityName
- the name of the item type which has the attribute groups.DKException
- if the item type name does not exist.public java.lang.String[] listEntityAttrGroupNames(java.lang.String entityName) throws DKException, java.lang.Exception
entityName
- the name of item type which has the attribute groups.DKException
- if the item type name does not exist.public dkDatastoreAdmin datastoreAdmin() throws DKException, java.lang.Exception
datastoreAdmin
in class dkAbstractDatastoreDef
public DKItemTypeViewDefICM retrieveItemTypeView(java.lang.String itViewName) throws DKException, java.lang.Exception
itViewName
- name of item type view to retrievepublic dkEntityDef retrieveComponentTypeView(java.lang.String cpViewName) throws DKException, java.lang.Exception
compTypeViewName
- name of the component type view to retrieve.DKException
- if the component type view name does not exist.public dkCollection listComponentTypeViews() throws DKException, java.lang.Exception
DKException
- if the component type view name does not exist.public dkCollection listItemTypeViews() throws DKException, java.lang.Exception
DKException
- if the component type view name does not exist.public java.lang.String[] listComponentTypeViewNames() throws DKException, java.lang.Exception
public DKComponentTypeViewDefICM getActiveComponentTypeView(java.lang.String compTypeName) throws DKException, java.lang.Exception
compTypeName
- - the name of the component typepublic DKItemTypeViewDefICM getActiveItemTypeView(java.lang.String itemTypeName) throws DKException, java.lang.Exception
itemTypeName
- - the name of the item typepublic void makeViewActive(DKItemTypeViewDefICM itemTypeView) throws DKException, java.lang.Exception
itemTypeView
- the view to make active.public void makeViewsActive(dkCollection views) throws DKException, java.lang.Exception
itemTypeView
- the view to make active.public dkCollection listActiveComponentTypeViews() throws DKException, java.lang.Exception
public dkCollection listActiveItemTypeViews() throws DKException, java.lang.Exception
public dkCollection listActiveItemTypeViews(int options) throws DKException, java.lang.Exception
options
- based on which item types are filtered.DKException
- if error occurs.public dkCollection listActiveComponentTypeViews(int options) throws DKException, java.lang.Exception
options,
- the valid option values are
DKException
- if an error occurs.public dkCollection listComponentTypes(int options) throws DKException, java.lang.Exception
options,
- the valid option values are
DKException
- if an error occurs.public dkCollection listComponentTypes() throws DKException, java.lang.Exception
DKException
- if an error occurs.public java.lang.String[] listComponentTypeNames(int options) throws DKException, java.lang.Exception
options,
- the valid option values are
DKException
- if an error occurs.public java.lang.String[] listComponentTypeNames() throws DKException, java.lang.Exception
DKException
- if an error occurs.public void rebuildComponentType(java.lang.String compTypeName) throws DKException, java.lang.Exception
compTypeName
- component type name to be rebuild.public DKComponentTypeDefICM retrieveComponentType(java.lang.String compTypeName) throws DKException, java.lang.Exception
DKException
- if an error occurs.public void updateTextIndexes(int lCompTypeId) throws DKException, java.lang.Exception
component_id
- id of the component containing indexes to be updatedpublic void reorgTextIndexes(int lCompTypeId) throws DKException, java.lang.Exception
component_id
- id of the component containing indexes to be reorganizedpublic dkCollection listAttrs() throws DKException, java.lang.Exception
DKException
- if a problem is encountered.public dkCollection listAttrs(int option) throws DKException, java.lang.Exception
option,
- one of the following:
DKException
- if an error occurs.public java.lang.String[] listAttrNames() throws DKException, java.lang.Exception
DKException
- if an error occurs.public java.lang.String[] listAttrNames(int option) throws DKException, java.lang.Exception
option,
- one of the following value:
DKException
- if an error is encountered.public dkAttrDef retrieveAttr(java.lang.String attrName) throws DKException, java.lang.Exception
attrName
- the name of the attribute to be retrieved.DKException
- if an error is encountered.public dkAttrDef createAttr() throws DKException, java.lang.Exception
DKException
- if an error is encountered.public void add(dkAttrDef attrObj) throws DKException, java.lang.Exception
attrObj
- attribute to be added.DKException
- if an error occurs.public void del(dkAttrDef attrObj) throws DKException, java.lang.Exception
attrObj
- the attribute to be deleted.DKException
- if an error occurs.public void update(dkAttrDef attrObj) throws DKException, java.lang.Exception
attrObj
- the attribute to be updated.DKException
- if the attrObj is invalid or does
not exist in the server.public dkCollection listAttrGroup() throws DKException, java.lang.Exception
DKException
- if an error is encountered.public dkCollection listAttrGroup(int option) throws DKException, java.lang.Exception
option
- one of values aboveDKException
- if a problem is encountered.public java.lang.String[] listAttrGroupNames() throws DKException, java.lang.Exception
DKException
- if an error is encountered.public java.lang.String[] listAttrGroupNames(int option) throws DKException, java.lang.Exception
option
- one of the values aboveDKException
- if an error is encountered.public dkAttrGroupDef createAttrGroup() throws DKException, java.lang.Exception
DKException
- if an error is encountered.public dkAttrGroupDef createAttrGroup(int option) throws DKException, java.lang.Exception
option
- only DK_ICM_REFERENCE_ATTRGROUP is supported, This call
request to create a reference attribute group.DKException
- if an error is encounteredjava.lang.Exception
- if an error is encounteredpublic int add(dkAttrGroupDef attrGroupObj) throws DKNotExistException, DKException, java.lang.Exception
attrGroupObj
- attribute group object to be added.DKException
- if an error is encountered.public void del(dkAttrGroupDef attrGroupObj) throws DKException, java.lang.Exception
attrGroupObj
- the attribute group object to be deleted.DKException
- if an error is encountered.public void update(dkAttrGroupDef attrGroupObj) throws DKException, java.lang.Exception
attrGroupObj
- attribute group object to be updated.DKException
- if an error is encountered.public dkAttrGroupDef retrieveAttrGroup(java.lang.String attrGroupName) throws DKException, java.lang.Exception
name
- the name of the attribute group to be retrieved.DKException
- if an error is encountered.public dkCollection listLinkTypes() throws DKException, java.lang.Exception
DKException
- if an error is encountered.public java.lang.String[] listLinkTypeNames() throws DKException, java.lang.Exception
DKException
- if an error is encountered.public DKLinkTypeDefICM retrieveLinkType(java.lang.String linkTypeName) throws DKException, java.lang.Exception
linkTypeName
- - the name of link type to be retrieved.DKException
- if the link type doesnot exist in the persistent store.public int add(DKLinkTypeDefICM linkTypeObj) throws DKException, java.lang.Exception
linkTypeObj
- - link type object to be added.DKException
- if an error is encountered.public void del(DKLinkTypeDefICM linkTypeObj) throws DKException, java.lang.Exception
linkTypeObj
- - the link type object to be deleted.DKException
- if an error is encountered.public void update(DKLinkTypeDefICM linkTypeObj) throws DKException, java.lang.Exception
linkTypeObj
- - the link type objec to be updated.DKException
- if an error is encountered.public dkCollection listSemanticTypes() throws DKException, java.lang.Exception
DKSemanticTypeDefICM
.DKException
- if an error is encountered.public java.lang.String[] listSemanticTypeNames() throws DKException, java.lang.Exception
DKException
- if an error is encountered.public DKSemanticTypeDefICM retrieveSemanticType(java.lang.String semanticTypeName) throws DKException, java.lang.Exception
semanticTypeName
- - the name of semantic type to be retrieved.DKSemanticTypeDefICM
object with the given name.DKException
- if the semantic type does not exist.public int add(DKSemanticTypeDefICM semanticTypeObj) throws DKException, java.lang.Exception
semanticTypeObj
- semantic type object to be added.identifier
of the semantic type object.DKException
- if an error is encountered.public void del(DKSemanticTypeDefICM semanticTypeObj) throws DKException, java.lang.Exception
semanticTypeObj
- - the semantic type object to be deleted.DKException
- if an error is encountered.public void update(DKSemanticTypeDefICM semanticTypeObj) throws DKNotExistException, DKException, java.lang.Exception
semanticTypeObj
- the semantic type object to be updated.DKException
- if an error is encountered.public dkCollection listXdoClassifications() throws DKException, java.lang.Exception
DKXDOClassificationDefICM
.DKException
- if an error is encountered.public java.lang.String[] listXdoClassificationNames() throws DKException, java.lang.Exception
DKException
- if an error is encountered.public DKXDOClassificationDefICM retrieveXdoClassification(java.lang.String xdoClassificationName) throws DKException, java.lang.Exception
xdoClassificationName
- name of XDO Classification to be retrieved.DKException
- if the XDO classification does not exist in the datastore.public int add(DKXDOClassificationDefICM xdoClassificationObj) throws DKException, java.lang.Exception
xdoClassificationObj
- XDO classification object to be added.DKException
- if an error is encountered.public void del(DKXDOClassificationDefICM xdoClassificationObj) throws DKException, java.lang.Exception
XdoClassificationObj
- - the definition of the XDO classification object
to be deleted.DKException
- if an error is encountered.public void update(DKXDOClassificationDefICM xdoClassificationObj) throws DKNotExistException, DKException, java.lang.Exception
xdoClassificationObj
- - the definition of the XDO classification object
to be updated.DKException
- if an error is encountered.public dkCollection listComponentTypeIndexes(java.lang.String compTypeName) throws DKException, java.lang.Exception
compTypeName
- - the component type name.DKComponentTypeIndexDefICM
.DKException
- if an error is encountered.public java.lang.String[] listComponentTypeIndexNames(java.lang.String compTypeName) throws DKException, java.lang.Exception
DKException
- if an error is encountered.public DKComponentTypeIndexDefICM retrieveComponentTypeIndex(java.lang.String ComponentTypeIndexName, java.lang.String compTypeName) throws DKException, java.lang.Exception
componentTypeIndexName
- - the name of the component type index to be retrieved.DKComponentTypeIndexDefICM
object.DKException
- if the component type index does not exist.public void add(DKComponentTypeIndexDefICM ComponentTypeIndexObj) throws DKException, java.lang.Exception
componentTypeIndexObj
- - the component type index object to be added.DKException
- if an error is encountered.public void del(DKComponentTypeIndexDefICM componentTypeIndexObj) throws DKException, java.lang.Exception
componentTypeIndexObj
- - the component type index object to be deleted.DKException
- if an error is encountered.public dkCollection listItemTypeRelations() throws DKException, java.lang.Exception
DKItemTypeRelationDefICM
.public dkCollection retrieveItemTypeRelations(int srcItemTypeID) throws DKException, java.lang.Exception
srcItemTypeID
- - the identifier of the source item type to be retrieved.DKItemTypeRelationDefICM
.DKException
- if an error occurspublic DKItemTypeRelationDefICM retrieveItemTypeRelation(int srcItemTypeID, int tgtItemTypeID) throws DKException, java.lang.Exception
srcItemTypeID
- - the identifier of the source item type to be retrievedtgtItemTypeID
- - the target item type id to be retrievedDKException
- if error occurspublic void add(DKItemTypeRelationDefICM itRelationObj) throws DKException, java.lang.Exception
itRelationObj
- - the item type relation object to be added.public void add(dkCollection relColl) throws DKException, java.lang.Exception
-
- the relColl of the item type relation objects to be added.public void del(DKItemTypeRelationDefICM itRelationObj) throws DKException, java.lang.Exception
itemTypeRelationObj
- - the item type relation object to be deleted.public void del(dkCollection relColl) throws DKException, java.lang.Exception
relColl
- - the collection of the item type relation objects - DKItemTypeRelationDefICM
to be deleted.public void update(DKItemTypeRelationDefICM itRelationObj) throws DKException, java.lang.Exception
itemTypeRelationObj
- the item type relation object to be updated.public void update(dkCollection relColl) throws DKException, java.lang.Exception
relColl
- the collection of the item type relation objects to be updated.
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |