KnowledgeInterfaces Interface CATICkeNaming

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATICkeNaming

Interface dedicated to Knowledge relations naming.
Role: Parameters can be valuated by such an object.
It is implemented on relations.
The name is used to be shown to a user (it can be changed by user)
The comment gives an explanation of it (it can be changed by user)
The type of the object can not be changed


Method Index


o IsConst()
Indicates if this object is const or not.
o IsHidden()
Is this object hidden or shown.
o SetConst(CATCke::Boolean)
Sets Const facet.
o SetHidden(CATCke::Boolean)
Sets HideShow facet.
o SetUserAccess(CATICkeNaming::UserAccessMode)
Sets the rights on this naming object.
o Type()
Returns the type of this object.
o UserAccess()
Returns the rights on this naming object.

Enumerated Type Index


o UserAccessMode
Rights defined on a naming object.

Methods


o IsConst
public virtual IsConst()
Indicates if this object is const or not. Default value is always not Const
Returns:
Legal values: CATCke::True if it is constant CATCke::False if it isn't.
o IsHidden
public virtual IsHidden()
Is this object hidden or shown. Default value is always Shown
Returns:

Legal values: CATCke::True if it is hidden CATCke::False if it isn't.
o SetConst
public virtual SetConst( const iConstant)
Sets Const facet. Default value is always not Const
Parameters:
iConstant
Legal values: CATCke::True if it is constant CATCke::False if it isn't.
o SetHidden
public virtual SetHidden( const iHidden)
Sets HideShow facet. Default value is always Shown
Parameters:
iHidden

Legal values: CATCke::True if it is hidden CATCke::False if it isn't.
o SetUserAccess
public virtual SetUserAccess( const iRights)
Sets the rights on this naming object.
Parameters:
iRights:
the rights
Legal values: NotSeen this relation is not seen by the user. ReadOnly Default value : the relation will be seen but wont be modified ReadWrite the relation object can be modified, deactivated User the relation can be modified or destroyed by end user
o Type
public virtual Type()
Returns the type of this object.
o UserAccess
public virtual UserAccess()
Returns the rights on this naming object.
Legal values: NotSeen this relation is not seen by the user. ReadOnly Default value : the relation will be seen but wont be modified ReadWrite the relation object can be modified, deactivated User the relation can be modified or destroyed by end user

Enumerated Types


o UserAccessMode
enum UserAccessMode {
  NotSeen,
  ReadOnly,
  ReadWrite,
  User
}
Rights defined on a naming object. Used to define how this object can be used through Knowledgeware.

Legal values: NotSeen this relation is not seen by the user. ReadOnly Default value : the relation will be seen but wont be modified ReadWrite the relation object can be modified, deactivated User the relation can be modified or destroyed by end user LockType the Type of Feature accepted in the list can not be modified or destroyed by end user

This object is included in the file: CATICkeNaming.h
If needed, your Imakefile.mk should include the module: KnowledgeItf

Copyright © 1999-2015, Dassault Systèmes. All rights reserved.