com.softwareag.centrasite.appl.framework.lcm
Interface LCMAdminManager

All Known Implementing Classes:
LCMAdminManagerImpl

public interface LCMAdminManager

The LCMAdminManager provides all operations to create, modify and delete LCModels - State models for Lifecycle Management, models can theoretically be complex and go across multiple machines and LCStates


Method Summary
 LCModel createLCModel()
          Creates an LCModel
 void deleteLCModel(LCModel lcModel)
          Deletes the given LCModel.
 java.util.Collection<LCModel> findAllModels()
          Find all LCModels that are currently within the scope (global or organizational specific) of the logged-in user.
 java.util.Collection<LCModel> findInactiveModels()
          Find all LCModels in the whole system that are not active
 LCModel findLCMForLCM()
          Finds the LCModel for LCModels.
 LCModel findLCModel(java.lang.String typeName)
          Find the LCModel that is active for for the given type If there are two LCModels active for the given type (one global and the other local), the global LCModel will be returned.
 java.util.List<LCModel> findLCModelByDisplayName(java.lang.String displayName, boolean activatedModelsOnly)
          Find all LCModels that have the searched display name.
 LCModel getLCModel(java.lang.String lcModelKey)
          Get the LCModel with the given key
 void saveLCModel(LCModel lcModel)
          Saves the given LCModel
 

Method Detail

createLCModel

LCModel createLCModel()
                      throws CSAppFrameworkException
Creates an LCModel

Returns:
the new LCModel object
Throws:
CSAppFrameworkException - - if the LCM provider encounters an internal error

findLCMForLCM

LCModel findLCMForLCM()
                      throws CSAppFrameworkException
Finds the LCModel for LCModels. If two LCModel for LCModels, one local belonging to the organization of the logged in user and the other global are present, the global model is returned

Returns:
LCModel for LCModels
Throws:
CSAppFrameworkException

getLCModel

LCModel getLCModel(java.lang.String lcModelKey)
                   throws CSAppFrameworkException
Get the LCModel with the given key

Parameters:
lcModelKey - the key of the LCModel which LCModel has to be retrieved
Returns:
LCModel with the given key, null if no LCModel found
Throws:
CSAppFrameworkException - - if the LCM provider encounters an internal error

findAllModels

java.util.Collection<LCModel> findAllModels()
                                            throws CSAppFrameworkException
Find all LCModels that are currently within the scope (global or organizational specific) of the logged-in user.

Returns:
all the LCModels as a collection, must not be null
Throws:
CSAppFrameworkException - - if the LCM provider encounters an internal error

findInactiveModels

java.util.Collection<LCModel> findInactiveModels()
                                                 throws CSAppFrameworkException
Find all LCModels in the whole system that are not active

Returns:
the LCModels that are not active as a collection, must not be null
Throws:
CSAppFrameworkException - - if the LCM provider encounters an internal error

findLCModel

LCModel findLCModel(java.lang.String typeName)
                    throws CSAppFrameworkException
Find the LCModel that is active for for the given type If there are two LCModels active for the given type (one global and the other local), the global LCModel will be returned.

Parameters:
typeName - the name of the type for which the LCModel has to be found
Returns:
LCModel with the given name, null if no LCModel found
Throws:
CSAppFrameworkException - - if the LCM provider encounters an internal error

findLCModelByDisplayName

java.util.List<LCModel> findLCModelByDisplayName(java.lang.String displayName,
                                                 boolean activatedModelsOnly)
                                                 throws CSAppFrameworkException
Find all LCModels that have the searched display name.

Parameters:
displayName - the name of the LCModel to be found
activatedModelsOnly - if true - only active models will be searched, false - all models will be searched
Returns:
List with the given name, empty List if no LCModel found
Throws:
CSAppFrameworkException - - if the LCM provider encounters an internal error

deleteLCModel

void deleteLCModel(LCModel lcModel)
                   throws CSAppFrameworkException
Deletes the given LCModel. An LCModel can be deleted only when it is not active

Parameters:
lcModel - the lcModel to be deleted
Throws:
CSAppFrameworkException - - if the LCM provider encounters an internal error

saveLCModel

void saveLCModel(LCModel lcModel)
                 throws CSAppFrameworkException
Saves the given LCModel

Parameters:
lcModel - the LCModel to be saved
Throws:
CSAppFrameworkException - - if the LCM provider encounters an internal error