Package de.mid.innovator.srv2api.icw2meta

Interface ADLockAble

All Superinterfaces:

ADAccessAble, ADFindAble, ADHistoryAble, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELNamedElement, ELNamespaceAsgnAble, ELObject, ELPackageAble, ELUUIDAble

All Known Subinterfaces:

ACActivity, ADApplicationConfiguration, ADConfigTranslation, ADModel, ADModelTranslation, ADTranslationAble, ADVersionAble, ADXModel, BCExpression, BCPropertySet, BCRootReuseAbleElement, BCTerm, BEAnyReceiveEvent, BEBehavior, BECallEvent, BEChangeEvent, BEEvent, BEMessageEvent, BEOpaque, BESignalEvent, BETimeEvent, BI2Cube, BI2DimensionTree, BI2MeasurementTime, BIHierarchy, BIHierarchyRole, BPCallAble, BPCallAbleChoreographyElement, BPCallAbleProcessElement, BPChoreography, BPCollaboration, BPConditionalEventDefinition, BPDataStore, BPDia, BPEndPoint, BPError, BPEscalation, BPEventDefinition, BPGlobalChoreographyTask, BPGlobalMaskTask, BPGlobalTask, BPInterface, BPItemDefinition, BPLinkEventDefinition, BPMaskDefinition, BPMessage, BPPath, BPProcess, BPSignal, BPTimerEventDefinition, BRCostCenter, BRDia, BRLocation, BROrgUnit, BRPerson, BRResource, BRResourceCL, BRRole, BRTechnical, BSDia, BSFinalState, BSRegularState, BSState, CLActor, CLArtifact, CLAssocClass, CLAssociation, CLBehavioredClassifier, CLClass, CLClassDia, CLClassifier, CLCollaboration, CLCommunicationPath, CLComponent, CLComponentDia, CLCompositeStructureDia, CLDataType, CLDeclarationAbleClassifier, CLDeploymentDia, CLDeploymentSpec, CLDevice, CLDia, CLEncapsulatedClassifier, CLEnumeration, CLExecEnv, CLHierarchyAbleDia, CLInstanceSpecification, CLInterface, CLNode, CLPrimitiveType, CLRequirementDia, CLSignal, CLStructuredClassifier, CLStructureDefinition, CLStructureDefinitionDia, CLTemplateParameterAbleClass, CLUseCase, CLUseCaseDia, DBAuthorizationIdentifier, DBCheckConstraint, DBColumnSet, DBConnection, DBDia, DBGroup, DBPackage, DBRole, DBSiblingConstraint, DBSQLGeneric, DBStoredProcedure, DBTable, DBUser, DBView, DRBusinessKnowledgeModel, DRDecision, DRDecisionRequirementDia, DRDecisionService, DRGElement, DRInputData, DRInvocable, DRKnowledgeSource, ERAttributeSet, ERCheckConstraint, ERDia, ERDiaAll, EREntity, ERRelationship, ERView, GCConcept, GCDia, IAInteraction, IMAssociation, IMClassifier, IMCLDataType, IMConstraint, IMDia, IMProcedure, IMSemanticDataType, IMSequence, MEAttachment, MEConfigurationManagement, MEConstraint, MEHierarchyAble, MEMappingConfigurationPackage, MEMappingConfigurationPackageForward, MEMappingConfigurationPackageReverse, MEMappingPackageContent, MEMappingPackageType, MEMappingPackageTypeForward, MEMappingPackageTypeReverse, MEModel, MEPackage, MEProxy, MEProxyExternal, MEProxyInnovator, MERequirement, MESection, MEStubPackage, MEStubPackageBase, MEStubPackageExternalModel, MEStubPackageInnovator, MESystemModel, MESystemModelManagement, MM2SchemaTranslation, MMProfile, MMProfileTranslation, MMSyncProfile, MMXProfile, PRAnalysisDia, PRDiaWhiteboard, PRVersionAbleDia, SMProtocolStateMachine, SMStateMachine

public interface ADLockAble
extends ADHistoryAble, ELPackageAble, ADAccessAble

Elements which can be locked by a user.

See Also:

ADLockAbleHelper

Note:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ADLockAble.VAttr

Method Summary

Modifier and Type	Method	Description
ADLock	getLock()	The lock of the current object.
ARG_LockableCache	getLockableCache()	Gets important information of the lockable element all at once.
ADLogin	getLockLogin()	Returns the login which has locked the current object.
java.lang.String	getLockName()	Returns the name of the user who has locked the current object.
boolean	hasClutch(ADLogin refObj)	Returns true if the current login has access to change the current object and the current object is not locked by another login.
boolean	hasLock()	Returns true if the current object is locked.
boolean	hasNoLock()	Returns true if the current object is not locked.
boolean	hasOthLock(ADLogin refObj)	Returns true if the current object is locked by a login from anyone else except the current login.
boolean	hasOwnLock(ADLogin refObj)	Returns true if the current object is locked by the current login.
boolean	isLockable(ADLogin refObj)	Returns true if the current login is able to lock the current object.
void	lock()	Creates a lock for the current object.
void	unlock()	Deletes the lock for the current object.

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADAccessAble

getAccessRole, getReadRole, hasAccess, setAccessRole, setReadRole

Methods inherited from interface de.mid.innovator.srv2api.icw2meta.ADHistoryAble

getCreateTime, getCreator, getHistory, getModifier, getModifyTime, modifyHistory, setHistory

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

getClientDependency, getOwnedElement, getOwnedElementTransitiveDown, getOwnedElementTransitiveDown, getOwnedElementTransitiveDownAndUnresolved, getOwnedElementTransitiveDownAndUnresolved, getOwnedOrReferencedElementTransitiveDown, getOwnedOrReferencedElementTransitiveDown, getOwnedRelshipBinDirWithTarget, getOwnedRelshipBinDirWithTarget, getRedirectedModelContainer, getRelshipBinDirSource, getSelfAndOwnedElementTransitiveDown, getSelfAndOwnedElementTransitiveDown, getSortedContents, sortContents

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.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.ELNamedElement

getName, getNameKind, getQualifiedDisplayName, getQualifiedName, getQualifiedTLName, getSupplierDependency, rename, setName, setNameKind

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

getMnClassicTREFName, getNamespace, getNamespaceName, getPath, getSeparator, getVisibility, setUniqueName, setVisibility

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.ELPackageAble

getElementImportingNamespace, getElementImportingNamespace, getImportedPackageAble, getOwningPackage

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

getHyperlinkReferenceAble, getNotToTranslateAttribute, getTranslatedValue, getUUID, setUUID

Method Detail

hasClutch

boolean hasClutch(ADLogin refObj)
           throws InoNetException,
                  SrvErrorException

Returns true if the current login has access to change the current object and the current object is not locked by another login. If another login is given by argument refObj, this one is used instead.

Parameters:

refObj - A further instance of type ADLogin which is used to control the behaviour of the method. (see description above) This parameter is optional. (Its value can be given as null.)

Throws:

InoNetException

SrvErrorException

hasLock

boolean hasLock()
         throws InoNetException,
                SrvErrorException

Returns true if the current object is locked.

Throws:

InoNetException

SrvErrorException

hasNoLock

boolean hasNoLock()
           throws InoNetException,
                  SrvErrorException

Returns true if the current object is not locked.

Throws:

InoNetException

SrvErrorException

hasOthLock

boolean hasOthLock(ADLogin refObj)
            throws InoNetException,
                   SrvErrorException

Returns true if the current object is locked by a login from anyone else except the current login. If another login is given by argument refObj, this one is used instead.

Parameters:

refObj - A further instance of type ADLogin which is used to control the behaviour of the method. (see description above) This parameter is optional. (Its value can be given as null.)

Throws:

InoNetException

SrvErrorException

hasOwnLock

boolean hasOwnLock(ADLogin refObj)
            throws InoNetException,
                   SrvErrorException

Returns true if the current object is locked by the current login. If another login is given by argument refObj, this one is used instead.

Parameters:

refObj - A further instance of type ADLogin which is used to control the behaviour of the method. (see description above) This parameter is optional. (Its value can be given as null.)

Throws:

InoNetException

SrvErrorException

isLockable

boolean isLockable(ADLogin refObj)
            throws InoNetException,
                   SrvErrorException

Returns true if the current login is able to lock the current object. If another login is given by argument refObj, this one is used instead.

Parameters:

refObj - A further instance of type ADLogin which is used to control the behaviour of the method. (see description above) This parameter is optional. (Its value can be given as null.)

Throws:

InoNetException

SrvErrorException

getLockName

java.lang.String getLockName()
                      throws InoNetException,
                             SrvErrorException

Returns the name of the user who has locked the current object.

Throws:

InoNetException

SrvErrorException

getLockLogin

ADLogin getLockLogin()
              throws InoNetException,
                     SrvErrorException

Returns the login which has locked the current object.

Throws:

InoNetException

SrvErrorException

getLockableCache

ARG_LockableCache getLockableCache()
                            throws InoNetException,
                                   SrvErrorException

Gets important information of the lockable element all at once.

Throws:

InoNetException

SrvErrorException

lock

void lock()
   throws InoNetException,
          SrvErrorException

Creates a lock for the current object.

Throws:

InoNetException

SrvErrorException

unlock

void unlock()
     throws InoNetException,
            SrvErrorException

Deletes the lock for the current object.

Throws:

InoNetException

SrvErrorException

getLock

ADLock getLock()
        throws InoNetException,
               SrvErrorException

The lock of the current object.

Throws:

InoNetException

SrvErrorException