org.opencrx.kernel.model1.cci2.Operation Maven / Gradle / Ivy
// ----------------------------------------------------------------------------
// Instance/Begin
// ----------------------------------------------------------------------------
package org.opencrx.kernel.model1.cci2;
/**
* Class {@code Operation}
*
* An Operation defines a dynamic feature which offers a service. The behavior of an operation is activated through the invocation of the operation.
*/
@javax.annotation.Generated(
value = "org.openmdx.application.mof.mapping.java.InstanceMapper",
date = "2023-10-28T12:15:35.359663908Z",
comments = "Generated by openMDX 2.18.8 - DO NOT CHANGE MANUALLY"
)
public interface Operation
extends org.opencrx.kernel.model1.cci2.BehaviouralFeature{
// ----------------------------------------------------------------------------
// Instance/ReferenceGet0_nNoQuery
// ----------------------------------------------------------------------------
/**
* Retrieves the {@code Collection} of objects referenced by {@code exception}.
* @return The {@code Collection} of referenced objects.
*/
public java.util.List getException(
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet1_1
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the attribute {@code isQuery}.
*
* Defining an Operation with an isQuery value of true denotes that the behavior of the operation will not alter the state of the object. The state of a Classifier, for this definition, is the set of values of all of the Classifier's class-scope and instance-scope StructuralFeatures.
*
* For instance, an Operation of a Class, defined with a scope of instance, will not change the values or instances of any instance-scope StructuralFeature of the Class instance, as a result of invoking this Operation. An Operation of a Class with a
* scope of classifier will not change the values or instances of any of the classifier-scope StructuralFeatures or instance-scope StructuralFeatures.
*
* This attribute does not define a constraint enforced by the model, but rather a promise that the operation's implementation is expected to uphold. An operation which is not defined as isQuery equals false is not guaranteed to change the state of its object. The isQuery constraint does not proscribe any specific implementation, so long as the definition of isQuery above is observed.
*
* @return The non-null value for attribute {@code isQuery}.
*/
public boolean isQuery(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet1_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code isQuery}.
*
* Defining an Operation with an isQuery value of true denotes that the behavior of the operation will not alter the state of the object. The state of a Classifier, for this definition, is the set of values of all of the Classifier's class-scope and instance-scope StructuralFeatures.
*
* For instance, an Operation of a Class, defined with a scope of instance, will not change the values or instances of any instance-scope StructuralFeature of the Class instance, as a result of invoking this Operation. An Operation of a Class with a
* scope of classifier will not change the values or instances of any of the classifier-scope StructuralFeatures or instance-scope StructuralFeatures.
*
* This attribute does not define a constraint enforced by the model, but rather a promise that the operation's implementation is expected to uphold. An operation which is not defined as isQuery equals false is not guaranteed to change the state of its object. The isQuery constraint does not proscribe any specific implementation, so long as the definition of isQuery above is observed.
*
* @param isQuery The non-{@code null} new value for attribute {@code isQuery}.
*/
public void setQuery(
boolean isQuery
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet0_1
// ----------------------------------------------------------------------------
/**
* Retrieves the possibly null value for the optional attribute {@code semantics}.
* @return The possibly null value for attribute {@code semantics}.
*/
public java.lang.String getSemantics(
);
// ----------------------------------------------------------------------------
// Instance/AttributeSet0_1
// ----------------------------------------------------------------------------
/**
* Sets a new value for the attribute {@code semantics}.
* @param semantics The possibly null new value for attribute {@code semantics}.
*/
public void setSemantics(
java.lang.String semantics
);
// ----------------------------------------------------------------------------
// Instance/AttributeGet1_1
// ----------------------------------------------------------------------------
/**
* Retrieves the value for the attribute {@code signature}.
* @return The non-null value for attribute {@code signature}.
*/
public java.lang.String getSignature(
);
// ----------------------------------------------------------------------------
// Instance/End
// ----------------------------------------------------------------------------
}