Index

DKComponentTypeViewDefICM

Purpose:

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).

See Also: DKComponentTypeDefICM, DKItemTypeViewDefICM

Since: Version 8

Class summary:

class DKEXPORT DKComponentTypeViewDefICM :                              public DKComponentTypeDefICM
 {
   public:
     DKComponentTypeViewDefICM();
     DKComponentTypeViewDefICM(dkDatastore* ds);
     DKComponentTypeViewDefICM(const DKComponentTypeViewDefICM& cpView);
     virtual ~DKComponentTypeViewDefICM();
     virtual long getIntId();
     virtual void setIntId(long compViewId);
     virtual long getComponentViewId();
     virtual long getItemTypeViewId();
     virtual void setParent(dkEntityDef* parent);
     virtual dkEntityDef* retrieveParent();
     short getSegmentId();
     void setSegmentId(short segmentId);
     DKString getAccessModuleName();
     short getAccessModuleStatus();
     long getAccessModuleResult();
     short getAccessModuleVers();
     DKString getPrevAccessModule();
     DKTimestamp getCreatedTimestamp();
     dkEntityDef* createSubEntity();
     virtual void add();
     virtual void del();
     virtual void update();
     virtual dkEntityDef* clone();
     DKBoolean hasSubEntityViews();
 };
 

Members:

Constructors and destructor
DKComponentTypeViewDefICM();

Default constructor for the component type view object. Constructs the definition of the component type view.

DKComponentTypeViewDefICM(dkDatastore* ds);

Constructs the definition of the component type view definition object for the given ICM datastore . Parameters: ds - the ICM datastore as an instance of DKDatastoreICM.

DKComponentTypeViewDefICM(const 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.

virtual ~DKComponentTypeViewDefICM();

Destructor for this object.

Member Functions

getIntId
Retrieves the integer identifier of the component type view definition object. Overrides: getIntId() in class DKComponentTypeDefICM. Returns: integer based identifier of the component type view definition object.
virtual long getIntID();

setIntId
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.
virtual void setIntID(long compViewId);

getComponentViewId
Retrieves the identifier for this component type view object. Overrides: getComponentViewId() in class DKComponentTypeDefICM. Returns: identifier for this component type view object.
virtual long getComponentViewId();

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.
virtual void setComponentViewId(long compViewId);

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.
virtual long getItemTypeViewId();

setParent
Sets parent component type view to the given entity. Parameters: parent - parent component type view of this entity. Throws: DKException if error occurs on the server.
virtual void setParent(dkEntityDef* parent)

retrieveParent
Retrieves parent component type view for this entity from datastore. Returns: The parent component type view definition object. If the Component View is the root a null is returned. Throws: DKException if error occurs on the server.
virtual dkEntityDef* retrieveParent();

getSegmentId
Gets segment ID. Returns: segment ID. Throws: DKException if error occurs on the server.
short getSegmentId();

setSegmentId
Sets segment ID to the given ID.
void setSegmentId short segmentId);

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.

DKString getAccessModuleName();

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. Returns: access module result.
long getAccessModuleResult();

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 generate a new access module. Returns: the new access module version.
short getAccessModuleVers();

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.
DKString getPrevAccessModule();

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.
DKTimestamp* getCreatedTimestamp();

setParent
Sets the Parent entity definition. Parameters: parentEntity parent component type view of this entity.
void setParent(dkEntityDef* parent);

createSubEntity
Creates a new child component view definition under this component view definition and returns it to the caller. Overrides: createSubEntity() in class DKComponentTypeDefICM. Returns: new definition of the 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.
virtual dkEntityDef* createSubEntity();

add
Adds this component type view definition to the persistent store. Overrides: add() in class DKComponentTypeDefICM. Throws: DKException - when an error is encountered.
virtual void add();

del
Deletes this component type view definition from the persistent store. Overrides: del() in class DKComponentTypeDefICM. Throws: DKException - when an error is encountered.
virtual void del();

update
Updates the entity definition for this component type view to entity in the persistent store. Overrides: update() in class DKComponentTypeDefICM. Throws: DKException - when an error is encountered.
virtual void update();

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.
virtual dkEntityDef* clone();

hasSubEntityViews
Returns true if this component type view has the child component type views under it, false otherwise.
DKBoolean hasSubEntityViews();

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