org.hl7.rim

Interface CommunicationFunction

public interface CommunicationFunction extends RimObject, InfrastructureRoot

Interface for RIM class CommunicationFunction.

Relationship class binds the various entities which function in the transmission (sender, receiver, respond-to) to be linked to the transmission.

Method Summary
void	addEntity(Entity value) Adds an association 'entity' to RIM class Entity.
void	addTransmission(Transmission value) Adds an association 'transmission' to RIM class Transmission.
AssociationSet<Entity>	getEntity() Gets association 'entity' to RIM classes Entity with cardinality (1..*).
TEL	getTelecom() Gets attribute telecom of type TEL and cardinality 0..1.
AssociationSet<Transmission>	getTransmission() Gets association 'transmission' to RIM classes Transmission with cardinality (1..*).
CS	getTypeCode() Gets attribute typeCode of type CS and cardinality 0..1.
void	setEntity(AssociationSet<Entity> value) Sets associations 'entity' to RIM classes Entity with cardinality (1..*).
void	setTelecom(TEL value) Sets attribute telecom of type TEL and cardinality 0..1.
void	setTransmission(AssociationSet<Transmission> value) Sets associations 'transmission' to RIM classes Transmission with cardinality (1..*).
void	setTypeCode(CS value) Sets attribute typeCode of type CS and cardinality 0..1.

Method Detail

addEntity

public void addEntity(Entity value)

Adds an association 'entity' to RIM class Entity.

This relationship allows the entities playing the various communication functions to be identified.

Parameters: value the added association value

addTransmission

public void addTransmission(Transmission value)

Adds an association 'transmission' to RIM class Transmission.

This relation links a transmission to its sender, receiver, call-back party, etc.

Parameters: value the added association value

getEntity

public AssociationSet<Entity> getEntity()

Gets association 'entity' to RIM classes Entity with cardinality (1..*).

This relationship allows the entities playing the various communication functions to be identified.

Returns: the references to the linked classes

getTelecom

public TEL getTelecom()

Gets attribute telecom of type TEL and cardinality 0..1.

The telecomm address that can be used to reach the entity that is serving this function.

Returns: the attribute value

getTransmission

public AssociationSet<Transmission> getTransmission()

Gets association 'transmission' to RIM classes Transmission with cardinality (1..*).

This relation links a transmission to its sender, receiver, call-back party, etc.

Returns: the references to the linked classes

getTypeCode

public CS getTypeCode()

Gets attribute typeCode of type CS and cardinality 0..1.

The type of communication function being served by the entity with respect to the transmission, such as sender, receiver, respond-to party, etc.

Returns: the attribute value

setEntity

public void setEntity(AssociationSet<Entity> value)

Sets associations 'entity' to RIM classes Entity with cardinality (1..*).

This relationship allows the entities playing the various communication functions to be identified.

Parameters: value the new association values

setTelecom

public void setTelecom(TEL value)

Sets attribute telecom of type TEL and cardinality 0..1.

The telecomm address that can be used to reach the entity that is serving this function.

Parameters: value the new attribute value

setTransmission

public void setTransmission(AssociationSet<Transmission> value)

Sets associations 'transmission' to RIM classes Transmission with cardinality (1..*).

This relation links a transmission to its sender, receiver, call-back party, etc.

Parameters: value the new association values

setTypeCode

public void setTypeCode(CS value)

Sets attribute typeCode of type CS and cardinality 0..1.

The type of communication function being served by the entity with respect to the transmission, such as sender, receiver, respond-to party, etc.

Parameters: value the new attribute value