|
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 | +--com.ibm.mm.sdk.common.DKComponentTypeViewDefICM
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)
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.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 DKComponentTypeViewDefICM()
public DKComponentTypeViewDefICM(dkDatastore ds)
ds
- - teh ICM datastore as an instance of DKDatastoreICMpublic DKComponentTypeViewDefICM(DKComponentTypeViewDefICM cpView)
cpView
- component type view to be used as a template for
creating the new instanceMethod Detail |
public java.lang.Object clone()
clone
in class DKComponentTypeDefICM
public int getIntId()
getIntId
in class DKComponentTypeDefICM
public void setIntId(int id)
setIntId
in class DKComponentTypeDefICM
id
- integer based identifier to use to set the component type view
object identifierpublic int getComponentViewId()
getComponentViewId
in class DKComponentTypeDefICM
public int getItemTypeViewId()
public short getAccessModuleStatus()
public int getAccessModuleResult()
public short getAccessModuleVers()
public java.lang.String getPrevAccessModule()
public DKTimestamp getCreatedTimestamp()
public dkEntityDef createSubEntity() throws DKException, java.lang.Exception
createSubEntity
in class DKComponentTypeDefICM
DKException
- if this method call did not create a new sub entitypublic void add() throws DKException, java.lang.Exception
add
in class DKComponentTypeDefICM
DKException
- when an error is encounteredpublic void del() throws DKException, java.lang.Exception
del
in class DKComponentTypeDefICM
DKException
- when an error is encounteredpublic void update() throws DKException, java.lang.Exception
update
in class DKComponentTypeDefICM
DKException
- when an error is encounteredpublic boolean hasSubEntityViews() throws DKException, java.lang.Exception
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |