ADChangeSet (Java API)

Overview

Package

Class

Use

Help

SDK Help DE EN

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

de.mid.innovator.srv2api.icw2meta
Interface ADChangeSet

All Superinterfaces:: ADClientAble, ADM2AttrModifyAble, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELNamedElement, ELObject, ELUUIDAble

public interface ADChangeSet
extends ELContainerAble, ELUUIDAble, ADClientAble, ELContAsgnAble, ELNamedElement
extends ELContainerAble, ELUUIDAble, ADClientAble, ELContAsgnAble, ELNamedElement

The currently active change set of the assigned users.

See Also:: ADChangeSetHelper

Nested Class Summary
`static class`	`ADChangeSet.VAttr`

Method Summary
`ARG_ChangeSetOverview`	`getChangeSetOverview()` Overview for all instances created, modified or deleted within this change set.
`List<ARG_ChangeSetWorkStep>`	`getChangeSetWorkSteps(String strModel, String strRep)` Returns the list of modeling steps of this `ADChangeSet`.
`Date`	`getEndtime()` Returns the end timestamp of the latest `ADChangeSetFragment` of this the current object.
`String`	`getExternalId()` Id in an external tracking system.
`String`	`getExternalLink()` Link to an external tracking system.
`ADModel`	`getModel()` The `ADModel` that owns the current object.
`List<ARG_CSModelProgress>`	`getModelsWorkStepsProgress(boolean allModels)` Returns a list of change set models and their progress for all work steps.
`ARG_ModifyChangeSetProperties`	`getModifyChangeSetPropertiesDlgInit()` Returns the properties for the modification of a `ADChangeSet`.
`String`	`getNote()` Returns the note for this change set.
`List<ADChangeSetFragment>`	`getOwnedFragment(K_CONTROL_OPTION... behaviourFlags)` The change set fragments owned by the current object.
`List<ADCSOperation>`	`getOwnedOperation(K_CONTROL_OPTION... behaviourFlags)` All operations owned by the current object.
`List<ADCSWorkStep>`	`getOwnedWorkStep(K_CONTROL_OPTION... behaviourFlags)` All modeling steps owned by the current object.
`Date`	`getStarttime()` Returns the start timestamp of the earliest `ADChangeSetFragment` of this the current object.
`void`	`joinChangeSet()` Join an existing `ADChangeSet`.
`void`	`mergeChangeSet(String strNote)` Moves all contents of the active `ADChangeSet` to this `ADChangeSet`.
`void`	`modifyChangeSetLink(String strLink, String strId)` Modifies the link to an external system of a `ADChangeSet`.
`void`	`modifyChangeSetProperties(String strName, String strNote, String strLink, String strId)` Modifies the properties of a `ADChangeSet`.
`void`	`setExternalId(String value)` Set the value of Attribut ExternalId.
`void`	`setExternalLink(String value)` Set the value of Attribut ExternalLink.
`void`	`setNote(String value)` Set the value of Attribut Note.

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELContainerAble
getCheckSetNotToLocalizeAttribute, getClientDependency, getNotToLocalizeAttribute, getOwnedElement, getOwnedElementTransitiveDown, getOwnedElementTransitiveDown, getOwnedElementTransitiveDownAndUnresolved, getOwnedElementTransitiveDownAndUnresolved, getOwnedLocalizedValue, getOwnedOrReferencedElementTransitiveDown, getOwnedOrReferencedElementTransitiveDown, getOwnedRelshipBinDirWithTarget, getOwnedRelshipBinDirWithTarget, getRedirectedModelContainer, getRelshipBinDirSource, getSelfAndOwnedElementTransitiveDown, getSelfAndOwnedElementTransitiveDown, getSortedContents, resetNotToLocalizeAttribute, setNotToLocalizeAttribute, sortContents

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELContainerAble

getCheckSetNotToLocalizeAttribute, getClientDependency, getNotToLocalizeAttribute, getOwnedElement, getOwnedElementTransitiveDown, getOwnedElementTransitiveDown, getOwnedElementTransitiveDownAndUnresolved, getOwnedElementTransitiveDownAndUnresolved, getOwnedLocalizedValue, getOwnedOrReferencedElementTransitiveDown, getOwnedOrReferencedElementTransitiveDown, getOwnedRelshipBinDirWithTarget, getOwnedRelshipBinDirWithTarget, getRedirectedModelContainer, getRelshipBinDirSource, getSelfAndOwnedElementTransitiveDown, getSelfAndOwnedElementTransitiveDown, getSortedContents, resetNotToLocalizeAttribute, setNotToLocalizeAttribute, sortContents

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELDeleteAble
`delete`

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELUUIDAble
`getUUID, setUUID`

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADClientAble
`getAnnotation, getLogic, getLogic, getPresentationContext, getSection`

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADM2AttrModifyAble
`getTabCell, getTabCellObjectList, getTabCreateTemplate, getTabCreateTemplateObjectList, getTabElement, getTabElementRowList, getTabElementRowTypeList, getTabRowList, tabCellModify, tabCreateTemplate, tabElementModify`

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELContAsgnAble
`getAsgnKind, getContSortOrder, getFirstOwnerWhichIsConformTo, getOwner, getOwnerTransitive, getOwnerTransitive, getSelfAndOwnerTransitive, getSelfAndOwnerTransitive, getVersionRoot, isTransitiveChildOf, setAsgnKind, setContSortOrder, setOwner`

Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELNamedElement
`getName, getNameKind, getQualifiedDisplayName, getQualifiedName, getQualifiedTLName, getResetDefaultName, getSupplierDependency, rename, setName, setNameKind, setResetDefaultName`

Method Detail

getChangeSetOverview

ARG_ChangeSetOverview getChangeSetOverview()
                                           throws InoNetException,
                                                  SrvErrorException

Overview for all instances created, modified or deleted within this change set.

Throws:: InoNetException; SrvErrorException

getChangeSetWorkSteps

List<ARG_ChangeSetWorkStep> getChangeSetWorkSteps(String strModel,
                                                  String strRep)
                                                  throws InoNetException,
                                                         SrvErrorException

Returns the list of modeling steps of this ADChangeSet. To calculate the state of the modeling steps a model may be specified.

Parameters:: strModel - name of the referenced innovator model, ignored if empty; strRep - name of the repository or empty if the own repository is referenced
Throws:: InoNetException; SrvErrorException

getEndtime

Date getEndtime()
                throws InoNetException,
                       SrvErrorException

Returns the end timestamp of the latest ADChangeSetFragment of this the current object.

Throws:: InoNetException; SrvErrorException

getExternalId

String getExternalId()
                     throws InoNetException,
                            SrvErrorException

Id in an external tracking system.

Throws:: InoNetException; SrvErrorException

getExternalLink

String getExternalLink()
                       throws InoNetException,
                              SrvErrorException

Link to an external tracking system.

Throws:: InoNetException; SrvErrorException

getModel

ADModel getModel()
                 throws InoNetException,
                        SrvErrorException

The ADModel that owns the current object.

Throws:: InoNetException; SrvErrorException

getModelsWorkStepsProgress

List<ARG_CSModelProgress> getModelsWorkStepsProgress(boolean allModels)
                                                     throws InoNetException,
                                                            SrvErrorException

Returns a list of change set models and their progress for all work steps. Each entry contains a list of work steps with state and reason. For the empty model name the list of work steps contains the note of each work step, for all other models this note is empty.

Parameters:: allModels - if true the result contains all known external models, otherwise the result contains all external models used for work steps of this change set
Throws:: InoNetException; SrvErrorException

getModifyChangeSetPropertiesDlgInit

ARG_ModifyChangeSetProperties getModifyChangeSetPropertiesDlgInit()
                                                                  throws InoNetException,
                                                                         SrvErrorException

Returns the properties for the modification of a ADChangeSet.

Throws:: InoNetException; SrvErrorException

getNote

String getNote()
               throws InoNetException,
                      SrvErrorException

Returns the note for this change set.

Throws:: InoNetException; SrvErrorException

getOwnedFragment

List<ADChangeSetFragment> getOwnedFragment(K_CONTROL_OPTION... behaviourFlags)
                                           throws InoNetException,
                                                  SrvErrorException

The change set fragments owned by the current object.

Parameters:: behaviourFlags - An optional list of enum values to control the behaviour of the command.
Throws:: InoNetException; SrvErrorException
Sorted:: the result may be sorted.

getOwnedOperation

List<ADCSOperation> getOwnedOperation(K_CONTROL_OPTION... behaviourFlags)
                                      throws InoNetException,
                                             SrvErrorException

All operations owned by the current object.

Parameters:: behaviourFlags - An optional list of enum values to control the behaviour of the command.
Throws:: InoNetException; SrvErrorException
Sorted:: the result may be sorted.

getOwnedWorkStep

List<ADCSWorkStep> getOwnedWorkStep(K_CONTROL_OPTION... behaviourFlags)
                                    throws InoNetException,
                                           SrvErrorException

All modeling steps owned by the current object.

Parameters:: behaviourFlags - An optional list of enum values to control the behaviour of the command.
Throws:: InoNetException; SrvErrorException
Sorted:: the result may be sorted.

getStarttime

Date getStarttime()
                  throws InoNetException,
                         SrvErrorException

Returns the start timestamp of the earliest ADChangeSetFragment of this the current object.

Throws:: InoNetException; SrvErrorException

joinChangeSet

void joinChangeSet()
                   throws InoNetException,
                          SrvErrorException

Join an existing ADChangeSet. The actual change set is automatically finished.

Throws:: InoNetException; SrvErrorException

mergeChangeSet

void mergeChangeSet(String strNote)
                    throws InoNetException,
                           SrvErrorException

Moves all contents of the active ADChangeSet to this ADChangeSet. As result this change set becomes active and the former active change set is deleted.

Parameters:: strNote - change set description
Throws:: InoNetException; SrvErrorException

modifyChangeSetLink

void modifyChangeSetLink(String strLink,
                         String strId)
                         throws InoNetException,
                                SrvErrorException

Modifies the link to an external system of a ADChangeSet.

Parameters:: strLink - link to an external tracking system; strId - id at an external tracking system
Throws:: InoNetException; SrvErrorException

modifyChangeSetProperties

void modifyChangeSetProperties(String strName,
                               String strNote,
                               String strLink,
                               String strId)
                               throws InoNetException,
                                      SrvErrorException

Modifies the properties of a ADChangeSet.

Parameters:: 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

setExternalId

void setExternalId(String value)
                   throws InoNetException,
                          SrvErrorException

Set the value of Attribut ExternalId.

Parameters:: value - The value to be set.
Throws:: InoNetException; SrvErrorException

setExternalLink

void setExternalLink(String value)
                     throws InoNetException,
                            SrvErrorException

Set the value of Attribut ExternalLink.

Parameters:: value - The value to be set.
Throws:: InoNetException; SrvErrorException

setNote

void setNote(String value)
             throws InoNetException,
                    SrvErrorException

Set the value of Attribut Note.

Parameters:: value - The value to be set.
Throws:: InoNetException; SrvErrorException