edu.uci.isr.xarch.messages
Interface IProductionRule

All Superinterfaces:

IXArchElement

All Known Implementing Classes:

ProductionRuleImpl

public interface IProductionRule

extends IXArchElement

Interface for accessing objects of the ProductionRule xsi:type in the messages namespace.

Author:

Automatically generated by xArch apigen

Field Summary

static XArchTypeMetadata

TYPE_METADATA

Fields inherited from interface edu.uci.isr.xarch.IXArchElement

DEPTH_INFINITY, DEPTH_ONE, DEPTH_ZERO

Method Summary

void	addReceiveMessage(IGenericMessage newReceiveMessage) Add a receiveMessage to this ProductionRule.
void	addReceiveMessages(Collection receiveMessages) Add a collection of receiveMessages to this ProductionRule.
void	addSendMessage(IGenericMessage newSendMessage) Add a sendMessage to this ProductionRule.
void	addSendMessages(Collection sendMessages) Add a collection of sendMessages to this ProductionRule.
void	clearCauseTime() Clear the causeTime from this ProductionRule.
void	clearDescription() Clear the description from this ProductionRule.
void	clearId() Remove the id attribute from this ProductionRule.
void	clearReceiveMessages() Remove all receiveMessages from this ProductionRule.
void	clearSendMessages() Remove all sendMessages from this ProductionRule.
Collection	getAllReceiveMessages() Get all the receiveMessages from this ProductionRule.
Collection	getAllSendMessages() Get all the sendMessages from this ProductionRule.
ICauseTime	getCauseTime() Get the causeTime from this ProductionRule.
IDescription	getDescription() Get the description from this ProductionRule.
String	getId() Get the id attribute from this ProductionRule.
IGenericMessage	getReceiveMessage(String id) Gets the receiveMessage from this ProductionRule with the given id.
Collection	getReceiveMessages(Collection ids) Gets the receiveMessages from this ProductionRule with the given ids.
IGenericMessage	getSendMessage(String id) Gets the sendMessage from this ProductionRule with the given id.
Collection	getSendMessages(Collection ids) Gets the sendMessages from this ProductionRule with the given ids.
boolean	hasAllReceiveMessages(Collection receiveMessagesToCheck) Determine if this ProductionRule contains each element in the given set of receiveMessages.
boolean	hasAllSendMessages(Collection sendMessagesToCheck) Determine if this ProductionRule contains each element in the given set of sendMessages.
boolean	hasCauseTime(ICauseTime causeTimeToCheck) Determine if this ProductionRule has the given causeTime
boolean	hasDescription(IDescription descriptionToCheck) Determine if this ProductionRule has the given description
boolean	hasId(String id) Determine if the id attribute on this ProductionRule has the given value.
boolean	hasReceiveMessage(IGenericMessage receiveMessageToCheck) Determine if this ProductionRule contains a given receiveMessage.
Collection	hasReceiveMessages(Collection receiveMessagesToCheck) Determine if this ProductionRule contains the given set of receiveMessages.
boolean	hasSendMessage(IGenericMessage sendMessageToCheck) Determine if this ProductionRule contains a given sendMessage.
Collection	hasSendMessages(Collection sendMessagesToCheck) Determine if this ProductionRule contains the given set of sendMessages.
boolean	isEqual(IProductionRule ProductionRuleToCheck) Determine if another ProductionRule has the same id as this one.
boolean	isEquivalent(IProductionRule ProductionRuleToCheck) Determine if another ProductionRule is equivalent to this one, ignoring ID's.
void	removeReceiveMessage(IGenericMessage receiveMessageToRemove) Remove the given receiveMessage from this ProductionRule.
void	removeReceiveMessages(Collection receiveMessages) Remove all the given receiveMessages from this ProductionRule.
void	removeSendMessage(IGenericMessage sendMessageToRemove) Remove the given sendMessage from this ProductionRule.
void	removeSendMessages(Collection sendMessages) Remove all the given sendMessages from this ProductionRule.
void	setCauseTime(ICauseTime value) Set the causeTime for this ProductionRule.
void	setDescription(IDescription value) Set the description for this ProductionRule.
void	setId(String id) Set the id attribute on this ProductionRule.

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

cloneElement, getInstanceMetadata, getTypeMetadata, getXArch, setXArch

Field Detail

TYPE_METADATA

public static final XArchTypeMetadata TYPE_METADATA

Method Detail

setId

public void setId(String id)

Set the id attribute on this ProductionRule.

Parameters:

id - id

Throws:

FixedValueException - if the attribute has a fixed value and the value passed is not the fixed value.

clearId

public void clearId()

Remove the id attribute from this ProductionRule.

getId

public String getId()

Get the id attribute from this ProductionRule. if the attribute has a fixed value, this function will return that fixed value, even if it is not actually present in the XML document.

Returns:

id on this ProductionRule

hasId

public boolean hasId(String id)

Determine if the id attribute on this ProductionRule has the given value.

Parameters:

id - Attribute value to compare

Returns:

true if they match; false otherwise.

setDescription

public void setDescription(IDescription value)

Set the description for this ProductionRule.

Parameters:

value - new description

clearDescription

public void clearDescription()

Clear the description from this ProductionRule.

getDescription

public IDescription getDescription()

Get the description from this ProductionRule.

Returns:

description

hasDescription

public boolean hasDescription(IDescription descriptionToCheck)

Determine if this ProductionRule has the given description

Parameters:

descriptionToCheck - description to compare

Returns:

true if the descriptions are equivalent, false otherwise

addReceiveMessage

public void addReceiveMessage(IGenericMessage newReceiveMessage)

Add a receiveMessage to this ProductionRule.

Parameters:

newReceiveMessage - receiveMessage to add.

addReceiveMessages

public void addReceiveMessages(Collection receiveMessages)

Add a collection of receiveMessages to this ProductionRule.

Parameters:

receiveMessages - receiveMessages to add.

clearReceiveMessages

public void clearReceiveMessages()

Remove all receiveMessages from this ProductionRule.

removeReceiveMessage

public void removeReceiveMessage(IGenericMessage receiveMessageToRemove)

Remove the given receiveMessage from this ProductionRule. Matching is done by the isEquivalent(...) function.

Parameters:

receiveMessageToRemove - receiveMessage to remove.

removeReceiveMessages

public void removeReceiveMessages(Collection receiveMessages)

Remove all the given receiveMessages from this ProductionRule. Matching is done by the isEquivalent(...) function.

Parameters:

receiveMessages - receiveMessage to remove.

getAllReceiveMessages

public Collection getAllReceiveMessages()

Get all the receiveMessages from this ProductionRule.

Returns:

all receiveMessages in this ProductionRule.

hasReceiveMessage

public boolean hasReceiveMessage(IGenericMessage receiveMessageToCheck)

Determine if this ProductionRule contains a given receiveMessage.

Returns:

true if this ProductionRule contains the given receiveMessageToCheck, false otherwise.

hasReceiveMessages

public Collection hasReceiveMessages(Collection receiveMessagesToCheck)

Determine if this ProductionRule contains the given set of receiveMessages.

Parameters:

receiveMessagesToCheck - receiveMessages to check for.

Returns:

Collection of java.lang.Boolean. If the i^th element in receiveMessages was found, then the i^th element of the collection will be set to true, otherwise it will be set to false. Matching is done with the isEquivalent(...) method.

hasAllReceiveMessages

public boolean hasAllReceiveMessages(Collection receiveMessagesToCheck)

Determine if this ProductionRule contains each element in the given set of receiveMessages.

Parameters:

receiveMessagesToCheck - receiveMessages to check for.

Returns:

true if every element in receiveMessages is found in this ProductionRule, false otherwise.

getReceiveMessage

public IGenericMessage getReceiveMessage(String id)

Gets the receiveMessage from this ProductionRule with the given id.

Parameters:

id - ID to look for.

Returns:

receiveMessage with the given ID, or null if not found.

getReceiveMessages

public Collection getReceiveMessages(Collection ids)

Gets the receiveMessages from this ProductionRule with the given ids.

Parameters:

ids - ID to look for.

Returns:

receiveMessages with the given IDs. If an element with a given ID was not found, that ID is ignored.

addSendMessage

public void addSendMessage(IGenericMessage newSendMessage)

Add a sendMessage to this ProductionRule.

Parameters:

newSendMessage - sendMessage to add.

addSendMessages

public void addSendMessages(Collection sendMessages)

Add a collection of sendMessages to this ProductionRule.

Parameters:

sendMessages - sendMessages to add.

clearSendMessages

public void clearSendMessages()

Remove all sendMessages from this ProductionRule.

removeSendMessage

public void removeSendMessage(IGenericMessage sendMessageToRemove)

Remove the given sendMessage from this ProductionRule. Matching is done by the isEquivalent(...) function.

Parameters:

sendMessageToRemove - sendMessage to remove.

removeSendMessages

public void removeSendMessages(Collection sendMessages)

Remove all the given sendMessages from this ProductionRule. Matching is done by the isEquivalent(...) function.

Parameters:

sendMessages - sendMessage to remove.

getAllSendMessages

public Collection getAllSendMessages()

Get all the sendMessages from this ProductionRule.

Returns:

all sendMessages in this ProductionRule.

hasSendMessage

public boolean hasSendMessage(IGenericMessage sendMessageToCheck)

Determine if this ProductionRule contains a given sendMessage.

Returns:

true if this ProductionRule contains the given sendMessageToCheck, false otherwise.

hasSendMessages

public Collection hasSendMessages(Collection sendMessagesToCheck)

Determine if this ProductionRule contains the given set of sendMessages.

Parameters:

sendMessagesToCheck - sendMessages to check for.

Returns:

Collection of java.lang.Boolean. If the i^th element in sendMessages was found, then the i^th element of the collection will be set to true, otherwise it will be set to false. Matching is done with the isEquivalent(...) method.

hasAllSendMessages

public boolean hasAllSendMessages(Collection sendMessagesToCheck)

Determine if this ProductionRule contains each element in the given set of sendMessages.

Parameters:

sendMessagesToCheck - sendMessages to check for.

Returns:

true if every element in sendMessages is found in this ProductionRule, false otherwise.

getSendMessage

public IGenericMessage getSendMessage(String id)

Gets the sendMessage from this ProductionRule with the given id.

Parameters:

id - ID to look for.

Returns:

sendMessage with the given ID, or null if not found.

getSendMessages

public Collection getSendMessages(Collection ids)

Gets the sendMessages from this ProductionRule with the given ids.

Parameters:

ids - ID to look for.

Returns:

sendMessages with the given IDs. If an element with a given ID was not found, that ID is ignored.

setCauseTime

public void setCauseTime(ICauseTime value)

Set the causeTime for this ProductionRule.

Parameters:

value - new causeTime

clearCauseTime

public void clearCauseTime()

Clear the causeTime from this ProductionRule.

getCauseTime

public ICauseTime getCauseTime()

Get the causeTime from this ProductionRule.

Returns:

causeTime

hasCauseTime

public boolean hasCauseTime(ICauseTime causeTimeToCheck)

Determine if this ProductionRule has the given causeTime

Parameters:

causeTimeToCheck - causeTime to compare

Returns:

true if the causeTimes are equivalent, false otherwise

isEqual

public boolean isEqual(IProductionRule ProductionRuleToCheck)

Determine if another ProductionRule has the same id as this one.

Parameters:

ProductionRuleToCheck - ProductionRule to compare with this one.

isEquivalent

public boolean isEquivalent(IProductionRule ProductionRuleToCheck)

Determine if another ProductionRule is equivalent to this one, ignoring ID's.

Parameters:

ProductionRuleToCheck - ProductionRule to compare to this one.

Returns:

true if all the child elements of this ProductionRule are equivalent, false otherwise.