de.mid.innovator.srv2api.icw2class
Interface CLClass

All Superinterfaces:

ADAccessAble, ADClientAble, ADFindAble, ADHistoryAble, ADLockAble, ADM2AttrModifyAble, ADOptionAble, ADReferenceAble, ADVersionAble, CLBehavioredClassifier, CLClassifier, CLDeclarationAble, CLDeclarationAbleClassifier, CLEncapsulatedClassifier, CLStructuredClassifier, CLTemplateAbleElement, CLTemplateParameterAbleElement, ELClassifier, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELNamedElement, ELNamespaceAble, ELNamespaceAsgnAble, ELObject, ELPackageAble, ELRedefAble, ELType, ELUUIDAble, ELValueContainerAble, MECommentAble, MEConstraintAble, MEModelElement, MENamedElement, MENamespaceAble, MENamespaceAsgnAble, MEPackageAble, MEStereotypeAble, MMAttachmentAble, MMCommentContainerAble, MMLabelAble, MMLabelTextAttachmentAble, MMStereotypeAble, MMTextAble

All Known Subinterfaces:

ACActivity, BEBehavior, BEOpaque, CLAssocClass, CLComponent, CLDevice, CLExecEnv, CLNode, CLTemplateParameterAbleClass, IAInteraction, SMProtocolStateMachine, SMStateMachine

public interface CLClass
extends MEPackageAble, CLDeclarationAbleClassifier, CLBehavioredClassifier, CLEncapsulatedClassifier

The purpose of a class is to specify a classification of objects and to specify the features that characterize the structure and behavior of those objects. Class is a kind of classifier whose features are attributes and operations. Attributes of a class are represented by instances of property that are owned by the class. Some of these attributes may represent the navigable ends of binary associations. A class acts as the namespace for various kinds of classifiers defined within its scope, including classes. Nesting of classifiers limits the visibility of the classifier to within the scope of the namespace of the containing class and is used for hiding information. Nested classifiers are used like any other classifier in the containing class. A class may be designated as active, i.e., each of its instances has its own thread of control, or passive, i.e., each of its instances execute within the context of some other object. A class may also specify which signals the instances of this class handle.

See Also:

CLClassHelper

getNestedClassifier

<T extends CLClassifier> List<T> getNestedClassifier(Class<T> returnType,
                                                     K_CONTROL_OPTION... behaviourFlags)
                                                 throws InoNetException,
                                                        SrvErrorException

References all the classifiers that are defined (nested) within the class.

Parameters:

returnType - Specifies the type of elements to be returned.

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted.

getOwnedAttribute

<T extends CLProperty> List<T> getOwnedAttribute(Class<T> returnType,
                                                 K_CONTROL_OPTION... behaviourFlags)
                                             throws InoNetException,
                                                    SrvErrorException

The attributes (i.e. the properties) owned by this class.

Parameters:

returnType - Specifies the type of elements to be returned.

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

Sorted:

the result may sorted.

getOwnedOperation

List<CLOperation> getOwnedOperation(K_CONTROL_OPTION... behaviourFlags)
                                    throws InoNetException,
                                           SrvErrorException

The operations owned by the class.

Parameters:

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

Sorted:

The result may be sorted.

getOwnedReception

List<CLReception> getOwnedReception(K_CONTROL_OPTION... behaviourFlags)
                                    throws InoNetException,
                                           SrvErrorException

Receptions that objects of this class are willing to accept.

Parameters:

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

Sorted:

the result may be sorted.

isActive

boolean isActive()
                 throws InoNetException,
                        SrvErrorException

Determines whether an object specified by this class is active or not. If true, the owning class is referred to as an active class. If false, such a class is referred to as a passive class.

Throws:

InoNetException

SrvErrorException

setActive

void setActive(boolean value)
               throws InoNetException,
                      SrvErrorException

Set the value of Attribut IsActive.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException