|
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
This class is used to represent component type definitions in Content Manager Server. Just as Content Manager entities are represented by DKItemTypeDefICM, Content Manager sub-entities are represented by this class. In other words, in a item-type hierarchy, child components are represented by instances of DKComponentTypeDefICM. Furthermore, DKItemTypeDefICM is the specialized sub-class of DKComponentTypeDefICM used to represent root items in an item-type hierarchy.
#DKItemTypeDefICM
,
#dkAbstractEntityDef
, Serialized FormFields inherited from interface com.ibm.mm.sdk.common.DKMessageId |
For details, see the class or interface |
Constructor Summary | |
DKComponentTypeDefICM()
Default constructor for a component type. |
|
DKComponentTypeDefICM(DKComponentTypeDefICM compType)
copy constructor for a component type. |
|
DKComponentTypeDefICM(dkDatastore ds)
Constructs a component type class definition for the specified ICM datastore |
Method Summary | |
void |
add()
Adds this component type definition to the persistent store. |
void |
addAttr(dkAttrDef attrObj)
Adds a new attribute definition to this component type. |
void |
addAttrGroup(dkAttrGroupDef attrGroupObj)
Adds a new attribute group definition to the in-memory representation of this component type. |
void |
addForeignKey(DKForeignKeyDefICM fkey)
Adds a new foreign key to the in-memory representation of this component type |
void |
addSubEntity(dkEntityDef entityObj)
Adds a new child component type the in-memory representation of this component type. |
java.lang.Object |
clone()
Clone this component type definition object |
dkAttrDef |
createAttr()
Creates a new attribute type and returns it to caller as a reference t0 a dkAttrDef object |
dkAttrGroupDef |
createAttrGroup()
Creates a new attribute group definition and returns it to caller as a reference to a dkAttrGroupDef object. |
DKForeignKeyDefICM |
createForeignKey()
Creates a new foreign key and returns it to the caller as a reference to a DKForeignKeyDefICM object |
dkEntityDef |
createSubEntity()
Create a new child component type for this component type and return it to the caller as a reference to a dkEntityDef object. |
void |
del()
Deletes the persistent definition of this component type from the persistent store. |
dkAttrDef |
getAttr(java.lang.String attrName)
Retrieves an attribute definition object using its name from the in-memory representation of the component type. |
dkAttrGroupDef |
getAttrGroup(java.lang.String attrGroupName)
Retrieves an attribute group definition object using its name from the in-memory representation of this component type. |
short |
getCardinalityMax()
Retrieves the maximum number of rows for this component type. |
short |
getCardinalityMin()
Retrieves the minimum number of rows for the component type. |
int |
getComponentTypeId()
Gets the component type identifier for the component type. |
DKComponentTypeIndexDefICM |
getComponentTypeIndex(java.lang.String cpIndexName)
Retrieves a component type index object based on its name from the in-memory representation of this component type. |
java.lang.String |
getComponentTypeName()
Returns the name for this component type |
int |
getComponentViewId()
Returns the identifier for the component type view. |
short |
getDeleteRule()
Retrieves the delete rule for this component type. |
java.lang.String |
getDescription(java.lang.String langCode)
Retrieves the description for this component type for the specified languae code |
DKForeignKeyDefICM |
getForeignKey(java.lang.String constraintName)
Retrieves a foreign key object by its name from the in-memory representation of this component type. |
short |
getId()
Returns the identifier for this component type. |
int |
getIntId()
Gets the integer identifier for this component type |
int |
getItemTypeId()
Returns the identifier of the item type that this component type is associated with. |
java.lang.String |
getItemTypeName()
Retrieves the name of the item type that this component type is associated with. |
dkEntityDef |
getParent()
Retrieves the entity definition for the parent of this component type |
int |
getParentId()
Retrieves the identifier for the parent entity of this component type The parent identifier values is used to build the type hierarchy among the component types |
dkEntityDef |
getSubEntity(java.lang.String compName)
Retrieves a child component type definition object by its name from the in-memory representation of this component type. |
boolean |
isRoot()
Check to see if this component type is a root component type in an item-hierarchy or not |
boolean |
isView()
Check to see if this component type is a component type view definition object or a component type definition object. |
java.lang.String[] |
listAttrGroupNames()
Retrieves an array of names for user-defined attribute groups. |
java.lang.String[] |
listAttrGroupNames(int option)
Retrieves an array of names for attribute groups that satisfy the criteria in the specified option value |
dkCollection |
listAttrGroups()
Retrieves the list of user-defined attribute groups for this component type. |
dkCollection |
listAttrGroups(int option)
Retrieves a list of attributes group based on the value of the specified option DK_ICM_ALL_ATTRGROUP :Lists all attribute groups from the persistent store DK_ICM_USER_ATTRGROUP :Lists all user defined attribute groups DK_ICM_SYSTEM_ATTRGROUP :Lists all system attribute groups |
java.lang.String[] |
listAttrNames()
Retrieves an array of the names of user defined attributes that are not resource manager attributes |
java.lang.String[] |
listAttrNames(int option)
Retrieves an array of the names of attributes that don't belong to any attribute group and that satisfy the criteria in the specified option |
dkCollection |
listAttrs()
Retrieves a list of user defined attributes for this component type that don't belong to any attribute group and are not resource manager attributes. |
dkCollection |
listAttrs(int option)
Retrieves a list of attributes for this component type that don't belong to any attribute group and that satisfy the criteria in the specified option. |
dkCollection |
listComponentTypeIndexes()
Gets a list of component type indexes objects belong to the component type |
java.lang.String[] |
listComponentTypeIndexNames()
Gets an array of component type index names. |
java.lang.String[] |
listForeignKeyNames()
Retrieves an array of names for foreign key constraints belonging to this component type |
dkCollection |
listForeignKeys()
Retrieves the list of foreign keys for this component type |
dkCollection |
listSubEntities()
Retrieves a list of child component types for this component type. |
dkCollection |
listSubEntities(int option)
Retrieves a list of child component types for this component based on the option value. |
java.lang.String[] |
listSubEntityNames()
Retrieves an array of names for child component type. |
java.lang.String[] |
listSubEntityNames(int option)
Retrieves an array of names for child component type. |
void |
removeAttr(java.lang.String attrName)
Removes an attribute definition from this component type. |
void |
removeAttrGroup(java.lang.String attrGroupName)
Removes an attribute group from the in-memory representation of this component type. |
void |
removeForeignKey(java.lang.String constraintName)
Removes a foreign key from the in-memory representation of this component type. |
void |
removeSubEntity(java.lang.String compName)
Removes a child component type by its name from the in-memory representation of this component type. |
dkAttrDef |
retrieveAttr(java.lang.String attrName)
Retrieves an attribute definition object based on its name from the persistent store |
dkAttrGroupDef |
retrieveAttrGroup(java.lang.String attrGroupName)
Retrieves an attribute group object using its name from the persistent store |
DKComponentTypeIndexDefICM |
retrieveComponentTypeIndex(java.lang.String indexName)
Retrieve a component type index object by its name from the persistent store |
DKForeignKeyDefICM |
retrieveForeignKey(java.lang.String constraintName)
Retrieves a foreign key object based on its constraint name for this component type from the persistent store |
dkEntityDef |
retrieveParent()
Retrieves the parent entity definition for this component type from the persistent store |
dkEntityDef |
retrieveSubEntity(java.lang.String compName)
Retrieve a child component type object from the persistent store based on its name. |
void |
setCardinalityMax(short cardinalityMax)
Sets the maximum number of rows for this component type. |
void |
setCardinalityMin(short cardinalityMin)
Sets the minimum number of rows for this component type. |
void |
setComponentTypeName(java.lang.String compTypeName)
Sets the name for this component type |
void |
setDeleteRule(short deleteRule)
Sets the delete rule for this component type. |
void |
setDescription(java.lang.String desc,
java.lang.String langCode)
Sets a new value into the description field for this component type for the specified language code. |
void |
setId(short id)
Sets the identifier for this component type |
void |
setIntId(int id)
Sets the integer-based identifier for this component type |
void |
setItemTypeName(java.lang.String itemTypeName)
Sets the name of the item type that this component type is associated with |
void |
setParent(dkEntityDef parent)
Sets the parent component type for this component type. |
void |
setParentId(int parentEntityId)
Sets the identifier for the parent component type of this component type |
void |
update()
Updates the persistent reprenstation of this component type object in the persistent store. |
void |
updateAttr(dkAttrDef attrDef)
Updates an attribute definition from the in-memory representation of this component type |
void |
updateAttrGroup(dkAttrGroupDef attrGroupDef)
Updates the definition of an attribute group object inside the in-memory representation of this component type |
void |
updateForeignKey(DKForeignKeyDefICM fkey)
Updates the foreign key in the in-memory representation of this component type. |
void |
updateSubEntity(dkEntityDef subEntityDef)
Updates a child component type definition object in the in-memory representation of this component type. |
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 |
public DKComponentTypeDefICM()
public DKComponentTypeDefICM(dkDatastore ds)
ds
- - the ICM datastorepublic DKComponentTypeDefICM(DKComponentTypeDefICM compType)
compType
- component type object to be used as a template
for creating the new objectMethod Detail |
public java.lang.Object clone()
public boolean isRoot()
DKItemTypeDefICM
public boolean isView()
public short getId()
public void setId(short id)
id
- the identifier value for this component typepublic int getIntId()
public void setIntId(int id)
id
- - integer-based identifier for this component typepublic int getComponentTypeId()
public java.lang.String getComponentTypeName()
public void setComponentTypeName(java.lang.String compTypeName)
compTypeName
- name to be set for this component typepublic int getComponentViewId()
public int getItemTypeId()
public java.lang.String getItemTypeName() throws DKException, java.lang.Exception
public void setItemTypeName(java.lang.String itemTypeName) throws DKException, java.lang.Exception
itemTypeName,
- the name of the item type that this component type is
associated with.public dkAttrDef createAttr() throws DKException, java.lang.Exception
createAttr
in class dkAbstractEntityDef
if
- this entity did not allow a new attribute to be createdpublic void addAttr(dkAttrDef attrObj) throws DKAlreadyExistException, DKException, java.lang.Exception
addAttr
in class dkAbstractEntityDef
attrObj
- the new attribute definition to be added to the component type
as an instance of DKAttrDefICM.this
- attribute already exists in this component type definitionpublic void removeAttr(java.lang.String attrName) throws DKNotExistException, DKException
removeAttr
in class dkAbstractEntityDef
attrName
- name of the attribute definition that needs to be removed
from the in-memory representation of this component typeif
- this attribute definition to be removed doesn't exist
in the in-memory representation of this component typepublic dkAttrDef getAttr(java.lang.String attrName) throws DKException, java.lang.Exception
getAttr
in class dkAbstractEntityDef
attrName
- name of the attribute whose definition is to be retrievedif
- the attribute with the specified name does not existpublic void updateAttr(dkAttrDef attrDef) throws DKException, java.lang.Exception
attrDef
- the attribute definition that needs to be updated
from the in-memory representation of this component typeif
- the attribute definition to be updated does not exist
exist in the in-memory representation of this component typepublic dkCollection listAttrs() throws DKException, java.lang.Exception
listAttrs
in class dkAbstractEntityDef
if
- the component type name/identifier that those attributes belong is invalidpublic dkCollection listAttrs(int option) throws DKException, java.lang.Exception
option
- - valid values are:
if
- the component type name/identifier that those attributes belong is invalidpublic java.lang.String[] listAttrNames() throws DKException, java.lang.Exception
listAttrNames
in class dkAbstractEntityDef
if
- the component type name/identifier that those attributes belong is invalidpublic java.lang.String[] listAttrNames(int option) throws DKException, java.lang.Exception
option
- - valid option values are:
if
- the component type name/identifier that those attributes belong is invalidpublic dkAttrDef retrieveAttr(java.lang.String attrName) throws DKException, java.lang.Exception
retrieveAttr
in class dkAbstractEntityDef
attrName
- - the name of the attribute whose definition is to be retrieved
from the persistent storepublic dkAttrGroupDef createAttrGroup() throws DKException, java.lang.Exception
if
- this component does not create the new definition of an attribute grouppublic void addAttrGroup(dkAttrGroupDef attrGroupObj) throws DKAlreadyExistException, DKException, java.lang.Exception
attrGroupObj
- - a attribute group definition as an instance of DKAttrGroupDefICM.if
- the specified attribute group already exists in this component typepublic void removeAttrGroup(java.lang.String attrGroupName) throws DKNotExistException, DKException
attrGroupName
- name of the attribute group that needs to be removed from
the in-memroy representation of this component type.if
- the attribute group to be removed does not exist in this component typepublic dkAttrGroupDef getAttrGroup(java.lang.String attrGroupName) throws DKException, java.lang.Exception
attrGroupName
- name of attribute group to be retrieved from the in-memory
representation of the component typeif
- the attribute group with the specified name does not exist
in the in-memory representation of this component typepublic void updateAttrGroup(dkAttrGroupDef attrGroupDef) throws DKException, java.lang.Exception
attrGroupDef
- attribute group object whose definition is to be updatedif
- the attribute group object does not exist in the in-memory
representation of this component typepublic dkCollection listAttrGroups() throws DKException, java.lang.Exception
if
- the component type name/identifier that those attribute groups belong is invalidpublic dkCollection listAttrGroups(int option) throws DKException, java.lang.Exception
if
- the component type name/identifier that those attribute groups belong is invalidpublic java.lang.String[] listAttrGroupNames() throws DKException, java.lang.Exception
if
- the component type name/identifier that those attributes belong is invalidpublic java.lang.String[] listAttrGroupNames(int option) throws DKException, java.lang.Exception
option
- - valid option values are:
if
- the component type name/identifier that those attributes belong is invalidpublic dkAttrGroupDef retrieveAttrGroup(java.lang.String attrGroupName) throws DKException, java.lang.Exception
name
- the name of the attribute group to be retrieved from the
persistent storepublic dkEntityDef getParent()
public void setParent(dkEntityDef parent)
parentEntity
- parent entity definitionpublic void setParentId(int parentEntityId)
parentEntityId
- component type identifier for the parent entity
of this component typepublic int getParentId()
public dkEntityDef retrieveParent() throws DKException, java.lang.Exception
public dkEntityDef createSubEntity() throws DKException, java.lang.Exception
createSubEntity
in class dkAbstractEntityDef
if
- this call does not result in the creation of a sub entitypublic void addSubEntity(dkEntityDef entityObj) throws DKAlreadyExistException, DKException, java.lang.Exception
addSubEntity
in class dkAbstractEntityDef
entityObj
- a new child component as an instance of DKComponentTypeDefICMif
- the child component type already exists as part of this entitypublic void removeSubEntity(java.lang.String compName) throws DKNotExistException, DKException
removeSubEntity
in class dkAbstractEntityDef
compName
- the component type name of the entity that needs to be removedif
- this direct child component type definition to be removed doesn't exist
in the in-memory representation of this component typepublic dkEntityDef getSubEntity(java.lang.String compName) throws DKException, java.lang.Exception
getSubEntity
in class dkAbstractEntityDef
compName
- name of the child component type to be retrievedif
- the child component type of the specified name does not
exist in-memory representation of this component typepublic void updateSubEntity(dkEntityDef subEntityDef) throws DKException, java.lang.Exception
subEntityDef
- the child component type object to be updated in the
in-memory representationif
- the component type object to be updated does not exist
in the memorypublic dkCollection listSubEntities() throws DKException, java.lang.Exception
listSubEntities
in class dkAbstractEntityDef
if
- error occurspublic dkCollection listSubEntities(int option) throws DKException, java.lang.Exception
option
- - valid option values are:
DKException
- if an error occurspublic java.lang.String[] listSubEntityNames() throws DKException, java.lang.Exception
listSubEntityNames
in class dkAbstractEntityDef
if
- an error occurspublic java.lang.String[] listSubEntityNames(int option) throws DKException, java.lang.Exception
option
- - valid values are:
if
- an error occurspublic dkEntityDef retrieveSubEntity(java.lang.String compName) throws DKException, java.lang.Exception
retrieveSubEntity
in class dkAbstractEntityDef
name
- the name of the child component type to be retrieved from the
persistent storeif
- an error occurspublic DKComponentTypeIndexDefICM getComponentTypeIndex(java.lang.String cpIndexName) throws DKException, java.lang.Exception
cpIndexName
- name of component type index to be retrievedif
- the component type index does not exist in the in-memory
representation of this component typepublic dkCollection listComponentTypeIndexes() throws DKException, java.lang.Exception
DKException
- if error occurspublic java.lang.String[] listComponentTypeIndexNames() throws DKException, java.lang.Exception
DKException
- if error occurspublic DKComponentTypeIndexDefICM retrieveComponentTypeIndex(java.lang.String indexName) throws DKException, java.lang.Exception
name
- the name of the component type index to be retrieved from the
persistent datastorepublic DKForeignKeyDefICM createForeignKey() throws DKException, java.lang.Exception
if
- this method call does not create a foreign keypublic void addForeignKey(DKForeignKeyDefICM fkey) throws DKAlreadyExistException, DKException, java.lang.Exception
fkey
- a foreing key object as an instance of DKForeignKeyDefICMif
- this foreign key already exists in this component typepublic void removeForeignKey(java.lang.String constraintName) throws DKNotExistException, DKException
constraintName
- - name of the foreing key that needs to be removedif
- this foreign key definition to be removed doesn't exist
in the in-memory representation of this component typepublic DKForeignKeyDefICM getForeignKey(java.lang.String constraintName) throws DKException, java.lang.Exception
constraintName
- - name of the foreing key to be retrievedif
- this foreign key definition with the given name doesn't exist
in the in-memory representation of this component typepublic void updateForeignKey(DKForeignKeyDefICM fkey) throws DKException, java.lang.Exception
fkey
- - foreing key object to be updated in the in-memory representationif
- the foreign key object doesn't exist in the in-memory
representation of this component typepublic dkCollection listForeignKeys() throws DKException, java.lang.Exception
if
- an error occurspublic java.lang.String[] listForeignKeyNames() throws DKException, java.lang.Exception
if
- an error occurspublic DKForeignKeyDefICM retrieveForeignKey(java.lang.String constraintName) throws DKException, java.lang.Exception
constraintName
- the constraint name of the foreign key
to be retrieved from the persistent storeif
- an error occurspublic void add() throws DKException, java.lang.Exception
add
in class dkAbstractEntityDef
when
- the subclass does not implement this methodpublic void del() throws DKException, java.lang.Exception
del
in class dkAbstractEntityDef
when
- the subclass does not implement this methodpublic void update() throws DKException, java.lang.Exception
when
- the subclass does not implement this methodpublic short getCardinalityMin()
public void setCardinalityMin(short cardinalityMin)
cardinalityMin
- minimum number of rows for this component typepublic short getCardinalityMax()
public void setCardinalityMax(short cardinalityMax)
cardinalityMax
- maximum number of rows for this component typepublic short getDeleteRule()
public void setDeleteRule(short deleteRule)
deleteRule
- - The valid values are:
public java.lang.String getDescription(java.lang.String langCode) throws DKException, java.lang.Exception
langCode,
- the language code for which the description is to be retrievedpublic void setDescription(java.lang.String desc, java.lang.String langCode) throws DKException, java.lang.Exception
langCode,
- the language code for this component type for the specified language codedesc,
- the value to set this component type's description to
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |