edu.uci.isr.xarch.messages
Interface IMessagesContext

All Superinterfaces:

IXArchContext

All Known Implementing Classes:

MessagesContext

public interface IMessagesContext

extends IXArchContext

The context interface for the messages package. This interface is used to create objects that are used in the messages namespace.

Author:

Automatically Generated by xArch apigen

Field Summary

static XArchTypeMetadata

TYPE_METADATA

Method Summary

ICauseTime	createCauseTime() Create an ICauseTime object in this namespace.
ICount	createCount() Create an ICount object in this namespace.
IDescription	createDescription() Create an edu.uci.isr.xarch.instance.IDescription object in this namespace.
IGenericMessage	createGenericMessage() Create an IGenericMessage object in this namespace.
IKind	createKind() Create an IKind object in this namespace.
IMessageCausalitySpecification	createMessageCausalitySpecification() Create an IMessageCausalitySpecification object in this namespace.
IMessageName	createMessageName() Create an IMessageName object in this namespace.
IMessageType	createMessageType() Create an IMessageType object in this namespace.
INamedProperty	createNamedProperty() Create an INamedProperty object in this namespace.
INamedPropertyMessage	createNamedPropertyMessage() Create an INamedPropertyMessage object in this namespace.
IProductionRule	createProductionRule() Create an IProductionRule object in this namespace.
IPropertyName	createPropertyName() Create an IPropertyName object in this namespace.
IPropertyValue	createPropertyValue() Create an IPropertyValue object in this namespace.
IRuleSpecification	createRuleSpecification() Create an IRuleSpecification object in this namespace.
IRuleSpecification	createRuleSpecificationElement() Create a top-level element of type IRuleSpecification.
IVariantComponentTypeImplVersSpec	createVariantComponentTypeImplVersSpec() Create an IVariantComponentTypeImplVersSpec object in this namespace.
IVariantConnectorTypeImplVersSpec	createVariantConnectorTypeImplVersSpec() Create an IVariantConnectorTypeImplVersSpec object in this namespace.
IXMLLink	createXMLLink() Create an edu.uci.isr.xarch.instance.IXMLLink object in this namespace.
Collection	getAllRuleSpecifications(IXArch xArch) Gets all the IRuleSpecification children from the given IXArch element.
IRuleSpecification	getRuleSpecification(IXArch xArch) Gets the IRuleSpecification child from the given IXArch element.
INamedPropertyMessage	promoteToNamedPropertyMessage(IGenericMessage value) Promote an object of type IGenericMessage to one of type INamedPropertyMessage.
IVariantComponentTypeImplVersSpec	promoteToVariantComponentTypeImplVersSpec(IVariantComponentTypeImplVers value) Promote an object of type edu.uci.isr.xarch.versions.IVariantComponentTypeImplVers to one of type IVariantComponentTypeImplVersSpec.
IVariantConnectorTypeImplVersSpec	promoteToVariantConnectorTypeImplVersSpec(IVariantConnectorTypeImplVers value) Promote an object of type edu.uci.isr.xarch.versions.IVariantConnectorTypeImplVers to one of type IVariantConnectorTypeImplVersSpec.
ICauseTime	recontextualizeCauseTime(ICauseTime value) Brings an ICauseTime object created in another context into this context.
ICount	recontextualizeCount(ICount value) Brings an ICount object created in another context into this context.
IDescription	recontextualizeDescription(IDescription value) Brings an edu.uci.isr.xarch.instance.IDescription object created in another context into this context.
IGenericMessage	recontextualizeGenericMessage(IGenericMessage value) Brings an IGenericMessage object created in another context into this context.
IKind	recontextualizeKind(IKind value) Brings an IKind object created in another context into this context.
IMessageCausalitySpecification	recontextualizeMessageCausalitySpecification(IMessageCausalitySpecification value) Brings an IMessageCausalitySpecification object created in another context into this context.
IMessageName	recontextualizeMessageName(IMessageName value) Brings an IMessageName object created in another context into this context.
IMessageType	recontextualizeMessageType(IMessageType value) Brings an IMessageType object created in another context into this context.
INamedProperty	recontextualizeNamedProperty(INamedProperty value) Brings an INamedProperty object created in another context into this context.
INamedPropertyMessage	recontextualizeNamedPropertyMessage(INamedPropertyMessage value) Brings an INamedPropertyMessage object created in another context into this context.
IProductionRule	recontextualizeProductionRule(IProductionRule value) Brings an IProductionRule object created in another context into this context.
IPropertyName	recontextualizePropertyName(IPropertyName value) Brings an IPropertyName object created in another context into this context.
IPropertyValue	recontextualizePropertyValue(IPropertyValue value) Brings an IPropertyValue object created in another context into this context.
IRuleSpecification	recontextualizeRuleSpecification(IRuleSpecification value) Brings an IRuleSpecification object created in another context into this context.
IVariantComponentTypeImplVersSpec	recontextualizeVariantComponentTypeImplVersSpec(IVariantComponentTypeImplVersSpec value) Brings an IVariantComponentTypeImplVersSpec object created in another context into this context.
IVariantConnectorTypeImplVersSpec	recontextualizeVariantConnectorTypeImplVersSpec(IVariantConnectorTypeImplVersSpec value) Brings an IVariantConnectorTypeImplVersSpec object created in another context into this context.
IXMLLink	recontextualizeXMLLink(IXMLLink value) Brings an edu.uci.isr.xarch.instance.IXMLLink object created in another context into this context.

Methods inherited from interface edu.uci.isr.xarch.IXArchContext

getTypeMetadata, getXArch

Field Detail

TYPE_METADATA

public static final XArchTypeMetadata TYPE_METADATA

Method Detail

createKind

public IKind createKind()

Create an IKind object in this namespace.

Returns:

New IKind object.

recontextualizeKind

public IKind recontextualizeKind(IKind value)

Brings an IKind object created in another context into this context.

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createRuleSpecification

public IRuleSpecification createRuleSpecification()

Create an IRuleSpecification object in this namespace.

Returns:

New IRuleSpecification object.

recontextualizeRuleSpecification

public IRuleSpecification recontextualizeRuleSpecification(IRuleSpecification value)

Brings an IRuleSpecification object created in another context into this context.

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createDescription

public IDescription createDescription()

Create an edu.uci.isr.xarch.instance.IDescription object in this namespace.

Returns:

New edu.uci.isr.xarch.instance.IDescription object.

recontextualizeDescription

public IDescription recontextualizeDescription(IDescription value)

Brings an edu.uci.isr.xarch.instance.IDescription object created in another context into this context.

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createProductionRule

public IProductionRule createProductionRule()

Create an IProductionRule object in this namespace.

Returns:

New IProductionRule object.

recontextualizeProductionRule

public IProductionRule recontextualizeProductionRule(IProductionRule value)

Brings an IProductionRule object created in another context into this context.

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createVariantComponentTypeImplVersSpec

public IVariantComponentTypeImplVersSpec createVariantComponentTypeImplVersSpec()

Create an IVariantComponentTypeImplVersSpec object in this namespace.

Returns:

New IVariantComponentTypeImplVersSpec object.

recontextualizeVariantComponentTypeImplVersSpec

public IVariantComponentTypeImplVersSpec recontextualizeVariantComponentTypeImplVersSpec(IVariantComponentTypeImplVersSpec value)

Brings an IVariantComponentTypeImplVersSpec object created in another context into this context.

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

promoteToVariantComponentTypeImplVersSpec

public IVariantComponentTypeImplVersSpec promoteToVariantComponentTypeImplVersSpec(IVariantComponentTypeImplVers value)

Promote an object of type edu.uci.isr.xarch.versions.IVariantComponentTypeImplVers to one of type IVariantComponentTypeImplVersSpec. xArch APIs are structured in such a way that a regular cast is not possible to change interface types, so casting must be done through these promotion functions. If the edu.uci.isr.xarch.versions.IVariantComponentTypeImplVers object wraps a DOM element that is the base type, then the xsi:type of the base element is promoted. Otherwise, it is left unchanged. This function also emits an XArchEvent with type PROMOTE_TYPE. The source for this events is the pre-promoted IXArchElement object (should no longer be used), and the target is the post-promotion object. The target name is the name of the interface class that was the target of the promotion.

Parameters:

value - Object to promote.

Returns:

Promoted object.

createVariantConnectorTypeImplVersSpec

public IVariantConnectorTypeImplVersSpec createVariantConnectorTypeImplVersSpec()

Create an IVariantConnectorTypeImplVersSpec object in this namespace.

Returns:

New IVariantConnectorTypeImplVersSpec object.

recontextualizeVariantConnectorTypeImplVersSpec

public IVariantConnectorTypeImplVersSpec recontextualizeVariantConnectorTypeImplVersSpec(IVariantConnectorTypeImplVersSpec value)

Brings an IVariantConnectorTypeImplVersSpec object created in another context into this context.

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

promoteToVariantConnectorTypeImplVersSpec

public IVariantConnectorTypeImplVersSpec promoteToVariantConnectorTypeImplVersSpec(IVariantConnectorTypeImplVers value)

Promote an object of type edu.uci.isr.xarch.versions.IVariantConnectorTypeImplVers to one of type IVariantConnectorTypeImplVersSpec. xArch APIs are structured in such a way that a regular cast is not possible to change interface types, so casting must be done through these promotion functions. If the edu.uci.isr.xarch.versions.IVariantConnectorTypeImplVers object wraps a DOM element that is the base type, then the xsi:type of the base element is promoted. Otherwise, it is left unchanged. This function also emits an XArchEvent with type PROMOTE_TYPE. The source for this events is the pre-promoted IXArchElement object (should no longer be used), and the target is the post-promotion object. The target name is the name of the interface class that was the target of the promotion.

Parameters:

value - Object to promote.

Returns:

Promoted object.

createMessageCausalitySpecification

public IMessageCausalitySpecification createMessageCausalitySpecification()

Create an IMessageCausalitySpecification object in this namespace.

Returns:

New IMessageCausalitySpecification object.

recontextualizeMessageCausalitySpecification

public IMessageCausalitySpecification recontextualizeMessageCausalitySpecification(IMessageCausalitySpecification value)

Brings an IMessageCausalitySpecification object created in another context into this context.

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createXMLLink

public IXMLLink createXMLLink()

Create an edu.uci.isr.xarch.instance.IXMLLink object in this namespace.

Returns:

New edu.uci.isr.xarch.instance.IXMLLink object.

recontextualizeXMLLink

public IXMLLink recontextualizeXMLLink(IXMLLink value)

Brings an edu.uci.isr.xarch.instance.IXMLLink object created in another context into this context.

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createGenericMessage

public IGenericMessage createGenericMessage()

Create an IGenericMessage object in this namespace.

Returns:

New IGenericMessage object.

recontextualizeGenericMessage

public IGenericMessage recontextualizeGenericMessage(IGenericMessage value)

Brings an IGenericMessage object created in another context into this context.

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createNamedPropertyMessage

public INamedPropertyMessage createNamedPropertyMessage()

Create an INamedPropertyMessage object in this namespace.

Returns:

New INamedPropertyMessage object.

recontextualizeNamedPropertyMessage

public INamedPropertyMessage recontextualizeNamedPropertyMessage(INamedPropertyMessage value)

Brings an INamedPropertyMessage object created in another context into this context.

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

promoteToNamedPropertyMessage

public INamedPropertyMessage promoteToNamedPropertyMessage(IGenericMessage value)

Promote an object of type IGenericMessage to one of type INamedPropertyMessage. xArch APIs are structured in such a way that a regular cast is not possible to change interface types, so casting must be done through these promotion functions. If the IGenericMessage object wraps a DOM element that is the base type, then the xsi:type of the base element is promoted. Otherwise, it is left unchanged. This function also emits an XArchEvent with type PROMOTE_TYPE. The source for this events is the pre-promoted IXArchElement object (should no longer be used), and the target is the post-promotion object. The target name is the name of the interface class that was the target of the promotion.

Parameters:

value - Object to promote.

Returns:

Promoted object.

createCount

public ICount createCount()

Create an ICount object in this namespace.

Returns:

New ICount object.

recontextualizeCount

public ICount recontextualizeCount(ICount value)

Brings an ICount object created in another context into this context.

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createMessageName

public IMessageName createMessageName()

Create an IMessageName object in this namespace.

Returns:

New IMessageName object.

recontextualizeMessageName

public IMessageName recontextualizeMessageName(IMessageName value)

Brings an IMessageName object created in another context into this context.

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createMessageType

public IMessageType createMessageType()

Create an IMessageType object in this namespace.

Returns:

New IMessageType object.

recontextualizeMessageType

public IMessageType recontextualizeMessageType(IMessageType value)

Brings an IMessageType object created in another context into this context.

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createCauseTime

public ICauseTime createCauseTime()

Create an ICauseTime object in this namespace.

Returns:

New ICauseTime object.

recontextualizeCauseTime

public ICauseTime recontextualizeCauseTime(ICauseTime value)

Brings an ICauseTime object created in another context into this context.

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createNamedProperty

public INamedProperty createNamedProperty()

Create an INamedProperty object in this namespace.

Returns:

New INamedProperty object.

recontextualizeNamedProperty

public INamedProperty recontextualizeNamedProperty(INamedProperty value)

Brings an INamedProperty object created in another context into this context.

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createPropertyName

public IPropertyName createPropertyName()

Create an IPropertyName object in this namespace.

Returns:

New IPropertyName object.

recontextualizePropertyName

public IPropertyName recontextualizePropertyName(IPropertyName value)

Brings an IPropertyName object created in another context into this context.

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createPropertyValue

public IPropertyValue createPropertyValue()

Create an IPropertyValue object in this namespace.

Returns:

New IPropertyValue object.

recontextualizePropertyValue

public IPropertyValue recontextualizePropertyValue(IPropertyValue value)

Brings an IPropertyValue object created in another context into this context.

Parameters:

value - Object to recontextualize.

Returns:

value object in this namespace.

createRuleSpecificationElement

public IRuleSpecification createRuleSpecificationElement()

Create a top-level element of type IRuleSpecification. This function should be used in lieu of createRuleSpecification if the element is to be added as a sub-object of IXArch.

Returns:

new IRuleSpecification suitable for adding as a child of xArch.

getRuleSpecification

public IRuleSpecification getRuleSpecification(IXArch xArch)

Gets the IRuleSpecification child from the given IXArch element. If there are multiple matching children, this returns the first one.

Parameters:

xArch - IXArch object from which to get the child.

Returns:

IRuleSpecification that is the child of xArch or null if no such object exists.

getAllRuleSpecifications

public Collection getAllRuleSpecifications(IXArch xArch)

Gets all the IRuleSpecification children from the given IXArch element.

Parameters:

xArch - IXArch object from which to get the children.

Returns:

Collection of IRuleSpecification that are the children of xArch or an empty collection if no such object exists.