Package de.mid.innovator.srv2api.icw2meta

Interface ADUsrRole

All Superinterfaces:

ADClientAble, ADM2AttrModifyAble, ELContainerAble, ELContAsgnAble, ELDeleteAble, ELElement, ELNamedElement, ELNamespaceAsgnAble, ELObject, ELUUIDAble

public interface ADUsrRole
extends ELContainerAble, ELNamespaceAsgnAble, ADClientAble

Roles are used for access and execution right. Getting these right a model user has to be assigned tho the role.

See Also:

• ADUsrRoleHelper

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ADUsrRole.VAttr

Method Summary

Modifier and Type	Method	Description
void	addOperationMode(K_OPERATIONMODE item)	Adds the privilege to the current object.
List<MMRoleExecution>	assignExecuteAble(MMProfile ohProfile, MM2Class ohClass, List<? extends ADExecuteAble> seqOh)	Assigns a list of executable elements to this user role.
void	copyRoleExecutionDlg(MMProfile ohProfile, MMProfile ohSrcProfile, ADUsrRole ohSrcRole, boolean copyAll, List<? extends ADExecuteAble> seqExec)	Copies the execution right from the specified user role to this user role.
<T extends ADAccessAble> List<T>	getAccessAble(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	Returns the elements which can be accessed by the current object.
ARG_CopyRoleExecutionDlgInitOut	getCopyRoleExecutionDlgInit(MMProfile ohProfile)	Fills the dialog for the copy of execution rights.
<T extends ADExecuteAble> List<T>	getExecuteAble(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	Return all executeable elements the the current object is allowed to execute.
List<ADLogin>	getLogin()	Returns the logins that use the current object.
List<ADMdlUser>	getMdlUser()	Returns the model users which are assigned to the current object.
List<ADMdlUser>	getMdlUserByPattern(String pattern, K_CONTROL_OPTION... behaviourFlags)	Returns the users which are assigned to the current object.
ADModel	getModel()	The model owning this user role.
int	getOperationModeMask()	Returns the current object's privileges as a mask.
<T extends ADAccessAble> List<T>	getReadAble(Class<T> returnType, K_CONTROL_OPTION... behaviourFlags)	Returns the elements which cannot be read by the current object.
List<MMRoleExecution>	getRoleExecution()	Returns role executions from the current object.
boolean	hasAnnotationMode()	Returns true, if the current object has privilege 'Edit Annotations'.
boolean	hasBulkMode()	Returns true, if the current object has privilege 'Use Bulk Commands'.
boolean	hasChangeSetMode()	Returns true, if the current object has privilege 'View Change Logs'.
boolean	hasComparingModelsMode()	Returns true, if the current object has privilege 'Compare Models'.
boolean	hasConfigMode()	Returns true, if the current object has privilege 'Configure'.
boolean	hasDBConnectMode()	Returns true, if the current object has privilege 'Configure Database Connections'.
boolean	hasDeletingChangeSetMode()	Returns true, if the current object has privilege 'Delete Change Sets'.
boolean	hasEditApplConfMode()	Returns true, if the current object has privilege 'Edit Model-Wide Configurations'.
boolean	hasEditHyphenationMode()	Returns true, if the current object has privilege 'Edit Hyphenation'.
boolean	hasExportingModelsMode()	Returns true, if the current object has privilege 'Export Models'.
boolean	hasLabelMode()	Returns true, if the current object has privilege 'Set Labels'.
boolean	hasNoDBDeletionMode()	Returns true, if the current object has privilege 'Do Not Delete In Databases'.
boolean	hasNoElementDeletionMode()	Returns true, if the current object has privilege 'Do Not Delete Elements'.
boolean	hasOperationMode(K_OPERATIONMODE kind)	Returns true, if the current object's privileges matches the argument kind.
boolean	hasSectionMode()	Returns true, if the current object has privilege 'Use Sections'.
boolean	hasTranslationMode()	Returns true, if the current object has privilege 'Translate Model Elements'.
boolean	hasVersionMode()	Returns true, if the current object has privilege 'Use Model Fragments'.
void	modifyAccess(List<? extends ADAccessAble> seqAccessAble, boolean giveAccess, boolean recursive)	Modifies the given elements' role access.
void	modifyRead(List<? extends ADAccessAble> seqAccessAble, boolean giveRead)	Modifies the given elements' role read permission.
void	removeOperationMode(K_OPERATIONMODE item)	Removes the privilege from the current object.
void	setAnnotationMode(boolean value)	Set the value of Info HasAnnotationMode.
void	setBulkMode(boolean value)	Set the value of Info HasBulkMode.
void	setChangeSetMode(boolean value)	Set the value of Info HasChangeSetMode.
void	setComparingModelsMode(boolean value)	Set the value of Info HasComparingModelsMode.
void	setConfigMode(boolean value)	Set the value of Info HasConfigMode.
void	setDBConnectMode(boolean value)	Set the value of Info HasDBConnectMode.
void	setDeletingChangeSetMode(boolean value)	Set the value of Info HasDeletingChangeSetMode.
void	setEditApplConfMode(boolean value)	Set the value of Info HasEditApplConfMode.
void	setEditHyphenationMode(boolean value)	Set the value of Info HasEditHyphenationMode.
void	setExportingModelsMode(boolean value)	Set the value of Info HasExportingModelsMode.
void	setLabelMode(boolean value)	Set the value of Info HasLabelMode.
void	setNoDBDeletionMode(boolean value)	Set the value of Info HasNoDBDeletionMode.
void	setNoElementDeletionMode(boolean value)	Set the value of Info HasNoElementDeletionMode.
void	setOperationModeMask(int value)	Set the value of Attribut OperationModeMask.
void	setSectionMode(boolean value)	Set the value of Info HasSectionMode.
void	setTranslationMode(boolean value)	Set the value of Info HasTranslationMode.
void	setVersionMode(boolean value)	Set the value of Info HasVersionMode.

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

getAnnotation, getEndAnalysisDia, getLogic, getLogic, getPresentationContext, getSection, getStartAnalysisDia

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

getTabCell, getTabCellObjectList, getTabCreateTemplate, getTabCreateTemplateObjectList, getTabElement, getTabElementRelshipTypeList, getTabElementRowList, getTabElementRowTypeList, getTabRelshipList, getTabRowList, tabCellModify, tabCreateTemplate, tabElementModify

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

getHyperlinkReferenceAble, getInnoRef, getNotToTranslateAttribute, getTranslatedValue, getUUID, setUUID

Method Details

getOperationModeMask

int getOperationModeMask()
                  throws InoNetException,
SrvErrorException

Returns the current object's privileges as a mask.

Throws:

InoNetException

SrvErrorException

setOperationModeMask

void setOperationModeMask(int value)
                   throws InoNetException,
SrvErrorException

Set the value of Attribut OperationModeMask.

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 privileges matches the argument kind.

Parameters:

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

Throws:

InoNetException

SrvErrorException

hasConfigMode

boolean hasConfigMode()
               throws InoNetException,
SrvErrorException

Returns true, if the current object has privilege 'Configure'.

Throws:

InoNetException

SrvErrorException

setConfigMode

void setConfigMode(boolean value)
            throws InoNetException,
SrvErrorException

Set the value of Info HasConfigMode.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

hasLabelMode

boolean hasLabelMode()
              throws InoNetException,
SrvErrorException

Returns true, if the current object has privilege 'Set Labels'.

Throws:

InoNetException

SrvErrorException

setLabelMode

void setLabelMode(boolean value)
           throws InoNetException,
SrvErrorException

Set the value of Info HasLabelMode.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

hasVersionMode

boolean hasVersionMode()
                throws InoNetException,
SrvErrorException

Returns true, if the current object has privilege 'Use Model Fragments'.

Throws:

InoNetException

SrvErrorException

setVersionMode

void setVersionMode(boolean value)
             throws InoNetException,
SrvErrorException

Set the value of Info HasVersionMode.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

hasAnnotationMode

boolean hasAnnotationMode()
                   throws InoNetException,
SrvErrorException

Returns true, if the current object has privilege 'Edit Annotations'.

Throws:

InoNetException

SrvErrorException

setAnnotationMode

void setAnnotationMode(boolean value)
                throws InoNetException,
SrvErrorException

Set the value of Info HasAnnotationMode.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

hasChangeSetMode

boolean hasChangeSetMode()
                  throws InoNetException,
SrvErrorException

Returns true, if the current object has privilege 'View Change Logs'.

Throws:

InoNetException

SrvErrorException

setChangeSetMode

void setChangeSetMode(boolean value)
               throws InoNetException,
SrvErrorException

Set the value of Info HasChangeSetMode.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

hasDeletingChangeSetMode

boolean hasDeletingChangeSetMode()
                          throws InoNetException,
SrvErrorException

Returns true, if the current object has privilege 'Delete Change Sets'.

Throws:

InoNetException

SrvErrorException

setDeletingChangeSetMode

void setDeletingChangeSetMode(boolean value)
                       throws InoNetException,
SrvErrorException

Set the value of Info HasDeletingChangeSetMode.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

hasTranslationMode

boolean hasTranslationMode()
                    throws InoNetException,
SrvErrorException

Returns true, if the current object has privilege 'Translate Model Elements'.

Throws:

InoNetException

SrvErrorException

setTranslationMode

void setTranslationMode(boolean value)
                 throws InoNetException,
SrvErrorException

Set the value of Info HasTranslationMode.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

hasSectionMode

boolean hasSectionMode()
                throws InoNetException,
SrvErrorException

Returns true, if the current object has privilege 'Use Sections'.

Throws:

InoNetException

SrvErrorException

setSectionMode

void setSectionMode(boolean value)
             throws InoNetException,
SrvErrorException

Set the value of Info HasSectionMode.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

hasDBConnectMode

boolean hasDBConnectMode()
                  throws InoNetException,
SrvErrorException

Returns true, if the current object has privilege 'Configure Database Connections'.

Throws:

InoNetException

SrvErrorException

setDBConnectMode

void setDBConnectMode(boolean value)
               throws InoNetException,
SrvErrorException

Set the value of Info HasDBConnectMode.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

hasNoDBDeletionMode

boolean hasNoDBDeletionMode()
                     throws InoNetException,
SrvErrorException

Returns true, if the current object has privilege 'Do Not Delete In Databases'.

Throws:

InoNetException

SrvErrorException

setNoDBDeletionMode

void setNoDBDeletionMode(boolean value)
                  throws InoNetException,
SrvErrorException

Set the value of Info HasNoDBDeletionMode.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

hasBulkMode

boolean hasBulkMode()
             throws InoNetException,
SrvErrorException

Returns true, if the current object has privilege 'Use Bulk Commands'.

Throws:

InoNetException

SrvErrorException

setBulkMode

void setBulkMode(boolean value)
          throws InoNetException,
SrvErrorException

Set the value of Info HasBulkMode.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

hasComparingModelsMode

boolean hasComparingModelsMode()
                        throws InoNetException,
SrvErrorException

Returns true, if the current object has privilege 'Compare Models'.

Throws:

InoNetException

SrvErrorException

setComparingModelsMode

void setComparingModelsMode(boolean value)
                     throws InoNetException,
SrvErrorException

Set the value of Info HasComparingModelsMode.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

hasExportingModelsMode

boolean hasExportingModelsMode()
                        throws InoNetException,
SrvErrorException

Returns true, if the current object has privilege 'Export Models'.

Throws:

InoNetException

SrvErrorException

setExportingModelsMode

void setExportingModelsMode(boolean value)
                     throws InoNetException,
SrvErrorException

Set the value of Info HasExportingModelsMode.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

hasEditApplConfMode

boolean hasEditApplConfMode()
                     throws InoNetException,
SrvErrorException

Returns true, if the current object has privilege 'Edit Model-Wide Configurations'.

Throws:

InoNetException

SrvErrorException

setEditApplConfMode

void setEditApplConfMode(boolean value)
                  throws InoNetException,
SrvErrorException

Set the value of Info HasEditApplConfMode.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

hasEditHyphenationMode

boolean hasEditHyphenationMode()
                        throws InoNetException,
SrvErrorException

Returns true, if the current object has privilege 'Edit Hyphenation'.

Throws:

InoNetException

SrvErrorException

setEditHyphenationMode

void setEditHyphenationMode(boolean value)
                     throws InoNetException,
SrvErrorException

Set the value of Info HasEditHyphenationMode.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

hasNoElementDeletionMode

boolean hasNoElementDeletionMode()
                          throws InoNetException,
SrvErrorException

Returns true, if the current object has privilege 'Do Not Delete Elements'.

Throws:

InoNetException

SrvErrorException

setNoElementDeletionMode

void setNoElementDeletionMode(boolean value)
                       throws InoNetException,
SrvErrorException

Set the value of Info HasNoElementDeletionMode.

Parameters:

value - The value to be set.

Throws:

InoNetException

SrvErrorException

getMdlUserByPattern

List<ADMdlUser> getMdlUserByPattern(String pattern,
 K_CONTROL_OPTION... behaviourFlags)
                             throws InoNetException,
SrvErrorException

Returns the users which are assigned to the current object. It is possible to restrict the result by using the argument pattern.

Parameters:

pattern - A string pattern. This parameter is optional. (Its value can be given as null.)

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

Sorted:

getExecuteAble

<T extends ADExecuteAble> List<T> getExecuteAble(Class<T> returnType,
 K_CONTROL_OPTION... behaviourFlags)
                                          throws InoNetException,
SrvErrorException

Return all executeable elements the the current object is allowed to execute.

Parameters:

returnType - Specifies the type of elements to be returned.

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getCopyRoleExecutionDlgInit

ARG_CopyRoleExecutionDlgInitOut getCopyRoleExecutionDlgInit(MMProfile ohProfile)
                                                     throws InoNetException,
SrvErrorException

Fills the dialog for the copy of execution rights. This user role and the profile specify the target for the execution right. The dialog shows pairs of user roles and profiles which contain the source execution rights.

Parameters:

ohProfile - profile of the selected stereotype

Throws:

InoNetException

SrvErrorException

addOperationMode

void addOperationMode(K_OPERATIONMODE item)
               throws InoNetException,
SrvErrorException

Adds the privilege to the current object.

Parameters:

item -

Throws:

InoNetException

SrvErrorException

assignExecuteAble

List<MMRoleExecution> assignExecuteAble(MMProfile ohProfile,
 MM2Class ohClass,
 List<? extends ADExecuteAble> seqOh)
                                 throws InoNetException,
SrvErrorException

Assigns a list of executable elements to this user role.

Parameters:

ohProfile - profile of the configuration

ohClass - meta class of the execute able elements

seqOh - list of execute able elements

Throws:

InoNetException

SrvErrorException

copyRoleExecutionDlg

void copyRoleExecutionDlg(MMProfile ohProfile,
 MMProfile ohSrcProfile,
 ADUsrRole ohSrcRole,
 boolean copyAll,
 List<? extends ADExecuteAble> seqExec)
                   throws InoNetException,
SrvErrorException

Copies the execution right from the specified user role to this user role. Each user role needs a profile to specify the context.

Parameters:

ohProfile - profile of the selected user role

ohSrcProfile - profile of the user role from which the execution rights are copied

ohSrcRole - user role from which the execution rights are copied

copyAll - isTrue/isFalse means copy all role excutions/copy only the specified execution rights

seqExec - list of execution rights which have to be copied

Throws:

InoNetException

SrvErrorException

modifyAccess

void modifyAccess(List<? extends ADAccessAble> seqAccessAble,
 boolean giveAccess,
 boolean recursive)
           throws InoNetException,
SrvErrorException

Modifies the given elements' role access.

Parameters:

seqAccessAble - sequence of accessable elements

giveAccess - switch access on or off

recursive - set recursive for all sons

Throws:

InoNetException

SrvErrorException

modifyRead

void modifyRead(List<? extends ADAccessAble> seqAccessAble,
 boolean giveRead)
         throws InoNetException,
SrvErrorException

Modifies the given elements' role read permission.

Parameters:

seqAccessAble - sequence of accessable elements

giveRead - switch read permission on or off

Throws:

InoNetException

SrvErrorException

removeOperationMode

void removeOperationMode(K_OPERATIONMODE item)
                  throws InoNetException,
SrvErrorException

Removes the privilege from the current object.

Parameters:

item -

Throws:

InoNetException

SrvErrorException

getMdlUser

List<ADMdlUser> getMdlUser()
                    throws InoNetException,
SrvErrorException

Returns the model users which are assigned to the current object.

Throws:

InoNetException

SrvErrorException

getAccessAble

<T extends ADAccessAble> List<T> getAccessAble(Class<T> returnType,
 K_CONTROL_OPTION... behaviourFlags)
                                        throws InoNetException,
SrvErrorException

Returns the elements which can be accessed by the current object.

Parameters:

returnType - Specifies the type of elements to be returned.

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getLogin

List<ADLogin> getLogin()
                throws InoNetException,
SrvErrorException

Returns the logins that use the current object.

Throws:

InoNetException

SrvErrorException

getRoleExecution

List<MMRoleExecution> getRoleExecution()
                                throws InoNetException,
SrvErrorException

Returns role executions from the current object.

Throws:

InoNetException

SrvErrorException

getReadAble

<T extends ADAccessAble> List<T> getReadAble(Class<T> returnType,
 K_CONTROL_OPTION... behaviourFlags)
                                      throws InoNetException,
SrvErrorException

Returns the elements which cannot be read by the current object.

Parameters:

returnType - Specifies the type of elements to be returned.

behaviourFlags - An optional list of enum values to control the behaviour of the command.

Throws:

InoNetException

SrvErrorException

getModel

ADModel getModel()
          throws InoNetException,
SrvErrorException

The model owning this user role.

Throws:

InoNetException

SrvErrorException