org.opencrx.kernel.model1.jpa3
Class Operation

java.lang.Object
  org.w3c.jpa3.AbstractObject
      org.opencrx.kernel.model1.jpa3.Element
          org.opencrx.kernel.model1.jpa3.Operation

All Implemented Interfaces:

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

public class Operation
extends Element
implements Operation

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.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.w3c.jpa3.AbstractObject

org.w3c.jpa3.AbstractObject.AbstractStateAccessor, org.w3c.jpa3.AbstractObject.EmbeddedList<E>, org.w3c.jpa3.AbstractObject.EmbeddedSet<E>, org.w3c.jpa3.AbstractObject.ObjectState, org.w3c.jpa3.AbstractObject.SlicedList<E,S>, org.w3c.jpa3.AbstractObject.SlicedMap<E,S>, org.w3c.jpa3.AbstractObject.SlicedSet<E,S>

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

Element.Identity

Field Summary

String

signature Attribute signature.

Fields inherited from class org.opencrx.kernel.model1.jpa3.Element

createdAt, identity, modifiedAt

Constructor Summary

Operation()
Constructor

Method Summary

Void	deleteNamespace()
<T extends Element> NamespaceContainsElement.Content<T>	getContent() Retrieves a set containing all the elements for the reference content.
List<String>	getException_Id()
<T extends Exception> List<T>	getException() Retrieves the Collection of objects referenced by exception.
short	getScope() Retrieves the value for the attribute scope.
String	getSemantics() Retrieves the possibly null value for the optional attribute semantics.
String	getSignature() Retrieves the value for the attribute signature.
short	getVisibility() Retrieves the value for the attribute visibility.
boolean	isQuery() Retrieves the value for the attribute isQuery.
void	setQuery(boolean isQuery) Sets a new value for the attribute isQuery.
void	setScope(short scope) Sets a new value for the attribute scope.
void	setSemantics(String semantics) Sets a new value for the attribute semantics.
void	setVisibility(short visibility) Sets a new value for the attribute visibility.

Methods inherited from class org.opencrx.kernel.model1.jpa3.Element

addOwningGroup, checkPermissions, clone_, exportItem, exportItemAdvanced, getAccessGrantedByParent_Id, getAccessGrantedByParent, getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getAdditionalExternalLink, getAnnotation, getAttachedDocument, getAudit, getCategory, getContainer_Id, getContainer, getContext, getCreatedAt, getCreatedBy, getDisabledReason, getDocumentFolderAssignment, getElementOrder, getExternalLink, getIdentity, getIndexEntry, getMedia, getModifiedAt, getModifiedBy, getName, getNote, getOpenmdxjdoIdentity, getOwner, getOwningGroup_Id, getOwningGroup, getOwningUser_Id, getOwningUser, getPropertySet, getPropertySetEntry, getQualifiedName, getRating, getSegment_Id, getSegment, getStereotype, 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, importItem, isDisabled, isUserBoolean0, isUserBoolean1, isUserBoolean2, isUserBoolean3, openmdxjdoGetSlices, removeAllOwningGroup, removeOwningGroup, replaceOwningGroup, sendAlert, setAccessLevel, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate, setAnnotation, setCategory, setContainer_Id, setContainer, setDisabled, setDisabledReason, setElementOrder, setExternalLink, setName, setOpenmdxjdoIdentity, setOwner, setOwningUser_Id, setOwningUser, setOwningUser, setQualifiedName, setSegment_Id, setSegment, setStereotype, 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, updateIndex

Methods inherited from class org.w3c.jpa3.AbstractObject

openmdxjdoMakeDirty, openmdxjdoSetArray, openmdxjdoSetCollection, openmdxjdoToArray, openmdxjdoToArray

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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, 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, getAccessGrantedByParent, getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getOwner, getOwningGroup, getOwningUser, removeAllOwningGroup, removeOwningGroup, replaceOwningGroup, setAccessLevel, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate, setOwner, setOwningUser, setOwningUser

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

getContext

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

Field Detail

signature

public String signature

Attribute signature.

Constructor Detail

Operation

public Operation()

Constructor

Method Detail

getVisibility

public short getVisibility()

Retrieves the value for the attribute visibility.

In the future, this Attribute will be used to limit the ability of Elements outside of this Feature?s container to make use of it. The rules of visibility of MOF Elements are not currently specified.

Specified by:

getVisibility in interface Feature

Returns:

The non-null value for attribute visibility.

setVisibility

public void setVisibility(short visibility)

Sets a new value for the attribute visibility.

In the future, this Attribute will be used to limit the ability of Elements outside of this Feature?s container to make use of it. The rules of visibility of MOF Elements are not currently specified.

Specified by:

setVisibility in interface Feature

Parameters:

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

getException

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

Retrieves the Collection of objects referenced by exception.

Specified by:

getException in interface Operation

Returns:

The Collection of referenced objects.

getException_Id

public List<String> getException_Id()

deleteNamespace

public Void deleteNamespace()

Specified by:

deleteNamespace in interface Namespace

getSemantics

public final String getSemantics()

Retrieves the possibly null value for the optional attribute semantics.

Specified by:

getSemantics in interface Operation

Returns:

The possibly null value for attribute semantics.

setSemantics

public void setSemantics(String semantics)

Sets a new value for the attribute semantics.

Specified by:

setSemantics in interface Operation

Parameters:

semantics - The possibly null new value for attribute semantics.

getSignature

public String getSignature()

Retrieves the value for the attribute signature.

Specified by:

getSignature in interface Operation

Returns:

The non-null value for attribute signature.

getContent

public <T extends Element> NamespaceContainsElement.Content<T> getContent()

Retrieves a set containing all the elements for the reference content.

Specified by:

getContent in interface Namespace

Returns:

A set containing all the elements for this reference.

getScope

public short getScope()

Retrieves the value for the attribute scope.

The scope defines whether a Feature supports the definition of instances of the Classifier owning the Feature or of the Classifier as a whole. When scope is instanceLevel, the Feature is accessed through instances of the Feature's owning Classifier; when scope is classifier, the Feature is accessed through the Classifier itself (or through its instances). For StructuralFeatures, a scope of instanceLevel indicates that a value represented by the StructuralFeature is associated with each instance of the Classifier; a scope of classifierLevel indicates that the StructuralFeature value is shared by the Classifier and all its instances.

Specified by:

getScope in interface Feature

Returns:

The non-null value for attribute scope.

setScope

public void setScope(short scope)

Sets a new value for the attribute scope.

The scope defines whether a Feature supports the definition of instances of the Classifier owning the Feature or of the Classifier as a whole. When scope is instanceLevel, the Feature is accessed through instances of the Feature's owning Classifier; when scope is classifier, the Feature is accessed through the Classifier itself (or through its instances). For StructuralFeatures, a scope of instanceLevel indicates that a value represented by the StructuralFeature is associated with each instance of the Classifier; a scope of classifierLevel indicates that the StructuralFeature value is shared by the Classifier and all its instances.

Specified by:

setScope in interface Feature

Parameters:

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

isQuery

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

Specified by:

isQuery in interface Operation

Returns:

The non-null value for attribute isQuery.

setQuery

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

Specified by:

setQuery in interface Operation

Parameters:

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