ApplicationDefinition (Protoframework API)

java.lang.Object
- org.da.protoframework.model.def.ApplicationDefinition

All Implemented Interfaces:

org.da.protoframework.model.def.DescriptedElement, ElementDefinition
```
public class ApplicationDefinition
extends java.lang.Object
implements ElementDefinition
```
The definition for an Application.

Constructor Summary

Constructors
Constructor and Description

ApplicationDefinition(java.lang.String name, long id)
Constructor.

Constructors
Constructor and Description
`ApplicationDefinition(java.lang.String name, long id)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addLibraries(java.net.URL[] urlArray)` Add an array of libraries which implement the Application.
`void`	`addLibrary(java.net.URL url)` Add a library which implement the Application.
`void`	`addModule(ModuleDefinition module)` Add a Module.
`java.lang.String`	`addModule(ModuleDefinition module, java.lang.String fromTemplate)` Add a Module as an instance of a module template.
`int`	`countModules()` Return the number of modules.
`java.lang.String`	`getDescription()` Return the application description (may be null).
`long`	`getID()` Return the Application ID.
`java.util.List<java.net.URL>`	`getLibraries()` Return the library which implement the Application.
`java.lang.String`	`getLibraryVersion()` Return the application library version.
`ModuleDefinition`	`getModule(java.lang.String name)` Return the module with a specified name.
`java.util.Set<java.lang.String>`	`getModuleInstances(java.lang.String templateName)` Return the module instances names derived from a module template name.
`java.util.Map<java.lang.String,ModuleDefinition>`	`getModules()` Return the map of modules.
`java.util.Map<java.lang.Long,ModuleDefinition>`	`getModulesByID()` Return the modules Map by ID.
`java.lang.String`	`getName()` Return the Application name.
`java.net.URL`	`getSpecURL()` Return the URL of the XML file which hold the definition for this application.
`java.lang.String`	`getType()` Return the application type.
`boolean`	`hasLibraries()` Return true if the application has libraries.
`boolean`	`hasLibraryVersion()` Return true if the application has a library version.
`boolean`	`hasModule(java.lang.String name)` Return true if there is a module with a specified name.
`boolean`	`hasServicesInterface()` Return true if the Application Definition support at least one Service interface for one of its modules.
`void`	`removeModule(ModuleDefinition module)` Removes a module.
`void`	`setDescription(java.lang.String desc)` Set the application description.
`void`	`setID(long id)` Set the Application ID.
`void`	`setLibraryVersion(java.lang.String version)` Set the application library version.
`void`	`setSpecURL(java.net.URL url)` Set the URL of the XML file which hold the definition for this application.
`void`	`setType(java.lang.String appliType)` Set the application type.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

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

- Constructor Detail
  - ApplicationDefinition
```
public ApplicationDefinition(java.lang.String name,
                             long id)
```
    Constructor.
    
    Parameters:
    
    name - the Application name
    
    id - the Application ID
- Method Detail
  - setSpecURL
```
public void setSpecURL(java.net.URL url)
```
    Set the URL of the XML file which hold the definition for this application.
    
    Parameters:
    
    url - the url
  - getSpecURL
```
public java.net.URL getSpecURL()
```
    Return the URL of the XML file which hold the definition for this application.
    
    Returns:
    
    the url
  - setID
```
public void setID(long id)
```
    Set the Application ID.
    
    Specified by:
    
    setID in interface ElementDefinition
    
    Parameters:
    
    id - the Application ID
  - setDescription
```
public void setDescription(java.lang.String desc)
```
    Set the application description.
    
    Specified by:
    
    setDescription in interface org.da.protoframework.model.def.DescriptedElement
    
    Parameters:
    
    desc - the application description
  - getDescription
```
public java.lang.String getDescription()
```
    Return the application description (may be null).
    
    Specified by:
    
    getDescription in interface org.da.protoframework.model.def.DescriptedElement
    
    Returns:
    
    the application description
  - getName
```
public java.lang.String getName()
```
    Return the Application name.
    
    Specified by:
    
    getName in interface ElementDefinition
    
    Returns:
    
    the Application name
  - setLibraryVersion
```
public void setLibraryVersion(java.lang.String version)
```
    Set the application library version.
    
    Parameters:
    
    version - the application library version
  - hasLibraryVersion
```
public boolean hasLibraryVersion()
```
    Return true if the application has a library version.
    
    Returns:
    
    true if the application has a library version
  - getLibraryVersion
```
public java.lang.String getLibraryVersion()
```
    Return the application library version.
    
    Returns:
    
    the application library version
  - setType
```
public void setType(java.lang.String appliType)
```
    Set the application type.
    
    Parameters:
    
    appliType - the application type
  - getType
```
public java.lang.String getType()
```
    Return the application type.
    
    Returns:
    
    the application type
  - getID
```
public long getID()
```
    Return the Application ID.
    
    Specified by:
    
    getID in interface ElementDefinition
    
    Returns:
    
    the Application ID
  - addLibrary
```
public void addLibrary(java.net.URL url)
```
    Add a library which implement the Application.
    
    Parameters:
    
    url - the library URL
  - addLibraries
```
public void addLibraries(java.net.URL[] urlArray)
```
    Add an array of libraries which implement the Application.
    
    Parameters:
    
    urlArray - the libraries URLs
  - getLibraries
```
public java.util.List<java.net.URL> getLibraries()
```
    Return the library which implement the Application.
    
    Returns:
    
    the libraries
  - hasLibraries
```
public boolean hasLibraries()
```
    Return true if the application has libraries.
    
    Returns:
    
    true if the application has libraries
  - hasModule
```
public boolean hasModule(java.lang.String name)
```
    Return true if there is a module with a specified name.
    
    Parameters:
    
    name - the module name
    
    Returns:
    
    true if there is a module for the specified name
  - addModule
```
public java.lang.String addModule(ModuleDefinition module,
                                  java.lang.String fromTemplate)
```
    Add a Module as an instance of a module template.
    
    Parameters:
    
    module - the module
    
    fromTemplate - the module template name
    
    Returns:
    
    the module name
  - getModuleInstances
```
public java.util.Set<java.lang.String> getModuleInstances(java.lang.String templateName)
```
    Return the module instances names derived from a module template name.
    
    Parameters:
    
    templateName - the module template name
    
    Returns:
    
    the module instances names
  - addModule
```
public void addModule(ModuleDefinition module)
```
    Add a Module.
    
    Parameters:
    
    module - the module
  - removeModule
```
public void removeModule(ModuleDefinition module)
```
    Removes a module.
    
    Parameters:
    
    module - the module
  - getModulesByID
```
public java.util.Map<java.lang.Long,ModuleDefinition> getModulesByID()
```
    Return the modules Map by ID.
    
    Returns:
    
    the modules Map by ID
  - getModules
```
public java.util.Map<java.lang.String,ModuleDefinition> getModules()
```
    Return the map of modules.
    
    Returns:
    
    the modules
  - countModules
```
public int countModules()
```
    Return the number of modules.
    
    Returns:
    
    the number of modules
  - getModule
```
public ModuleDefinition getModule(java.lang.String name)
```
    Return the module with a specified name.
    
    Parameters:
    
    name - the module name
    
    Returns:
    
    the module
  - hasServicesInterface
```
public boolean hasServicesInterface()
```
    Return true if the Application Definition support at least one Service interface for one of its modules.
    
    Returns:
    
    true if the Application Definition support at least one Service interface for one of its modules
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class ApplicationDefinition

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

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

Constructor Detail

ApplicationDefinition

Method Detail

setSpecURL

getSpecURL

setID

setDescription

getDescription

getName

setLibraryVersion

hasLibraryVersion

getLibraryVersion

setType

getType

getID

addLibrary

addLibraries

getLibraries

hasLibraries

hasModule

addModule

getModuleInstances

addModule

removeModule

getModulesByID

getModules

countModules

getModule

hasServicesInterface

toString