Package de.mid.innovator.srv2api.icw2meta

Class ADChangeSetHelper

java.lang.Object

de.mid.innovator.srv2api.icw2meta.ADChangeSetHelper

public abstract class ADChangeSetHelper
extends java.lang.Object

The currently active change set of the assigned users.

See Also:

ADChangeSet

Method Summary

Modifier and Type	Method	Description
static void	configChangeSetDlg(SrvContext srvCtx, boolean isActiveLog, boolean isActiveSet, boolean isAnonym, int maxDay, boolean withExport)	Modifies the configuration of change sets.
static ADChangeSet	create(SrvContext srvCtx, java.lang.String strName, java.lang.String strNote, java.lang.String strLink, java.lang.String strId)	creates a change set assigned to the user of this login.
static void	deleteChangeSets(SrvContext srvCtx)	Deletes all closed change sets.
static ARG_ChangeSetList	getChangeSetList(SrvContext srvCtx, boolean onlyActive, boolean restrictOnLogin, boolean withSealed, ARG_ChangeSetPeriod valStart, ARG_ChangeSetPeriod valEnd)	Returns a list of change sets with properties.
static java.util.List<ARG_NameInChangeSetLog>	getChangeSetNameOfValidElements(SrvContext srvCtx, java.util.List<ARG_VOclAndId> seqId)	returns the instance, name and the qualified owner's name of the specified elements.
static ARG_ChangeSetOperationValues	getChangeSetProtocol(SrvContext srvCtx, java.util.List<? extends ADChangeSet> seqSet, ARG_ChangeSetPeriod valPeriod)	Returns the protocol of model changes during a set of change sets.
static ARG_Ask	getConfigChangeSetDlgCheck(SrvContext srvCtx, boolean isActiveLog, boolean isActiveSet, boolean isAnonym, int maxDay, boolean withExport)	Checks whether the modification of the change set configuration will reduce the number of closed change sets.
static ARG_ConfigChangeSet	getConfigChangeSetDlgInit(SrvContext srvCtx)	Fills the dialog for the configuration of change sets.
static ADChangeSet	splitChangeSet(SrvContext srvCtx, java.util.List<? extends ADCSOperation> seqOp, boolean createNewChangeSet)	Splits the change set content and moves the specified operations to another change set.

Methods inherited from class java.lang.Object

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

Method Detail

getChangeSetList

public static ARG_ChangeSetList getChangeSetList(SrvContext srvCtx,
                                                 boolean onlyActive,
                                                 boolean restrictOnLogin,
                                                 boolean withSealed,
                                                 ARG_ChangeSetPeriod valStart,
                                                 ARG_ChangeSetPeriod valEnd)
                                          throws InoNetException,
                                                 SrvErrorException

Returns a list of change sets with properties. The list may be restricted by the specified parameters.

Parameters:

srvCtx - The context of the related innovator server.

onlyActive - true, if the list of change sets is restricted to active change sets

restrictOnLogin - true, if the list of change sets is restricted to the actual login

withSealed - true, if the list of change sets includes sealed change sets

valStart - restrict the list of change sets by starting time

valEnd - restrict the list of change sets by end time

Throws:

InoNetException

SrvErrorException

getChangeSetNameOfValidElements

public static java.util.List<ARG_NameInChangeSetLog> getChangeSetNameOfValidElements(SrvContext srvCtx,
                                                                                     java.util.List<ARG_VOclAndId> seqId)
                                                                              throws InoNetException,
                                                                                     SrvErrorException

returns the instance, name and the qualified owner's name of the specified elements. Only elements found in model are returned.

Parameters:

srvCtx - The context of the related innovator server.

seqId - element specifications

Throws:

InoNetException

SrvErrorException

getChangeSetProtocol

public static ARG_ChangeSetOperationValues getChangeSetProtocol(SrvContext srvCtx,
                                                                java.util.List<? extends ADChangeSet> seqSet,
                                                                ARG_ChangeSetPeriod valPeriod)
                                                         throws InoNetException,
                                                                SrvErrorException

Returns the protocol of model changes during a set of change sets. The changes may be restricted by a time period.

Parameters:

srvCtx - The context of the related innovator server.

seqSet - list of selected change sets

valPeriod - restrict the list of change sets and operations by time

Throws:

InoNetException

SrvErrorException

getConfigChangeSetDlgCheck

public static ARG_Ask getConfigChangeSetDlgCheck(SrvContext srvCtx,
                                                 boolean isActiveLog,
                                                 boolean isActiveSet,
                                                 boolean isAnonym,
                                                 int maxDay,
                                                 boolean withExport)
                                          throws InoNetException,
                                                 SrvErrorException

Checks whether the modification of the change set configuration will reduce the number of closed change sets.

Parameters:

srvCtx - The context of the related innovator server.

isActiveLog - true, if change logs are active

isActiveSet - true, if change sets are active

isAnonym - true, if change sets are anonymous

maxDay - maximum duration of keeping change sets

withExport - true, if change sets are exported

Throws:

InoNetException

SrvErrorException

getConfigChangeSetDlgInit

public static ARG_ConfigChangeSet getConfigChangeSetDlgInit(SrvContext srvCtx)
                                                     throws InoNetException,
                                                            SrvErrorException

Fills the dialog for the configuration of change sets.

Parameters:

srvCtx - The context of the related innovator server.

Throws:

InoNetException

SrvErrorException

configChangeSetDlg

public static void configChangeSetDlg(SrvContext srvCtx,
                                      boolean isActiveLog,
                                      boolean isActiveSet,
                                      boolean isAnonym,
                                      int maxDay,
                                      boolean withExport)
                               throws InoNetException,
                                      SrvErrorException

Modifies the configuration of change sets.

Parameters:

srvCtx - The context of the related innovator server.

isActiveLog - true, if change logs are active

isActiveSet - true, if change sets are active

isAnonym - true, if change sets are anonymous

maxDay - maximum duration of keeping change sets

withExport - true, if change sets are exported

Throws:

InoNetException

SrvErrorException

create

public static ADChangeSet create(SrvContext srvCtx,
                                 java.lang.String strName,
                                 java.lang.String strNote,
                                 java.lang.String strLink,
                                 java.lang.String strId)
                          throws InoNetException,
                                 SrvErrorException

creates a change set assigned to the user of this login.

Parameters:

srvCtx - The context of the related innovator server.

strName - change set name

strNote - change set description

strLink - link to an external tracking system

strId - id at an external tracking system

Throws:

InoNetException

SrvErrorException

deleteChangeSets

public static void deleteChangeSets(SrvContext srvCtx)
                             throws InoNetException,
                                    SrvErrorException

Deletes all closed change sets.

Parameters:

srvCtx - The context of the related innovator server.

Throws:

InoNetException

SrvErrorException

splitChangeSet

public static ADChangeSet splitChangeSet(SrvContext srvCtx,
                                         java.util.List<? extends ADCSOperation> seqOp,
                                         boolean createNewChangeSet)
                                  throws InoNetException,
                                         SrvErrorException

Splits the change set content and moves the specified operations to another change set. If the creation of a new change set is required this changeset becomes active. Otherwise the active change set is used.

Parameters:

srvCtx - The context of the related innovator server.

seqOp - list of change set operations

createNewChangeSet - true/false means create a new change set / use the active change set

Throws:

InoNetException

SrvErrorException