ServiceDefinition (Protoframework API)

All Superinterfaces:

org.da.protoframework.model.def.DescriptedElement, ElementDefinition, NamespaceElement, org.da.protoframework.model.def.NamespaceElementDefinition
```
public interface ServiceDefinition
extends org.da.protoframework.model.def.NamespaceElementDefinition
```
The definition for a Service.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class ServiceDefinition.Data
A Service Data.

static class ServiceDefinition.Topic
A Service Topic.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`ServiceDefinition.Data` A Service Data.
`static class`	`ServiceDefinition.Topic` A Service Topic.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`boolean`	`acceptMultipleProviderAttachments()` Return true if this Service accept multiple providers attachments.
`void`	`addProvider(ModuleDefinition module, boolean attached)` Add a Service provider.
`void`	`addSubscriber(ModuleDefinition module)` Add a Service subscriber.
`ServiceDefinition.Topic`	`addTopic(java.lang.String name)` Add a topic for the Service.
`default int`	`countDatas()` Return the number of Datas in the Service.
`default Data<?>`	`createData(java.lang.String name)` Create a Data instance of a specified name.
`java.util.Map<ModuleKey,ModuleDefinition>`	`getAttachedProviders()` Return the attached Service providers.
`org.da.protoframework.model.def.ConcreteServiceDefinition`	`getConcreteService()` Return the associated concrete Service.
`ServiceDefinition.Data`	`getData(java.lang.String name)` Return a Data by its name.
`default short`	`getDataChangeBehavior()` Return the change behavior for datas.
`java.util.Map<java.lang.String,ServiceDefinition.Data>`	`getDatasByName()` Return the Service datas.
`ServiceDefinition`	`getExtendedService()` Return the Service that this Service extends.
`java.util.Map<ModuleKey,ModuleDefinition>`	`getProviders()` Return the Map of Service providers.
`default short`	`getServiceInvocationMode()` Return the service invocation mode.
`java.util.Map<ModuleKey,ModuleDefinition>`	`getSubscribers()` Return the Map of Service subscribers.
`default ServiceDefinition`	`getTargetExtendedService()` Return the final Service that this Service extends in the chain of extended sercices.
`java.util.Map<java.lang.String,ServiceDefinition.Topic>`	`getTopics()` Return all the defined topics for the Service.
`boolean`	`hasData(java.lang.String name)` Return true if the Servive has a data of a specified name.
`default boolean`	`hasDatas()` Return true if the service has datas.
`boolean`	`isAbstract()` Return true if the Service is abstract.
`default boolean`	`isCopyingDatas()` Return true if the datas of the service must be copied before being sent.
`boolean`	`removeData(java.lang.String name)` Removes a Data.
`void`	`removeProvider(ModuleKey key)` Remove a Service provider.
`default void`	`setDataChangeBehavior(short changeBehavior)` Set the change behavior for datas.
`default void`	`setDescription(java.lang.String desc)` Set the service description.
`default void`	`setKey(NamespaceKey key)` Set the service key.
`default void`	`setServiceInvocationMode(short invocationMode)` Set the service invocation mode.

Methods inherited from interface org.da.protoframework.model.def.ElementDefinition
getID, getName, hasID, setID

Methods inherited from interface org.da.protoframework.model.def.DescriptedElement
getDescription, hasDescription

Methods inherited from interface org.da.protoframework.model.namespace.NamespaceElement
getFullName, getKey, getNamespace, getNamespaceAsString

- Method Detail
  - getConcreteService
```
org.da.protoframework.model.def.ConcreteServiceDefinition getConcreteService()
```
    Return the associated concrete Service. It will be the same Service, except if this Service is an alias.
    
    Returns:
    
    the associated concrete Service
  - getExtendedService
```
ServiceDefinition getExtendedService()
```
    Return the Service that this Service extends. If this Service does not extend any other Service, then the method will return null. Return null by default.
    
    Returns:
    
    the Service
  - getTargetExtendedService
```
default ServiceDefinition getTargetExtendedService()
```
    Return the final Service that this Service extends in the chain of extended sercices. If this Service does not extend any other Service, then the method will return null. Return null by default.
    
    Returns:
    
    the Service
  - setKey
```
default void setKey(NamespaceKey key)
```
    Set the service key. Do nothing by default.
    
    Parameters:
    
    key - the service key
  - setDescription
```
default void setDescription(java.lang.String desc)
```
    Set the service description. Do nothing by default.
    
    Specified by:
    
    setDescription in interface org.da.protoframework.model.def.DescriptedElement
    
    Parameters:
    
    desc - the service description
  - getServiceInvocationMode
```
default short getServiceInvocationMode()
```
    Return the service invocation mode.
    
    Returns:
    
    the service invocation mode
    
    See Also:
    
    ServiceInvocationMode
  - setServiceInvocationMode
```
default void setServiceInvocationMode(short invocationMode)
```
    Set the service invocation mode. Do nothing by default.
    
    Parameters:
    
    invocationMode - the service invocation mode
    
    See Also:
    
    ServiceInvocationMode
  - setDataChangeBehavior
```
default void setDataChangeBehavior(short changeBehavior)
```
    Set the change behavior for datas.
    
    Parameters:
    
    changeBehavior - the change behavior
  - getDataChangeBehavior
```
default short getDataChangeBehavior()
```
    Return the change behavior for datas.
    
    Returns:
    
    the change behavior for datas
  - isAbstract
```
boolean isAbstract()
```
    Return true if the Service is abstract.
    
    Returns:
    
    true if the Service is abstract
  - isCopyingDatas
```
default boolean isCopyingDatas()
```
    Return true if the datas of the service must be copied before being sent. Return false by default.
    
    Returns:
    
    true if the datas of the service must be copied before being sent
  - addTopic
```
ServiceDefinition.Topic addTopic(java.lang.String name)
```
    Add a topic for the Service.
    
    Parameters:
    
    name - the topic name
    
    Returns:
    
    the topic
  - getTopics
```
java.util.Map<java.lang.String,ServiceDefinition.Topic> getTopics()
```
    Return all the defined topics for the Service.
    
    Returns:
    
    the topics
  - getData
```
ServiceDefinition.Data getData(java.lang.String name)
```
    Return a Data by its name.
    
    Parameters:
    
    name - the Data name
    
    Returns:
    
    the Data
  - createData
```
default Data<?> createData(java.lang.String name)
```
    Create a Data instance of a specified name. It will return null if there is no Data with the specified name.
    
    Parameters:
    
    name - the data name
    
    Returns:
    
    the Data instance
  - removeData
```
boolean removeData(java.lang.String name)
```
    Removes a Data.
    
    Parameters:
    
    name - the data name
    
    Returns:
    
    true if the data could be removed
  - hasData
```
boolean hasData(java.lang.String name)
```
    Return true if the Servive has a data of a specified name.
    
    Parameters:
    
    name - the data name
    
    Returns:
    
    true if the Servive has a data of the specified name
  - hasDatas
```
default boolean hasDatas()
```
    Return true if the service has datas.
    
    Returns:
    
    true if the service has datas
  - countDatas
```
default int countDatas()
```
    Return the number of Datas in the Service.
    
    Returns:
    
    the number of Datas in the Service
  - getDatasByName
```
java.util.Map<java.lang.String,ServiceDefinition.Data> getDatasByName()
```
    Return the Service datas.
    
    Returns:
    
    the Service datas
  - getAttachedProviders
```
java.util.Map<ModuleKey,ModuleDefinition> getAttachedProviders()
```
    Return the attached Service providers.
    
    Returns:
    
    the attached Service providers
  - acceptMultipleProviderAttachments
```
boolean acceptMultipleProviderAttachments()
```
    Return true if this Service accept multiple providers attachments.
    
    Returns:
    
    true if this Service accept multiple providers attachments
  - addProvider
```
void addProvider(ModuleDefinition module,
                 boolean attached)
```
    Add a Service provider.
    
    Parameters:
    
    module - the module
    
    attached - true if the provider is attached to the Service
  - removeProvider
```
void removeProvider(ModuleKey key)
```
    Remove a Service provider.
    
    Parameters:
    
    key - the module key
  - getProviders
```
java.util.Map<ModuleKey,ModuleDefinition> getProviders()
```
    Return the Map of Service providers.
    
    Returns:
    
    the Map of Service providers
  - addSubscriber
```
void addSubscriber(ModuleDefinition module)
```
    Add a Service subscriber.
    
    Parameters:
    
    module - the subscriber
  - getSubscribers
```
java.util.Map<ModuleKey,ModuleDefinition> getSubscribers()
```
    Return the Map of Service subscribers.
    
    Returns:
    
    the Map of Service subscribers

Interface ServiceDefinition

Nested Class Summary

Method Summary

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

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

Methods inherited from interface org.da.protoframework.model.namespace.NamespaceElement

Method Detail

getConcreteService

getExtendedService

getTargetExtendedService

setKey

setDescription

getServiceInvocationMode

setServiceInvocationMode

setDataChangeBehavior

getDataChangeBehavior

isAbstract

isCopyingDatas

addTopic

getTopics

getData

createData

removeData

hasData

hasDatas

countDatas

getDatasByName

getAttachedProviders

acceptMultipleProviderAttachments

addProvider

removeProvider

getProviders

addSubscriber

getSubscribers