Package de.mid.innovator.srv2api.icw2meta

Interface ADLogin

All Superinterfaces:

ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELObject, ELUUIDAble

public interface ADLogin
extends ELContainerAble, ELContAsgnAble

Represents a single login for a user.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ADLogin.VAttr

Method Summary

Modifier and Type	Method	Description
Date	getAccessTime()	Returns the recent access time of the current object.
String	getDisplay()	Returns the display's name for the current object.
String	getHost()	Returns the host's name for the current object.
MM2Locale	getLocale()	The MM2Locale used as display language by this ADLogin.
ARG_Ask	getLockMessage(List<? extends ELElement> seq)	Returns the lock messages of all specified elements.
List<ARG_LockRecursiveEntry>	getLockRecursiveCheck(List<? extends ADClientAble> seqSel)	Checks whether all selected elements may be locked recursively.
ADLoginAble	getLoginAble()	The element that owns the current object.
ARG_LoginCache	getLoginCache()	Gets important information of the login all at once.
K_LOGSTATUS	getLogStatus()	Returns the current object's login status.
ADMdlAdmin	getMdlAdmin()	The model administrator of the current object.
ADMdlGeneratorSvg	getMdlGeneratorSvg()	The SVG generation of the current object.
ADMdlUser	getMdlUser()	The model user of the current object.
List<ADLock>	getOwnedLock(K_CONTROL_OPTION... behaviourFlags)	The locks which are owned by the current object.
List<ADUsrRole>	getPossibleRole()	Returns all roles available for the current object.
ADRepAdmin	getRepAdmin()	The the current object's repository administrator.
MESection	getRestrictingSection()	The MESection which restrict the visible elements for this ADLogin.
String	getRoleName()	Returns the current role's name for the current object.
ARG_UndoRedoAbleOut	getUndoRedoAble()	Is undo and redo possible.
<T extends ADClientAble> List<T>	getUndoRedoDeletedElements(Class<T> returnType, boolean item)	Returns a list of all elements which will be deleted by the following undo or redo command.
ARG_GetUndoRedoList	getUndoRedoList(int cntMaxUndo, int cntMaxRedo)	Returns lists of command names which may be used for undo or redo.
boolean	getUseAllRoles()	Returns true, if all possible roles are evaluated as execution rights of the current object.
ADUsrRole	getUsrRole()	Returns the role of the current object.
boolean	hasOperationMode(K_OPERATIONMODE kind)	Returns true, if the current object's user privileges match the argument kind.
boolean	hasReadRestriction()	Returns false, if the current object can read all elements of the current model.
boolean	isAdmin()	Returns true, if the current object has administrator status.
boolean	isInactive()	Returns true, if the current object is inactive.
boolean	isReadOnlyLogin()	Returns true, if the current role of the current object has no access to any element and no execution right to any menu item.
boolean	isSuperUser()	Returns true, if the current object is logged-in as a super user.
void	lock(List<? extends ELElement> seq)	If no selection is made, it locks all elements possible for the login.
void	lockRecursive(List<? extends ADClientAble> seqSel)	Locks all selected elements recursively.
void	modifyIgnoreConfiguration(boolean item)	Modifies the ignore configuration flag for the current object.
void	modifyPassword(String oldPass, String newPass)	Modifies the password for the current object.
void	modifyRole(String role)	Changes the role for the current object.
ARG_Undo	redo()	Reverts the effects of the undo-command most recently executed by this login.
void	setDisplayLocale(ELElement item)	Defines the MM2Locale which is used to display properties and string values in read only mode.
void	setUseAllRoles(boolean value)	Set the value of Attribut UseAllRoles.
void	setUsrRole(ADUsrRole value)	Set the value of Foreign Key UsrRole.
ARG_Undo	undo()	Reverts the effects of the command most recently executed by this login.
void	unlock(List<? extends ELElement> seq)	If no selection is made, it removes all element locks for the current object.
void	unlockRecursive(List<? extends ADClientAble> seqSel)	Unlocks all selected elements recursively.

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, getNotificationElement, 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.ELUUIDAble

getHyperlinkReferenceAble, getInnoRef, getNotToTranslateAttribute, getTranslatedValue, getUUID, setUUID

Method Details

isSuperUser

boolean isSuperUser()
             throws InoNetException,
SrvErrorException

Returns true, if the current object is logged-in as a super user.

Throws:

InoNetException

SrvErrorException

getAccessTime

Date getAccessTime()
            throws InoNetException,
SrvErrorException

Returns the recent access time of the current object.

Throws:

InoNetException

SrvErrorException

getHost

String getHost()
        throws InoNetException,
SrvErrorException

Returns the host's name for the current object.

Throws:

InoNetException

SrvErrorException

getDisplay

String getDisplay()
           throws InoNetException,
SrvErrorException

Returns the display's name for the current object.

Throws:

InoNetException

SrvErrorException

getUseAllRoles

boolean getUseAllRoles()
                throws InoNetException,
SrvErrorException

Returns true, if all possible roles are evaluated as execution rights of the current object. Otherwise only the active role is evaluated.

Throws:

InoNetException

SrvErrorException

setUseAllRoles

void setUseAllRoles(boolean value)
             throws InoNetException,
SrvErrorException

Set the value of Attribut UseAllRoles.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

hasOperationMode

boolean hasOperationMode(K_OPERATIONMODE kind)
                  throws InoNetException,
SrvErrorException

Returns true, if the current object's user privileges match the argument kind.

Parameters:

kind - A value of type K_OPERATIONMODE that controls the behaviour of the underlying method. (see description)

Throws:

InoNetException

SrvErrorException

isAdmin

boolean isAdmin()
         throws InoNetException,
SrvErrorException

Returns true, if the current object has administrator status.

Throws:

InoNetException

SrvErrorException

getLogStatus

K_LOGSTATUS getLogStatus()
                  throws InoNetException,
SrvErrorException

Returns the current object's login status.

Throws:

InoNetException

SrvErrorException

getRoleName

String getRoleName()
            throws InoNetException,
SrvErrorException

Returns the current role's name for the current object.

Throws:

InoNetException

SrvErrorException

isReadOnlyLogin

boolean isReadOnlyLogin()
                 throws InoNetException,
SrvErrorException

Returns true, if the current role of the current object has no access to any element and no execution right to any menu item.

Throws:

InoNetException

SrvErrorException

hasReadRestriction

boolean hasReadRestriction()
                    throws InoNetException,
SrvErrorException

Returns false, if the current object can read all elements of the current model.

Throws:

InoNetException

SrvErrorException

isInactive

boolean isInactive()
            throws InoNetException,
SrvErrorException

Returns true, if the current object is inactive.

Throws:

InoNetException

SrvErrorException

getPossibleRole

List<ADUsrRole> getPossibleRole()
                         throws InoNetException,
SrvErrorException

Returns all roles available for the current object.

Throws:

InoNetException

SrvErrorException

getRestrictingSection

MESection getRestrictingSection()
                         throws InoNetException,
SrvErrorException

The MESection which restrict the visible elements for this ADLogin.

Throws:

InoNetException

SrvErrorException

getUndoRedoAble

ARG_UndoRedoAbleOut getUndoRedoAble()
                             throws InoNetException,
SrvErrorException

Is undo and redo possible.

Throws:

InoNetException

SrvErrorException

getUndoRedoDeletedElements

<T extends ADClientAble> List<T> getUndoRedoDeletedElements(Class<T> returnType,
 boolean item)
                                                     throws InoNetException,
SrvErrorException

Returns a list of all elements which will be deleted by the following undo or redo command. The parameter is true, if undo is evaluated.

Parameters:

returnType - Specifies the type of elements to be returned.

item -

Throws:

InoNetException

SrvErrorException

getUndoRedoList

ARG_GetUndoRedoList getUndoRedoList(int cntMaxUndo,
 int cntMaxRedo)
                             throws InoNetException,
SrvErrorException

Returns lists of command names which may be used for undo or redo. The parameters may be used to restrict the maximum number of commands. Parameter value 0 returns all commands, value -1 returns none.

Parameters:

cntMaxUndo - maximum of required undo commands

cntMaxRedo - maximum of required redo commands

Throws:

InoNetException

SrvErrorException

getLockMessage

ARG_Ask getLockMessage(List<? extends ELElement> seq)
                throws InoNetException,
SrvErrorException

Returns the lock messages of all specified elements.

Parameters:

seq - List of ELElement

Throws:

InoNetException

SrvErrorException

getLockRecursiveCheck

List<ARG_LockRecursiveEntry> getLockRecursiveCheck(List<? extends ADClientAble> seqSel)
                                            throws InoNetException,
SrvErrorException

Checks whether all selected elements may be locked recursively. The result contains all elements which are not allowed to lock.

Parameters:

seqSel - list of elements for recursive lock/unlock command

Throws:

InoNetException

SrvErrorException

getLoginCache

ARG_LoginCache getLoginCache()
                      throws InoNetException,
SrvErrorException

Gets important information of the login all at once.

Throws:

InoNetException

SrvErrorException

lock

void lock(List<? extends ELElement> seq)
   throws InoNetException,
SrvErrorException

If no selection is made, it locks all elements possible for the login. Otherwise, it tries to lock the given selection.

Parameters:

seq - ELElement optional sequence of elements

Throws:

InoNetException

SrvErrorException

lockRecursive

void lockRecursive(List<? extends ADClientAble> seqSel)
            throws InoNetException,
SrvErrorException

Locks all selected elements recursively.

Parameters:

seqSel - list of elements for recursive lock/unlock command

Throws:

InoNetException

SrvErrorException

modifyIgnoreConfiguration

void modifyIgnoreConfiguration(boolean item)
                        throws InoNetException,
SrvErrorException

Modifies the ignore configuration flag for the current object.

Parameters:

item -

Throws:

InoNetException

SrvErrorException

modifyPassword

void modifyPassword(String oldPass,
 String newPass)
             throws InoNetException,
SrvErrorException

Modifies the password for the current object.

Parameters:

oldPass - current password

newPass - new password

Throws:

InoNetException

SrvErrorException

modifyRole

void modifyRole(String role)
         throws InoNetException,
SrvErrorException

Changes the role for the current object.

Parameters:

role - new role

Throws:

InoNetException

SrvErrorException

redo

ARG_Undo redo()
       throws InoNetException,
SrvErrorException

Reverts the effects of the undo-command most recently executed by this login.

Throws:

InoNetException

SrvErrorException

setDisplayLocale

void setDisplayLocale(ELElement item)
               throws InoNetException,
SrvErrorException

Defines the MM2Locale which is used to display properties and string values in read only mode. If the value is empty the model language is used to display properties.

Parameters:

item - ELElement Optional Element

Throws:

InoNetException

SrvErrorException

undo

ARG_Undo undo()
       throws InoNetException,
SrvErrorException

Reverts the effects of the command most recently executed by this login.

Throws:

InoNetException

SrvErrorException

unlock

void unlock(List<? extends ELElement> seq)
     throws InoNetException,
SrvErrorException

If no selection is made, it removes all element locks for the current object. Otherwise, the given selection is unlocked.

Parameters:

seq - ELElement optional sequence of elements

Throws:

InoNetException

SrvErrorException

unlockRecursive

void unlockRecursive(List<? extends ADClientAble> seqSel)
              throws InoNetException,
SrvErrorException

Unlocks all selected elements recursively.

Parameters:

seqSel - list of elements for recursive lock/unlock command

Throws:

InoNetException

SrvErrorException

getUsrRole

ADUsrRole getUsrRole()
              throws InoNetException,
SrvErrorException

Returns the role of the current object.

Throws:

InoNetException

SrvErrorException

setUsrRole

void setUsrRole(ADUsrRole value)
         throws InoNetException,
SrvErrorException

Set the value of Foreign Key UsrRole.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getOwnedLock

List<ADLock> getOwnedLock(K_CONTROL_OPTION... behaviourFlags)
                   throws InoNetException,
SrvErrorException

The locks which are 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.

getLocale

MM2Locale getLocale()
             throws InoNetException,
SrvErrorException

The MM2Locale used as display language by this ADLogin.

Throws:

InoNetException

SrvErrorException

getLoginAble

ADLoginAble getLoginAble()
                  throws InoNetException,
SrvErrorException

The element that owns the current object.

Throws:

InoNetException

SrvErrorException

getMdlAdmin

ADMdlAdmin getMdlAdmin()
                throws InoNetException,
SrvErrorException

The model administrator of the current object.

Throws:

InoNetException

SrvErrorException

getMdlGeneratorSvg

ADMdlGeneratorSvg getMdlGeneratorSvg()
                              throws InoNetException,
SrvErrorException

The SVG generation of the current object.

Throws:

InoNetException

SrvErrorException

getMdlUser

ADMdlUser getMdlUser()
              throws InoNetException,
SrvErrorException

The model user of the current object.

Throws:

InoNetException

SrvErrorException

getRepAdmin

ADRepAdmin getRepAdmin()
                throws InoNetException,
SrvErrorException

The the current object's repository administrator.

Throws:

InoNetException

SrvErrorException