org.opencrx.kernel.model1.cci2
Interface Operation

All Superinterfaces:

AlertSender, Auditee, BasicObject, BehaviouralFeature, Cloneable, ContextCapable, Creatable, CrxObject, Element, Exporter, ExtentCapable, Feature, Importer, Indexed, LocalizedFieldContainer, Modifiable, Namespace, SecureObject

All Known Subinterfaces:

Operation

All Known Implementing Classes:

Operation

public interface Operation
extends BehaviouralFeature

Class Operation

An Operation defines a dynamic feature which offers a service. The behavior of an operation is activated through the invocation of the operation.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opencrx.kernel.model1.cci2.Element

Element.Identity

Method Summary

<T extends Exception> List<T>	getException() Retrieves the Collection of objects referenced by exception.
String	getSemantics() Retrieves the possibly null value for the optional attribute semantics.
String	getSignature() Retrieves the value for the attribute signature.
boolean	isQuery() Retrieves the value for the attribute isQuery.
void	setQuery(boolean isQuery) Sets a new value for the attribute isQuery.
void	setSemantics(String semantics) Sets a new value for the attribute semantics.

Methods inherited from interface org.opencrx.kernel.model1.cci2.Feature

getScope, getVisibility, setScope, setVisibility

Methods inherited from interface org.opencrx.kernel.model1.cci2.Namespace

deleteNamespace, getContent

Methods inherited from interface org.opencrx.kernel.model1.cci2.Element

getAnnotation, getContainer, getElementOrder, getName, getQualifiedName, getSegment, getStereotype, setAnnotation, setContainer, setElementOrder, setName, setQualifiedName, setStereotype

Methods inherited from interface org.opencrx.kernel.generic.cci2.CrxObject

getAdditionalExternalLink, getAssignedTimer, getAttachedDocument, getCategory, getDisabledReason, getDocumentFolderAssignment, getExternalLink, getMedia, getNote, getPropertySet, getPropertySetEntry, getRating, getUserBoolean4, getUserCode0, getUserCode1, getUserCode2, getUserCode3, getUserCode4, getUserDate0, getUserDate1, getUserDate2, getUserDate3, getUserDate4, getUserDateTime0, getUserDateTime1, getUserDateTime2, getUserDateTime3, getUserDateTime4, getUserNumber0, getUserNumber1, getUserNumber2, getUserNumber3, getUserNumber4, getUserString0, getUserString1, getUserString2, getUserString3, getUserString4, isDisabled, isUserBoolean0, isUserBoolean1, isUserBoolean2, isUserBoolean3, setCategory, setDisabled, setDisabledReason, setExternalLink, setUserBoolean0, setUserBoolean1, setUserBoolean2, setUserBoolean3, setUserBoolean4, setUserCode0, setUserCode1, setUserCode2, setUserCode3, setUserCode4, setUserDate0, setUserDate1, setUserDate2, setUserDate3, setUserDate4, setUserDateTime0, setUserDateTime1, setUserDateTime2, setUserDateTime3, setUserDateTime4, setUserNumber0, setUserNumber1, setUserNumber2, setUserNumber3, setUserNumber4, setUserString0, setUserString1, setUserString2, setUserString3, setUserString4

Methods inherited from interface org.opencrx.kernel.base.cci2.AlertSender

sendAlert

Methods inherited from interface org.opencrx.kernel.base.cci2.Auditee

getAudit

Methods inherited from interface org.opencrx.kernel.base.cci2.Cloneable

clone_

Methods inherited from interface org.opencrx.kernel.base.cci2.Exporter

exportItem, exportItemAdvanced

Methods inherited from interface org.opencrx.kernel.base.cci2.Importer

importItem

Methods inherited from interface org.opencrx.kernel.base.cci2.Indexed

getIndexEntry, updateIndex

Methods inherited from interface org.opencrx.kernel.base.cci2.SecureObject

addOwningGroup, checkPermissions, getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getOwner, getOwningGroup, getOwningUser, removeAllOwningGroup, removeOwningGroup, replaceOwningGroup, setAccessLevel, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate, setOwner, setOwningUser, setOwningUser

Methods inherited from interface org.opencrx.kernel.generic.cci2.LocalizedFieldContainer

getLocalizedField

Methods inherited from interface org.openmdx.base.cci2.Creatable

getCreatedAt, getCreatedBy

Methods inherited from interface org.openmdx.base.cci2.ExtentCapable

getIdentity

Methods inherited from interface org.openmdx.base.cci2.Modifiable

getModifiedAt, getModifiedBy

Method Detail

getException

<T extends Exception> List<T> getException()

Retrieves the Collection of objects referenced by exception.

Returns:

The Collection of referenced objects.

isQuery

boolean isQuery()

Retrieves the value for the attribute 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.

Returns:

The non-null value for attribute isQuery.

setQuery

void setQuery(boolean isQuery)

Sets a new value for the attribute 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.

Parameters:

isQuery - The non-null new value for attribute isQuery.

getSemantics

String getSemantics()

Retrieves the possibly null value for the optional attribute semantics.

Returns:

The possibly null value for attribute semantics.

setSemantics

void setSemantics(String semantics)

Sets a new value for the attribute semantics.

Parameters:

semantics - The possibly null new value for attribute semantics.

getSignature

String getSignature()

Retrieves the value for the attribute signature.

Returns:

The non-null value for attribute signature.