Package de.mid.innovator.srv2api.icw2meta

Class ADModelHelper

java.lang.Object

de.mid.innovator.srv2api.icw2meta.ADModelHelper

public abstract class ADModelHelper
extends Object

Represents a common model.

See Also:

• ADModel

Method Summary

Modifier and Type	Method	Description
static ARG_CreateRepository	createBranch(SrvContext srvCtx, ADModel adModel, String branchName, String note, boolean asSubBranch, boolean withCS, boolean withUN, String variableModelName)	Creates a branch.
static ARG_CreateRepository	createBranchBackup(SrvContext srvCtx, ADModel adModel, String backupName, String note)	Creates a backup of the current branch.
static ARG_CreateBranchFromLatestUpdate	createBranchFromLatestUpdate(SrvContext srvCtx, ADModel adModel)	Creates a branch from the latest update of this model
static ARG_ADModelInfo	createByFile(SrvContext srvCtx, ADLogin login, Path file, String nameModel, String password, String passCopy)	Creates a new model using the given version file.
static ARG_CreateRepository	createModelVersion(SrvContext srvCtx, ADModel adModel, String branchName, String note, String adModelUUID, String parentBranchUUID, String adModelName, String variableModelName)	Creates a new model version.
static ELElement	getFindElementById(SrvContext srvCtx, Class<? extends ELObject> kVOcl, int id)	If it exists, returns the model element described by the ARG_FindElementByIdOclReq structure.
static ARG_CreationDate	getFirstCreationDate(SrvContext srvCtx, List<? extends ELContainerAble> seqRoot, List<? extends ELElement> seqFlat)	examines the transitive content of the elements in seqRoot and returns the oldest creation date of these elements.
static ARG_ADListLoginOut	getListLogin(SrvContext srvCtx, String nameModel, K_ADMODEL methModel, String patternUser)	Returns information about the login user list.
static ARG_ADModelConfig	getListModelConfig(SrvContext srvCtx, K_ADMODEL item)	Returns the names of available model configurations.
static ARG_ADUserConfig	getListUserConfig(SrvContext srvCtx)	Returns the names of available user configurations.
static Path	getVersionFile(SrvContext srvCtx, ADLogin login, K_ADMODEL method, String name)	Returns the complete version ASCII representation of the model.
static void	guestAllow(SrvContext srvCtx, ADModel model, boolean allowLogin, String text)	Allow and forbid for the guest logins.
static void	modelNameUpdate(SrvContext srvCtx, ADModel adModel, String modelName)	renames this model.
static void	modifyBranchProperties(SrvContext srvCtx, ADModel adModel, String name, String note)	Updates the properties of this branch.
static void	modifyVersionAlias(SrvContext srvCtx, ADModel adModel, List<ARG_Alias> seqAlias)	Replaces the model versions alias list.
static void	nameConstraintsUpdate(SrvContext srvCtx, ADModel adModel, String expressionForVersionName, String expressionForBackupName)	Updates the regular expressions constraining the name of a model version and a model backup.
static void	reassignBranch(SrvContext srvCtx, ADModel adModel, String parentBranchUUID)	assigns this branch to a new parent branch.

Methods inherited from class java.lang.Object

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

Method Details

getFindElementById

public static ELElement getFindElementById(SrvContext srvCtx,
 Class<? extends ELObject> kVOcl,
 int id)
                                    throws InoNetException,
SrvErrorException

If it exists, returns the model element described by the ARG_FindElementByIdOclReq structure.

Parameters:

srvCtx - The context of the related innovator server.

kVOcl - VOCL of element

id - Id of element

Throws:

InoNetException

SrvErrorException

getFirstCreationDate

public static ARG_CreationDate getFirstCreationDate(SrvContext srvCtx,
 List<? extends ELContainerAble> seqRoot,
 List<? extends ELElement> seqFlat)
                                             throws InoNetException,
SrvErrorException

examines the transitive content of the elements in seqRoot and returns the oldest creation date of these elements.

Parameters:

srvCtx - The context of the related innovator server.

seqRoot - consider this element and all transitivly owned elements

seqFlat - consider only this elements but omit transitifly owned elements

Throws:

InoNetException

SrvErrorException

getListLogin

public static ARG_ADListLoginOut getListLogin(SrvContext srvCtx,
 String nameModel,
 K_ADMODEL methModel,
 String patternUser)
                                       throws InoNetException,
SrvErrorException

Returns information about the login user list.

Parameters:

srvCtx - The context of the related innovator server.

nameModel - name of the model

methModel - method of the model

patternUser - pattern for the user name

Throws:

InoNetException

SrvErrorException

getListModelConfig

public static ARG_ADModelConfig getListModelConfig(SrvContext srvCtx,
 K_ADMODEL item)
                                            throws InoNetException,
SrvErrorException

Returns the names of available model configurations.

Parameters:

srvCtx - The context of the related innovator server.

item -

Throws:

InoNetException

SrvErrorException

getListUserConfig

public static ARG_ADUserConfig getListUserConfig(SrvContext srvCtx)
                                          throws InoNetException,
SrvErrorException

Returns the names of available user configurations.

Parameters:

srvCtx - The context of the related innovator server.

Throws:

InoNetException

SrvErrorException

getVersionFile

public static Path getVersionFile(SrvContext srvCtx,
 ADLogin login,
 K_ADMODEL method,
 String name)
                           throws InoNetException,
SrvErrorException

Returns the complete version ASCII representation of the model.

Parameters:

srvCtx - The context of the related innovator server.

login - administrator login

method - model type

name - model name

Throws:

InoNetException

SrvErrorException

createBranchBackup

public static ARG_CreateRepository createBranchBackup(SrvContext srvCtx,
 ADModel adModel,
 String backupName,
 String note)
                                               throws InoNetException,
SrvErrorException

Creates a backup of the current branch.

Parameters:

srvCtx - The context of the related innovator server.

adModel - take the current branch of this model

backupName - name of the backup branch

note - note of the new branch

Throws:

InoNetException

SrvErrorException

createBranchFromLatestUpdate

public static ARG_CreateBranchFromLatestUpdate createBranchFromLatestUpdate(SrvContext srvCtx,
 ADModel adModel)
                                                                     throws InoNetException,
SrvErrorException

Creates a branch from the latest update of this model

Parameters:

srvCtx - The context of the related innovator server.

adModel - create branch for this model

Throws:

InoNetException

SrvErrorException

createBranch

public static ARG_CreateRepository createBranch(SrvContext srvCtx,
 ADModel adModel,
 String branchName,
 String note,
 boolean asSubBranch,
 boolean withCS,
 boolean withUN,
 String variableModelName)
                                         throws InoNetException,
SrvErrorException

Creates a branch. The branch holds a copy of the current model. The branch is a either a sub branch of the current branch or a sibling branch of the current branch.

Parameters:

srvCtx - The context of the related innovator server.

adModel - create branch for this model

branchName - name of the new branch

note - note of the new branch

asSubBranch - if true create as a sub brunch of the current branch

withCS - extract with change set

withUN - extract with user notification

variableModelName - value of property 'VariableModelName'

Throws:

InoNetException

SrvErrorException

createByFile

public static ARG_ADModelInfo createByFile(SrvContext srvCtx,
 ADLogin login,
 Path file,
 String nameModel,
 String password,
 String passCopy)
                                    throws InoNetException,
SrvErrorException

Creates a new model using the given version file. The name of the model from inside the file is used and made unique if necessary.

Parameters:

srvCtx - The context of the related innovator server.

login - repository administrator login

file - file to import

nameModel - name of the new model. If not set the name of the copied one will be used

password - password of the new model. If not set the password of the copied one will be used

passCopy - password of the copied model. Must be set if a new password should be set

Throws:

InoNetException

SrvErrorException

createModelVersion

public static ARG_CreateRepository createModelVersion(SrvContext srvCtx,
 ADModel adModel,
 String branchName,
 String note,
 String adModelUUID,
 String parentBranchUUID,
 String adModelName,
 String variableModelName)
                                               throws InoNetException,
SrvErrorException

Creates a new model version. The repository contains a copy of the current model.

Parameters:

srvCtx - The context of the related innovator server.

adModel - create a version for this model

branchName - name of the new branch

note - note of the new branch

adModelUUID - uuid of the model. If null a new UUID is assigned to the model.

parentBranchUUID - uuid of the new parent branch. If not null an adModelUUID is required. If null this version is root version

adModelName - name of the model of the newly created branch

variableModelName - value of property 'VariableModelName'

Throws:

InoNetException

SrvErrorException

guestAllow

public static void guestAllow(SrvContext srvCtx,
 ADModel model,
 boolean allowLogin,
 String text)
                       throws InoNetException,
SrvErrorException

Allow and forbid for the guest logins.

Parameters:

srvCtx - The context of the related innovator server.

model - model id

allowLogin - flag if login is allowed

text - lock text

Throws:

InoNetException

SrvErrorException

modelNameUpdate

public static void modelNameUpdate(SrvContext srvCtx,
 ADModel adModel,
 String modelName)
                            throws InoNetException,
SrvErrorException

renames this model.

Parameters:

srvCtx - The context of the related innovator server.

adModel - rename this model

modelName - new model name

Throws:

InoNetException

SrvErrorException

modifyBranchProperties

public static void modifyBranchProperties(SrvContext srvCtx,
 ADModel adModel,
 String name,
 String note)
                                   throws InoNetException,
SrvErrorException

Updates the properties of this branch.

Parameters:

srvCtx - The context of the related innovator server.

adModel - modify the properties of the current branch of this model

name - name of the version

note - updates description of this branch

Throws:

InoNetException

SrvErrorException

modifyVersionAlias

public static void modifyVersionAlias(SrvContext srvCtx,
 ADModel adModel,
 List<ARG_Alias> seqAlias)
                               throws InoNetException,
SrvErrorException

Replaces the model versions alias list.

Parameters:

srvCtx - The context of the related innovator server.

adModel - modify the version aliases of this model

seqAlias - list of aliases

Throws:

InoNetException

SrvErrorException

nameConstraintsUpdate

public static void nameConstraintsUpdate(SrvContext srvCtx,
 ADModel adModel,
 String expressionForVersionName,
 String expressionForBackupName)
                                  throws InoNetException,
SrvErrorException

Updates the regular expressions constraining the name of a model version and a model backup.

Parameters:

srvCtx - The context of the related innovator server.

adModel - update the name constraints of this model

expressionForVersionName - constraint for version names

expressionForBackupName - constraint for backup names

Throws:

InoNetException

SrvErrorException

reassignBranch

public static void reassignBranch(SrvContext srvCtx,
 ADModel adModel,
 String parentBranchUUID)
                           throws InoNetException,
SrvErrorException

assigns this branch to a new parent branch.

Parameters:

srvCtx - The context of the related innovator server.

adModel - reassign the current branch of this model

parentBranchUUID - uuid of the new parrnet branch

Throws:

InoNetException

SrvErrorException