de.mid.innovator.srv2api.icw2bp
Interface BPInputOutputSpecifyAble

All Superinterfaces:
ELContainerAble, ELDeleteAble, ELElement, ELNamedElement, ELNamespaceAble, ELObject
All Known Subinterfaces:
BPActivityNode, BPCallAbleProcessElement, BPGlobalMaskTask, BPGlobalTask, BPMaskTask, BPProcess, BPSubProcess, BPTaskNode

public interface BPInputOutputSpecifyAble
extends ELNamespaceAble

This is a utility class for BPInputOutputSpecifyAble that provides static methods for creation or other purposes.

Note:
The interface BPInputOutputSpecifyAble describes an abstract ability of an object. Therefore no instances of this type can be found in the repository!

Nested Class Summary
static class BPInputOutputSpecifyAble.VAttr
           
 
Method Summary
 List<BPDataObject> getDataInput(K_CONTROL_OPTION... behaviourFlags)
          All data inputs at this BPInputOutputSpecifyAble.
 List<BPDataObject> getDataInput(MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)
          The method calls getDataInput and filters its return values according to the given stereotype value.
 List<BPDataObject> getDataOutput(K_CONTROL_OPTION... behaviourFlags)
          All data outputs at this BPInputOutputSpecifyAble.
 List<BPDataObject> getDataOutput(MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)
          The method calls getDataOutput and filters its return values according to the given stereotype value.
 String getFlowExpandedShortValue(MMText refObj, String pattern)
          Returns the formatted value of this element given by argument pattern or argument refObj where all fill-ins are expanded with short names.
 List<BPDataObject> getInputOutputObject(K_CONTROL_OPTION... behaviourFlags)
          All input and output objects.
 List<BPDataObject> getInputOutputObject(MMStereotype stereotype, K_CONTROL_OPTION... behaviourFlags)
          The method calls getInputOutputObject and filters its return values according to the given stereotype value.
 List<BPInputSet> getInputSet(K_CONTROL_OPTION... behaviourFlags)
          All BPInputSet of the BPInputOutputSpecifyAble.
 List<BPDataObject> getIODataObject(K_CONTROL_OPTION... behaviourFlags)
          All objects of the BPInputOutputSpecifyAble.
 List<BPDataObject> getIODataObjectByKind(K_BP_DATA_OBJECT_TYPE kind, K_CONTROL_OPTION... behaviourFlags)
          All objects with a given type.
 List<BPDataObject> getIODataObjectByKind(MMStereotype stereotype, K_BP_DATA_OBJECT_TYPE kind, K_CONTROL_OPTION... behaviourFlags)
          The method calls getIODataObjectByKind and filters its return values according to the given stereotype value.
 ARG_ModifyFlowDocumentsReq getModifyIOSpecs(boolean item)
          Returns information for the modification of input/output specification FlowDocuments of this element.
 List<BPOutputSet> getOutputSet(K_CONTROL_OPTION... behaviourFlags)
          All BPOutputSet of the BPInputOutputSpecifyAble.
 
Methods inherited from interface de.mid.innovator.srv2api.icw2elem.ELNamespaceAble
getElementImport, getImportedElement, getImportedElement, getImportedPackage, getImportedPackage, getMember, getMember, getMemberByPattern, getMemberByPattern, getOwnedConstraint, getOwnedMember, getOwnedMemberByPath, getOwnedMemberByPattern, getOwnedMemberByPattern, getOwnedMemberTransitiveByPattern, getOwnedMemberTransitiveByPattern, getOwnedMemberTransitiveByPatternIgnoreCase, getOwnedMemberTransitiveByPatternIgnoreCase, getPackageImport
 
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.ELNamedElement
getName, getNameKind, getQualifiedDisplayName, getQualifiedName, getQualifiedTLName, getResetDefaultName, getSupplierDependency, rename, setName, setNameKind, setResetDefaultName
 

Method Detail

getDataInput

List<BPDataObject> getDataInput(K_CONTROL_OPTION... behaviourFlags)
                                throws InoNetException,
                                       SrvErrorException
All data inputs at this BPInputOutputSpecifyAble.

Parameters:
behaviourFlags - An optional list of enum values to control the behaviour of the command.
Throws:
InoNetException
SrvErrorException

getDataInput

List<BPDataObject> getDataInput(MMStereotype stereotype,
                                K_CONTROL_OPTION... behaviourFlags)
                                throws InoNetException,
                                       SrvErrorException
The method calls getDataInput and filters its return values according to the given stereotype value.

Parameters:
stereotype - The stereotype used to filter the result list
behaviourFlags - An optional list of enum values to control the behaviour of the command.
Throws:
InoNetException
SrvErrorException

getDataOutput

List<BPDataObject> getDataOutput(K_CONTROL_OPTION... behaviourFlags)
                                 throws InoNetException,
                                        SrvErrorException
All data outputs at this BPInputOutputSpecifyAble.

Parameters:
behaviourFlags - An optional list of enum values to control the behaviour of the command.
Throws:
InoNetException
SrvErrorException

getDataOutput

List<BPDataObject> getDataOutput(MMStereotype stereotype,
                                 K_CONTROL_OPTION... behaviourFlags)
                                 throws InoNetException,
                                        SrvErrorException
The method calls getDataOutput and filters its return values according to the given stereotype value.

Parameters:
stereotype - The stereotype used to filter the result list
behaviourFlags - An optional list of enum values to control the behaviour of the command.
Throws:
InoNetException
SrvErrorException

getFlowExpandedShortValue

String getFlowExpandedShortValue(MMText refObj,
                                 String pattern)
                                 throws InoNetException,
                                        SrvErrorException
Returns the formatted value of this element given by argument pattern or argument refObj where all fill-ins are expanded with short names.

Parameters:
refObj - A further instance of type MMText which is used to control the behaviour of the method. (see description above) This parameter is optional. (Its value can be given as null.)
pattern - A string pattern. This parameter is optional. (Its value can be given as null.)
Throws:
InoNetException
SrvErrorException

getInputOutputObject

List<BPDataObject> getInputOutputObject(K_CONTROL_OPTION... behaviourFlags)
                                        throws InoNetException,
                                               SrvErrorException
All input and output objects.

Parameters:
behaviourFlags - An optional list of enum values to control the behaviour of the command.
Throws:
InoNetException
SrvErrorException

getInputOutputObject

List<BPDataObject> getInputOutputObject(MMStereotype stereotype,
                                        K_CONTROL_OPTION... behaviourFlags)
                                        throws InoNetException,
                                               SrvErrorException
The method calls getInputOutputObject and filters its return values according to the given stereotype value.

Parameters:
stereotype - The stereotype used to filter the result list
behaviourFlags - An optional list of enum values to control the behaviour of the command.
Throws:
InoNetException
SrvErrorException

getInputSet

List<BPInputSet> getInputSet(K_CONTROL_OPTION... behaviourFlags)
                             throws InoNetException,
                                    SrvErrorException
All BPInputSet of the BPInputOutputSpecifyAble.

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

getIODataObject

List<BPDataObject> getIODataObject(K_CONTROL_OPTION... behaviourFlags)
                                   throws InoNetException,
                                          SrvErrorException
All objects of the BPInputOutputSpecifyAble.

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

getIODataObjectByKind

List<BPDataObject> getIODataObjectByKind(K_BP_DATA_OBJECT_TYPE kind,
                                         K_CONTROL_OPTION... behaviourFlags)
                                         throws InoNetException,
                                                SrvErrorException
All objects with a given type.

Parameters:
kind - A value of type K_BP_DATA_OBJECT_TYPE that controls the behaviour of the underlying method. (see description)
behaviourFlags - An optional list of enum values to control the behaviour of the command.
Throws:
InoNetException
SrvErrorException

getIODataObjectByKind

List<BPDataObject> getIODataObjectByKind(MMStereotype stereotype,
                                         K_BP_DATA_OBJECT_TYPE kind,
                                         K_CONTROL_OPTION... behaviourFlags)
                                         throws InoNetException,
                                                SrvErrorException
The method calls getIODataObjectByKind and filters its return values according to the given stereotype value.

Parameters:
stereotype - The stereotype used to filter the result list
kind - A value of type K_BP_DATA_OBJECT_TYPE that controls the behaviour of the underlying method. (see description)
behaviourFlags - An optional list of enum values to control the behaviour of the command.
Throws:
InoNetException
SrvErrorException

getModifyIOSpecs

ARG_ModifyFlowDocumentsReq getModifyIOSpecs(boolean item)
                                            throws InoNetException,
                                                   SrvErrorException
Returns information for the modification of input/output specification FlowDocuments of this element.

Parameters:
item -
Throws:
InoNetException
SrvErrorException

getOutputSet

List<BPOutputSet> getOutputSet(K_CONTROL_OPTION... behaviourFlags)
                               throws InoNetException,
                                      SrvErrorException
All BPOutputSet of the BPInputOutputSpecifyAble.

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