fr.paris.lutece.plugins.pluginwizard.service
Class ModelService

java.lang.Object
  extended by fr.paris.lutece.plugins.pluginwizard.service.ModelService

public final class ModelService
extends Object

Model Service provides all plugin'model manipulations


Method Summary
static void addApplication(int nPluginId, Application application)
          Add an application to the model
static void addAttribute(int nPluginId, int nBusinessClassId, Attribute attribute)
          Add an attribute to a business class
static BusinessClass addBusinessClass(int nPluginId, BusinessClassFormBean bc)
          Add an bc to the model
static void addFeature(int nPluginId, Feature feature)
          Add a feature
static void addPortlet(int nPluginId, Portlet portlet)
          Add an portlet to the model
static int createModel(String strPluginName)
          Create a plugin model
static Application getApplication(int nPluginId, int nApplicationId)
          Get a given application
static Application getApplication(PluginModel pm, int nApplicationId)
          Get a given application
static Application getApplicationByBusinessClass(PluginModel pm, int nBusinessClassId)
          Gets the application for a given Business Class
static Attribute getAttribute(int nPluginId, int nBusinessClassId, int nAttributeId)
          Get a given attribute
static String getAttributeConstraint(int nAttributeTypeId)
          Returns the attribute constraint corresponding to an ID
static String getAttributePrefix(int nAttributeTypeId)
          Returns the attribute prefix corresponding to an ID
static String getAttributeType(int nAttributeTypeId)
          Returns the attribute type corresponding to an ID
static String getAttributeTypeDescription(int nAttributeTypeId)
          Returns the attribute type description
static fr.paris.lutece.util.ReferenceList getAttributeTypes()
          Gets all attribute types
static BusinessClass getBusinessClass(int nPluginId, int nBusinessClassId)
          Get a given business class
static BusinessClass getBusinessClass(PluginModel pm, int nBusinessClassId)
          Get a given business class
static List<BusinessClass> getBusinessClassesByApplication(PluginModel pm, int nApplicationId)
          Gets all business classes for a given Application
static List<BusinessClass> getBusinessClassesByFeature(PluginModel pm, int nFeatureId)
          Gets all business classes for a given Feature
static fr.paris.lutece.util.ReferenceList getComboBusinessClasses(int nPluginId)
          Returns a Reference list with all Business Classes * @param nPluginId The Plugin's ID
static DescriptionFormBean getDescription(int nPluginId)
           
static Feature getFeature(int nPluginId, int nFeatureId)
          Get a given feature
static Feature getFeatureByBusinessClass(PluginModel pm, int nBusinessClassId)
          Gets the feature for a given Business Class
static BusinessClassFormBean getFormBusinessClass(int nPluginId, int nBusinessClassId)
           
static PluginModel getPluginModel(int nPluginId)
          Returns the plugin model
static Portlet getPortlet(int nPluginId, int nPortletId)
          Get a given portlet
static void removeAll(int nPluginId)
          Remove all data for a given plugin
static void removeApplication(int nPluginId, int nApplicationId)
          Remove an application
static void removeAttribute(int nPluginId, int nBusinessClassId, int nAttributeId)
          Remove an attribute
static void removeBusinessClass(int nPluginId, int nBusinessClassId)
          Remove a business class
static void removeFeature(int nPluginId, int nFeatureId)
          Remove a feature
static void removePortlet(int nPluginId, int nPortletId)
          Remove an portlet
static void savePluginModel(PluginModel pm)
          Save the plugin model
static void updateApplication(int nPluginId, Application application)
          Update an application
static void updateAttribute(int nPluginId, int nBusinessClassId, Attribute attribute)
          Update an attribute
static void updateBusinessClass(int nPluginId, BusinessClassFormBean businessClass)
          Update an businessClass
static void updateDescription(int nPluginId, DescriptionFormBean description)
           
static void updateFeature(int nPluginId, Feature feature)
          Update a feature
static void updatePortlet(int nPluginId, Portlet portlet)
          Update an portlet
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

createModel

public static int createModel(String strPluginName)
Create a plugin model

Parameters:
strPluginName - The plugin name
Returns:
The plugin ID

getPluginModel

public static PluginModel getPluginModel(int nPluginId)
Returns the plugin model

Parameters:
nPluginId - The plugin's ID
Returns:
The plugin model

savePluginModel

public static void savePluginModel(PluginModel pm)
Save the plugin model

Parameters:
pm - The plugin model

addFeature

public static void addFeature(int nPluginId,
                              Feature feature)
Add a feature

Parameters:
nPluginId - The plugin's ID
feature - The feature

getFeature

public static Feature getFeature(int nPluginId,
                                 int nFeatureId)
Get a given feature

Parameters:
nPluginId - The plugin's ID
nFeatureId - The feature's ID
Returns:
The feature

updateFeature

public static void updateFeature(int nPluginId,
                                 Feature feature)
Update a feature

Parameters:
nPluginId - The plugin's ID
feature - The feature

removeFeature

public static void removeFeature(int nPluginId,
                                 int nFeatureId)
Remove a feature

Parameters:
nPluginId - The plugin's ID
nFeatureId - The feature's ID

getApplication

public static Application getApplication(int nPluginId,
                                         int nApplicationId)
Get a given application

Parameters:
nPluginId - The plugin's ID
nApplicationId - The application ID
Returns:
The application

getApplication

public static Application getApplication(PluginModel pm,
                                         int nApplicationId)
Get a given application

Parameters:
pm - The plugin model
nApplicationId - The application ID
Returns:
The application

addApplication

public static void addApplication(int nPluginId,
                                  Application application)
Add an application to the model

Parameters:
nPluginId - The plugin's ID
application - The application

updateApplication

public static void updateApplication(int nPluginId,
                                     Application application)
Update an application

Parameters:
nPluginId - The plugin's ID
application - The application

removeApplication

public static void removeApplication(int nPluginId,
                                     int nApplicationId)
Remove an application

Parameters:
nPluginId - The plugin's ID
nApplicationId - The application's ID

getPortlet

public static Portlet getPortlet(int nPluginId,
                                 int nPortletId)
Get a given portlet

Parameters:
nPluginId - The plugin's ID
nPortletId - The portlet ID
Returns:
The portlet

addPortlet

public static void addPortlet(int nPluginId,
                              Portlet portlet)
Add an portlet to the model

Parameters:
nPluginId - The plugin's ID
portlet - The portlet

updatePortlet

public static void updatePortlet(int nPluginId,
                                 Portlet portlet)
Update an portlet

Parameters:
nPluginId - The plugin's ID
portlet - The portlet

removePortlet

public static void removePortlet(int nPluginId,
                                 int nPortletId)
Remove an portlet

Parameters:
nPluginId - The plugin's ID
nPortletId - The portlet's ID

getBusinessClass

public static BusinessClass getBusinessClass(int nPluginId,
                                             int nBusinessClassId)
Get a given business class

Parameters:
nPluginId - The plugin's ID
nBusinessClassId - The business class ID
Returns:
The business class

getBusinessClass

public static BusinessClass getBusinessClass(PluginModel pm,
                                             int nBusinessClassId)
Get a given business class

Parameters:
pm - The plugin model
nBusinessClassId - The business class ID
Returns:
The business class

addBusinessClass

public static BusinessClass addBusinessClass(int nPluginId,
                                             BusinessClassFormBean bc)
Add an bc to the model

Parameters:
nPluginId - The plugin's ID
bc - The business class
Returns:
The business class with its ID

updateBusinessClass

public static void updateBusinessClass(int nPluginId,
                                       BusinessClassFormBean businessClass)
Update an businessClass

Parameters:
nPluginId - The plugin's ID
businessClass - The businessClass

removeBusinessClass

public static void removeBusinessClass(int nPluginId,
                                       int nBusinessClassId)
Remove a business class

Parameters:
nPluginId - The plugin's ID
nBusinessClassId - The business class's ID

removeAll

public static void removeAll(int nPluginId)
Remove all data for a given plugin

Parameters:
nPluginId - The plugin ID

getAttribute

public static Attribute getAttribute(int nPluginId,
                                     int nBusinessClassId,
                                     int nAttributeId)
Get a given attribute

Parameters:
nPluginId - The plugin's ID
nBusinessClassId - The business class ID
nAttributeId - The attribute ID
Returns:
The attribute

addAttribute

public static void addAttribute(int nPluginId,
                                int nBusinessClassId,
                                Attribute attribute)
Add an attribute to a business class

Parameters:
nPluginId - The plugin's ID
nBusinessClassId - The business class ID
attribute - The Attribute

updateAttribute

public static void updateAttribute(int nPluginId,
                                   int nBusinessClassId,
                                   Attribute attribute)
Update an attribute

Parameters:
nPluginId - The plugin's ID
nBusinessClassId - The business class ID
attribute - The attribute

removeAttribute

public static void removeAttribute(int nPluginId,
                                   int nBusinessClassId,
                                   int nAttributeId)
Remove an attribute

Parameters:
nPluginId - The plugin's ID
nBusinessClassId - The business class ID
nAttributeId - The attribute's ID

getBusinessClassesByApplication

public static List<BusinessClass> getBusinessClassesByApplication(PluginModel pm,
                                                                  int nApplicationId)
Gets all business classes for a given Application

Parameters:
pm - The plugin model
nApplicationId - The Application's ID
Returns:
The list of business class

getBusinessClassesByFeature

public static List<BusinessClass> getBusinessClassesByFeature(PluginModel pm,
                                                              int nFeatureId)
Gets all business classes for a given Feature

Parameters:
pm - The plugin model
nFeatureId - The feature's ID
Returns:
The list of business class

getFeatureByBusinessClass

public static Feature getFeatureByBusinessClass(PluginModel pm,
                                                int nBusinessClassId)
Gets the feature for a given Business Class

Parameters:
pm - The plugin model
nBusinessClassId - The Business Class's ID
Returns:
The feature

getApplicationByBusinessClass

public static Application getApplicationByBusinessClass(PluginModel pm,
                                                        int nBusinessClassId)
Gets the application for a given Business Class

Parameters:
pm - The plugin model
nBusinessClassId - The Business Class's ID
Returns:
The application

getComboBusinessClasses

public static fr.paris.lutece.util.ReferenceList getComboBusinessClasses(int nPluginId)
Returns a Reference list with all Business Classes * @param nPluginId The Plugin's ID

Returns:
The list

getAttributeTypes

public static fr.paris.lutece.util.ReferenceList getAttributeTypes()
Gets all attribute types

Returns:
A list of attributes types

getAttributeType

public static String getAttributeType(int nAttributeTypeId)
Returns the attribute type corresponding to an ID

Parameters:
nAttributeTypeId - The attribute type ID
Returns:
The type

getAttributePrefix

public static String getAttributePrefix(int nAttributeTypeId)
Returns the attribute prefix corresponding to an ID

Parameters:
nAttributeTypeId - The attribute type ID
Returns:
The type

getAttributeConstraint

public static String getAttributeConstraint(int nAttributeTypeId)
Returns the attribute constraint corresponding to an ID

Parameters:
nAttributeTypeId - The attribute type ID
Returns:
The type

getAttributeTypeDescription

public static String getAttributeTypeDescription(int nAttributeTypeId)
Returns the attribute type description

Parameters:
nAttributeTypeId - The attribute type ID
Returns:
The type description

updateDescription

public static void updateDescription(int nPluginId,
                                     DescriptionFormBean description)

getDescription

public static DescriptionFormBean getDescription(int nPluginId)

getFormBusinessClass

public static BusinessClassFormBean getFormBusinessClass(int nPluginId,
                                                         int nBusinessClassId)


Copyright © 2013 Mairie de Paris. All Rights Reserved.