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 ADCSWorkStep

All Superinterfaces:
ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELObject
public interface ADCSWorkStep
extends ELContainerAble, ELContAsgnAble

Nested Class Summary
static class ADCSWorkStep.VAttr
           
 
Method Summary
 void addWorkStepInstances(List<? extends ADCSInstance> seqInst, boolean replaceExisting)
          Adds a list of instances to this ADCSWorkStep.
 ADChangeSet getChangeSet()
          The change set that owns the current object.
 String getNote()
          Returns the note for this ADCSWorkStep.
 List<ADCSWorkStepInstance> getOwnedWorkStepInstance(K_CONTROL_OPTION... behaviourFlags)
          All instances of a modeling step assigned to this ADCSWorkStep.
 List<ADCSWorkStepModel> getOwnedWorkStepModel(K_CONTROL_OPTION... behaviourFlags)
          All models of modeling steps owned by this ADCSWorkStep.
 void removeWorkStepInstances(List<? extends ADCSInstance> seqInst, boolean removeAll)
          Removes a list of instances from this ADCSWorkStep.
 void setNote(String value)
          Set the value of Attribut Note.
 void setWorkStepModel(String strModel, String strRep, String strBitmap, K_CS_WORKSTEP kState, String strReason)
          Marks this ADCSWorkStep as done or ignored for the specified innovator model.
 
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.ELElement
duplicateElement, getAssignAbleToVattr, getAssignAbleToVattr, getClientId, getCreateTemplateOfInstance, getDisplayBitmap, getDisplayColor, getDisplayFont, getDisplayLine, getDisplayName, getDisplayNameShort, getDisplayNSName, getElementCache, getElementMappingInformation, getQualifiedNamespaceName, getRelshipBinDir, getRelshipBinDir, getRelshipBinDirTarget, getUnitToLock, getValSpecElement, isContainedInProfile, isUnresolved, lockUnit, setUnresolved, unlockUnit
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELObject
getId, getLongId, getMetaClass, getMetaName, getOclClass, getSrvCon, hasRead
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELContAsgnAble
getAsgnKind, getContSortOrder, getFirstOwnerWhichIsConformTo, getOwner, getOwnerTransitive, getOwnerTransitive, getSelfAndOwnerTransitive, getSelfAndOwnerTransitive, getVersionRoot, isTransitiveChildOf, setAsgnKind, setContSortOrder, setOwner
 

Method Detail

addWorkStepInstances

void addWorkStepInstances(List<? extends ADCSInstance> seqInst,
                          boolean replaceExisting)
                          throws InoNetException,
                                 SrvErrorException
Adds a list of instances to this ADCSWorkStep.

Parameters:
seqInst - list of instances to be added
replaceExisting - true, if all existing instances are removed and replaced by the specified instances, otherwise the list is added
Throws:
InoNetException
SrvErrorException

getChangeSet

ADChangeSet getChangeSet()
                         throws InoNetException,
                                SrvErrorException
The change set that owns the current object.

Throws:
InoNetException
SrvErrorException

getNote

String getNote()
               throws InoNetException,
                      SrvErrorException
Returns the note for this ADCSWorkStep.

Throws:
InoNetException
SrvErrorException

getOwnedWorkStepInstance

List<ADCSWorkStepInstance> getOwnedWorkStepInstance(K_CONTROL_OPTION... behaviourFlags)
                                                    throws InoNetException,
                                                           SrvErrorException
All instances of a modeling step assigned to this ADCSWorkStep.

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

getOwnedWorkStepModel

List<ADCSWorkStepModel> getOwnedWorkStepModel(K_CONTROL_OPTION... behaviourFlags)
                                              throws InoNetException,
                                                     SrvErrorException
All models of modeling steps owned by this ADCSWorkStep.

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

removeWorkStepInstances

void removeWorkStepInstances(List<? extends ADCSInstance> seqInst,
                             boolean removeAll)
                             throws InoNetException,
                                    SrvErrorException
Removes a list of instances from this ADCSWorkStep.

Parameters:
seqInst - list of instances to be removed
removeAll - true, if all instances are removed, otherwise only the specified instances are removed
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

setWorkStepModel

void setWorkStepModel(String strModel,
                      String strRep,
                      String strBitmap,
                      K_CS_WORKSTEP kState,
                      String strReason)
                      throws InoNetException,
                             SrvErrorException
Marks this ADCSWorkStep as done or ignored for the specified innovator model.

Parameters:
strModel - name of the referenced innovator model
strRep - name of the repository or empty if the own repository is referenced
strBitmap - bitmap of the referenced innovator model, ignored if empty
kState - state of this modeling step at the referenced innovator model
strReason - optional reason why this state is used
Throws:
InoNetException
SrvErrorException
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

© MID GmbH, All rights reserved.