org.da.protoframework.model.def

Class InterfaceDefinition

java.lang.Object

org.da.protoframework.model.def.InterfaceDefinition

All Implemented Interfaces:

org.da.protoframework.model.def.TopicsSubscriber

public abstract class InterfaceDefinition
extends java.lang.Object
implements org.da.protoframework.model.def.TopicsSubscriber

The definition for an interface.

Constructor Summary

Constructors

Constructor and Description
InterfaceDefinition()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttachEntryPoint() Return the interface attach / detach entry point.
org.da.protoframework.model.def.ChannelDefinition	getChannelDefinition() Return the Channel definition.
java.lang.String	getEntryPoint() Return the interface reception entry point.
java.lang.String	getFullName() Return the interface definition full name.
NamespaceKey	getKey() Return the interface key.
java.lang.String	getName() Return the interface name.
abstract ServiceDefinition	getService() Return the associated Service.
abstract boolean	isProvider() Return true if the Module which exposes this interface provides the interface, false if it is subscribed to this interface.
void	setAttachEntryPoint(java.lang.String entryPoint) Set the interface attach / detach entry point.
void	setChannelDefinition(org.da.protoframework.model.def.ChannelDefinition channelDef) Set the Channel definition.
void	setEntryPoint(java.lang.String entryPoint) Set the interface reception entry point.
abstract void	setService(ServiceDefinition service) Set the associated Service.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.da.protoframework.model.def.TopicsSubscriber

addSubscribedTopic, getSubscribedTopics, isSubscribedTo

Constructor Detail

InterfaceDefinition

public InterfaceDefinition()

Method Detail

getKey

public NamespaceKey getKey()

Return the interface key. It is the associated Service key.

Returns:

the interface Key

getFullName

public java.lang.String getFullName()

Return the interface definition full name. It will be the name of the element without the URI if it has no URI, or the name concatenated with the URI if it has a URI. For example:

• "theService"
• "http://my.uri:theService"

Returns:

the element full name

getName

public java.lang.String getName()

Return the interface name. It is the associated Service name. Note that this name does not take into account the namespace if the service has a namespace. To take the namespace into accont, you can use the getFullName() method.

Returns:

the interface name

isProvider

public abstract boolean isProvider()

Return true if the Module which exposes this interface provides the interface, false if it is subscribed to this interface.

Returns:

true if the Module which exposes this interface provides the interface

getService

public abstract ServiceDefinition getService()

Return the associated Service.

Returns:

the associated Service

setService

public abstract void setService(ServiceDefinition service)

Set the associated Service.

Parameters:

service - the Service

setChannelDefinition

public void setChannelDefinition(org.da.protoframework.model.def.ChannelDefinition channelDef)

Set the Channel definition.

Parameters:

channelDef - the Channel definition

getChannelDefinition

public org.da.protoframework.model.def.ChannelDefinition getChannelDefinition()

Return the Channel definition.

Returns:

the Channel definition

setEntryPoint

public void setEntryPoint(java.lang.String entryPoint)

Set the interface reception entry point.

Parameters:

entryPoint - the entry point

getEntryPoint

public java.lang.String getEntryPoint()

Return the interface reception entry point.

Returns:

the entry point

setAttachEntryPoint

public void setAttachEntryPoint(java.lang.String entryPoint)

Set the interface attach / detach entry point.

Parameters:

entryPoint - the attach / detach entry point

getAttachEntryPoint

public java.lang.String getAttachEntryPoint()

Return the interface attach / detach entry point.

Returns:

the attach / detach entry point