com.oberon.ooql.sdk
Class User

java.lang.Object
  com.oberon.ooql.sdk.OBBase
      com.oberon.ooql.sdk.AdminBase
          com.oberon.ooql.sdk.User

All Implemented Interfaces:

java.io.Serializable

public class User
extends AdminBase
implements java.io.Serializable

User Admin Object: defines a OBEROn User

Version:

5.0

See Also:

Serialized Form

Field Summary

static java.lang.String	ACCESS_ALL Full access constant
static java.lang.String	ACCESS_NONE No access constant
static int	ACTIVEPWD_OPTION The Active Password flag index inside the Option Set
static int	ADMIN
static int	ADMIN_ASSIGNMENT Administrative access: manage Assignment admin objects)
static int	ADMIN_AUTONUMBER Administrative access: manage AutoNumber admin objects)
static int	ADMIN_CLASS Administrative access: manage Class admin objects)
static int	ADMIN_COMMAND Administrative access: manage Command admin objects)
static int	ADMIN_DICTIONARY Administrative access: manage Dictionary translations)
static int	ADMIN_DUMP Administrative access: perform data extractions [Dump])
static int	ADMIN_FEATURE Administrative access: manage Feature admin objects)
static int	ADMIN_FIELD Administrative access: manage Field admin objects)
static int	ADMIN_FILETYPE Administrative access: manage FileType admin objects)
static int	ADMIN_FORM Administrative access: manage Form admin objects)
static int	ADMIN_GRAPH Administrative access: manage Graph admin objects)
static int	ADMIN_Length Number of Administrative access flags
static int	ADMIN_LIFECYCLE Administrative access: manage Lifecycle admin objects)
static int	ADMIN_LINKTYPE Administrative access: manage LinkType admin objects)
static int	ADMIN_MENU Administrative access: manage Menu admin objects)
static int	ADMIN_METRICSYSTEM Administrative access: manage MetricSystem admin objects)
static int	ADMIN_PROGRAM Administrative access: manage Program admin objects)
static int	ADMIN_QUERY Administrative access: manage Query admin objects)
static int	ADMIN_TEAM Administrative access: manage Team admin objects)
static int	ADMIN_UNITMEASURE Administrative access: manage UnitMeasure admin objects)
static int	ADMIN_USER Administrative access: manage User admin objects)
static int	ADMIN_VIEW Administrative access: manage View admin objects)
static int	ADMIN_WEBSERVICE Administrative access: manage WebService admin objects)
static int	ADMIN_WORKFLOW Administrative access: manage Workflow admin objects)
static int	BASIC
static int	BASIC_ADDLINKFROM Basic (object) access: Add (out)Link from a given object to another
static int	BASIC_ADDLINKTO Basic (object) access: Add (in)Link to a given object from another
static int	BASIC_CHANGECLASS Basic (object) access: Change the object Class
static int	BASIC_CHANGEHOLDER Basic (object) access: Change the object holder
static int	BASIC_CHANGELIFECYCLE Basic (object) access: Change the object Lifecycle
static int	BASIC_CHANGENAME Basic (object) access: Change the object name / revision
static int	BASIC_CHANGESPACE Basic (object) access: Move the Object between two ObjectSpaces
static int	BASIC_CLONE Basic (object) access: Clone an Object
static int	BASIC_CREATE Basic (object) access: Create new Object
static int	BASIC_DELEGATE Basic (object) access: Delegate access to a object
static int	BASIC_DESTROY Basic (object) access: Destroy an object
static int	BASIC_EDIT Basic (object) access: Edit object Field values
static int	BASIC_EXECUTE Basic (object) access: Execute a object method
static int	BASIC_FILEDELETE Basic (object) access: Remove file from an object
static int	BASIC_FILEGET Basic (object) access: Extract a file from an object
static int	BASIC_FILEPUT Basic (object) access: Attach new file to an object
static int	BASIC_FILERENAME Basic (object) access: Rename an object file
static int	BASIC_Length Number of Basic (object) access flags
static int	BASIC_LINK_CHANGEHOLDER Basic (link) access: Change the link holder
static int	BASIC_LINK_CHANGETYPE Basic (link) access: Change the link LinkType
static int	BASIC_LINK_CREATE Basic (link) access: Create new Link
static int	BASIC_LINK_DESTROY Basic (link) access: Destroy a link
static int	BASIC_LINK_EDIT Basic (link) access: Edit link Field values
static int	BASIC_LINK_Length Number of Basic (object) access flags
static int	BASIC_LINK_READ Basic (link) access: Read link properties
static int	BASIC_LINK_UNDO Basic (link) access: Undo latest edit operation
static int	BASIC_LOCK Basic (object) access: Lock an object
static int	BASIC_PROGRESS Basic (object) access: Progress object to the next Stage
static int	BASIC_READ Basic (object) access: Read object properties
static int	BASIC_REGRESS Basic (object) access: Regress object to the previous Stage
static int	BASIC_REMOVELINKFROM Basic (object) access: Remove (out)Link from a given object to another
static int	BASIC_REMOVELINKTO Basic (object) access: Remove (in)Link to a given object from another
static int	BASIC_REVISE Basic (object) access: Revise an object
static int	BASIC_REVOKE Basic (object) access: Revoke delegation for a object
static int	BASIC_UNDO Basic (object) access: Undo latest edit operation
static int	BASIC_UNLOCK Basic (object) access: Remove the lock from an object
static java.lang.String	COMMUNITY Community constant
static int	ENABLEDPWD_OPTION The Enabled Password Mail flag index inside the Option Set
static int	EXTMAIL_OPTION The External Mail flag index inside the Option Set
static java.lang.String	HOLDER Holder constant
static int	INTMAIL_OPTION The Internal Mail flag index inside the Option Set
java.lang.String	sLastAccess
static int	SUPERUSER_OPTION The SuperUser flag index inside the Option Set
static int	SYSTEM
static int	SYSTEM_FILESPACE System access: manage FileSpace system/admin objects)
static int	SYSTEM_Length Number of System access flags
static int	SYSTEM_LOCALAREA System access: manage LocalArea system/admin objects)
static int	SYSTEM_OBJECTSPACE System access: manage ObjectSpace system/admin objects)

Fields inherited from class com.oberon.ooql.sdk.AdminBase

bsOptions, HIDDEN_OPTION

Constructor Summary

User()

User(java.lang.String name)

Method Summary

void	addAssignment(java.lang.String assignmentName) Add a Assignment to this User; the User will gain the access rights defined for the role
void	addTeam(java.lang.String teamName) Add this User to a Team; the User will gain the access rights defined for the Team
java.lang.String	compareUpdate(User refUser, boolean checkImage, boolean overwrite, boolean force, Framework framework) Return/apply the OOQL command to update this User object and let it become equals to another reference object.
void	create(boolean force, Framework framework) Create a new User object on the database
void	create(Framework framework) Create a new User object on the database
void	destroy(Framework framework) Remove the User object from the database.
void	destroy(java.lang.String newHolder, Framework framework) Remove the User object from the database and reassign objects/link to the new holder
void	fromXML(org.jdom.Element rootElement) Load the User object from XML element tree
java.lang.String	getAddress() Get the User address.
java.util.BitSet	getAdminAccess() Get the access for administrative object manipulation
boolean	getAdminAccess(int accessType) Check the access status for a administrative object
static java.lang.String	getAdminAccessAsString(int accessType) Convert administrative object access to OOQL equivalent String
java.lang.String	getAdminAccessAsString(java.lang.String delim) Get the administrative object accesses as OOQL equivalent String
static int	getAdminAccessId(java.lang.String access) Get the administrative access type from the equivalent OOQL String
java.util.Vector<java.lang.String>	getAssignments(Framework framework) Return the list of Assignment associated directly or indirectly to this User.
java.lang.String	getAssignmentsAsString(java.lang.String delim, Framework framework) Return the list of Assignment associated directly or indirectly to this User.
java.util.BitSet	getBasicAccess() Get the global access for ObjectObj and Link manipulation.
boolean	getBasicAccess(int accessType) Check the access status for a specific ObjectObj or Link manipulation
static java.lang.String	getBasicAccessAsString(int accessType) Convert ObjectObj manipulation access to OOQL equivalent String
java.lang.String	getBasicAccessAsString(java.lang.String delim) Get the ObjectObj and Link manipulation accesses as OOQL equivalent String
static int	getBasicAccessId(java.lang.String access) Get the ObjectObj manipulation access type from the equivalent OOQL String
static java.lang.String	getBasicLinkAccessAsString(int accessType) Convert Link manipulation access to OOQL equivalent String
static int	getBasicLinkAccessId(java.lang.String access) Get the Link manipulation access type from the equivalent OOQL String
java.lang.String	getCreateCommand(boolean force) Return the OOQL command to create this User object with the settled properties
java.lang.String	getFax() Get the User fax number.
java.lang.String	getLanguage() Get the Language for this User
java.lang.String	getLastAccess() Return the last access date
java.lang.String	getLocalArea() Get the default LocalArea for this User
java.lang.String	getMailAddress() Get the mail address for this User
java.lang.String	getMailTypeAsString(java.lang.String delim) Get the mail type for this User as OOQL String
java.lang.String	getMetricSystem() Get the MetricSystem for this User
java.lang.String	getObjectSpace() Set the default ObjectSpace for this User.
java.util.Vector<java.lang.String>	getOwnAssignments() Return the list of Assignment associated directly to this User
java.lang.String	getOwnAssignmentsAsString(java.lang.String delim) Return the list of Assignment associated directly to this User
java.util.Vector<java.lang.String>	getOwnTeams() Return the list of Teams to which the User directly belong
java.lang.String	getOwnTeamsAsString(java.lang.String delim) Return the list of Teams to which the User directly belong as String
java.lang.String	getPassword() Get the User password (MD5 encrypted)
java.lang.String	getProperty(java.lang.String propertyName, java.util.Vector<java.lang.Object> filterArgs, java.lang.String token, Framework framework) Get a property for this User object by its OOQL identifier
java.lang.String	getSaveCommand(boolean force) Return the OOQL command to update this User object with the modified properties.
java.util.BitSet	getSystemAccess() Get the access for system/administrative object manipulation
boolean	getSystemAccess(int accessType) Check the access status for a system/administrative object
static java.lang.String	getSystemAccessAsString(int accessType) Convert system/administrative object access to OOQL equivalent String
java.lang.String	getSystemAccessAsString(java.lang.String delim) Get the system/administrative object accesses as OOQL equivalent String
static int	getSystemAccessId(java.lang.String access) Get the system/administrative access type from the equivalent OOQL String
java.util.Vector<?>	getTargetNames(java.lang.String composedName, java.util.Vector<java.lang.Object> filterArgs, Framework framework) Return a Vector of administrative object names extracted by using an OOQL selector
java.util.Vector<java.lang.String>	getTeams(Framework framework) Return the list of Teams to which the User directly or indirectly belong
java.lang.String	getTeamsAsString(java.lang.String delim, Framework framework) Return the list of Teams to which the User directly or indirectly belong as String
java.lang.String	getTelephone() Get the User telephone number.
org.jdom.Element	getXMLAdminAccess() Return the admin access as XML element tree
org.jdom.Element	getXMLBasicAccess() Return the basic access as XML element tree
org.jdom.Element	getXMLSystemAccess() Return the system access as XML element tree
boolean	isExternalMail() Check if the external java mail is enabled
boolean	isInternalMail() Check if the internal OBEROn mail is enabled
boolean	isPasswordActive() Check if the password is active
boolean	isPasswordEnabled() Check if the password is enabled
boolean	isSuperUser() Check if the User is a super-User
void	link(Framework framework, java.util.Hashtable<java.lang.String,java.lang.Integer> counters) Open the User object: connect the memory instance with the database instance
static User	open(java.lang.String name, Framework framework, java.util.Hashtable<java.lang.String,java.lang.Integer> counters) Open an administrative object and read properties from the database or retrieve them from memory
void	removeAssignment(java.lang.String assignmentName) Remove a Assignment for this User; the User will loose the access rights defined for the role
void	removeTeam(java.lang.String teamName) Remove the User from a Team; the User will loose the access rights defined for the Team
void	setAddress(java.lang.String address) Set the User address.
void	setAdminAccess(java.util.BitSet accessFlags) Set the access for administrative object manipulation
void	setAdminAccess(int accessType, boolean accessFlag) Set the access for administrative object manipulation
void	setAllAdminAccess() Give the full access to all administrative objects
void	setAllBasicAccess() Set the global access for all ObjectObj and Link operations.
void	setAllSystemAccess() Give the full access to all system/administrative objects
void	setBasicAccess(java.util.BitSet accessFlags) Set the global access for ObjectObj and Link manipulation.
void	setBasicAccess(int accessType, boolean accessFlag) Set the global access for ObjectObj and Link manipulation.
void	setFax(java.lang.String fax) Set the User fax.
void	setLanguage(java.lang.String language) Set the default Language for this User
void	setLocalArea(java.lang.String localAreaName) Set the default LocalArea for this User
void	setMailAddress(java.lang.String emailAddress) Set the mail address for this User.
void	setMailType(boolean internal, boolean external) Set the mail type for this User.
void	setMailType(java.lang.String mailType) Set the mail type for this User.
void	setMD5Password(java.lang.String password) Set the User password for the OBEROn login in MD5 format
void	setMetricSystem(java.lang.String metricSystemName) Set the default Metric System for this User
void	setNoAdminAccess() Revoke access to all administrative objects
void	setNoBasicAccess() Remove the global access for all ObjectObj and Link operations.
void	setNoSystemAccess() Revoke access to all system/administrative objects
void	setObjectSpace(java.lang.String objectSpaceName) Set the default ObjectSpace for this User.
void	setPassword(java.lang.String password) Set the User password for the OBEROn login The password is encrypted in MD5 format
void	setPasswordActive(boolean active) Active the password
void	setPasswordEnabled(boolean enable) Enable/disable the password
void	setSuperUser(boolean superUser) Set the User as super-User
void	setSystemAccess(java.util.BitSet accessFlags) Set the access for system/administrative object manipulation
void	setSystemAccess(int accessType, boolean accessFlag) Set the access for system/administrative object manipulation
void	setTelephone(java.lang.String telephone) Set the User telephone.
void	show(Selector selector, java.io.DataOutputStream outStream, Framework framework) Show the User object properties
java.lang.String	toString() Return the User object basic properties as a single String
java.lang.String	toString(Framework framework) Return the User object extended properties as a single String
org.jdom.Element	toXML(boolean getImage, boolean fullDump, Framework framework) Return the User object properties as XML element tree
org.jdom.Element	toXML(Framework framework) Return the User object properties as XML element tree
void	unlink(Framework framework) Close the object: disconnect the memory instance from the database instance
void	updateAssignments(java.util.Vector<java.lang.String> assignments) Update the assignments on the basis of a given list
void	updateTeams(java.util.Vector<java.lang.String> teams) Update the teams on the basis of a given list
void	write(boolean force, Framework framework) Update the User object to the database
void	write(Framework framework) Update the User object to the database

Methods inherited from class com.oberon.ooql.sdk.AdminBase

addFeature, changedApplication, checkChangeName, checkCounters, checkCounters, getAdminType, getApplication, getCommonProperty, getCommonTargetNames, getCounters, getCreateBasicCommand, getCreateCommand, getCrtDate, getDescription, getEditBasicCommand, getFeature, getFeatures, getFeaturesAsString, getImage, getImage, getImage, getImageData, getImageFile, getModDate, getModUser, getName, getOldName, getPlainFeatures, getSaveCommand, getSVNRevision, getXMLFeatureList, hasImage, isHidden, setApplication, setCounters, setCrtDate, setDescription, setHidden, setImage, setImageData, setImageFile, setModDate, setModUser, setName, setSVNRevision, show, toCommonXML, toXML

Methods inherited from class com.oberon.ooql.sdk.OBBase

addChange, addUniqueChange, ChangesFromXML, ChangesToXML, getChanges, getChangesAsString, getId, isLinked, removeChange, resetChanges, setId, setLinked

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

BASIC

public static final int BASIC

See Also:

Constant Field Values

SYSTEM

public static final int SYSTEM

See Also:

Constant Field Values

ADMIN

public static final int ADMIN

See Also:

Constant Field Values

BASIC_CREATE

public static final int BASIC_CREATE

Basic (object) access: Create new Object

See Also:

Constant Field Values

BASIC_CLONE

public static final int BASIC_CLONE

Basic (object) access: Clone an Object

See Also:

Constant Field Values

BASIC_REVISE

public static final int BASIC_REVISE

Basic (object) access: Revise an object

See Also:

Constant Field Values

BASIC_DESTROY

public static final int BASIC_DESTROY

Basic (object) access: Destroy an object

See Also:

Constant Field Values

BASIC_EDIT

public static final int BASIC_EDIT

Basic (object) access: Edit object Field values

See Also:

Constant Field Values

BASIC_CHANGESPACE

public static final int BASIC_CHANGESPACE

Basic (object) access: Move the Object between two ObjectSpaces

See Also:

Constant Field Values

BASIC_CHANGECLASS

public static final int BASIC_CHANGECLASS

Basic (object) access: Change the object Class

See Also:

Constant Field Values

BASIC_CHANGENAME

public static final int BASIC_CHANGENAME

Basic (object) access: Change the object name / revision

See Also:

Constant Field Values

BASIC_CHANGEHOLDER

public static final int BASIC_CHANGEHOLDER

Basic (object) access: Change the object holder

See Also:

Constant Field Values

BASIC_CHANGELIFECYCLE

public static final int BASIC_CHANGELIFECYCLE

Basic (object) access: Change the object Lifecycle

See Also:

Constant Field Values

BASIC_READ

public static final int BASIC_READ

Basic (object) access: Read object properties

See Also:

Constant Field Values

BASIC_FILEPUT

public static final int BASIC_FILEPUT

Basic (object) access: Attach new file to an object

See Also:

Constant Field Values

BASIC_FILEGET

public static final int BASIC_FILEGET

Basic (object) access: Extract a file from an object

See Also:

Constant Field Values

BASIC_FILERENAME

public static final int BASIC_FILERENAME

Basic (object) access: Rename an object file

See Also:

Constant Field Values

BASIC_FILEDELETE

public static final int BASIC_FILEDELETE

Basic (object) access: Remove file from an object

See Also:

Constant Field Values

BASIC_EXECUTE

public static final int BASIC_EXECUTE

Basic (object) access: Execute a object method

See Also:

Constant Field Values

BASIC_LOCK

public static final int BASIC_LOCK

Basic (object) access: Lock an object

See Also:

Constant Field Values

BASIC_UNLOCK

public static final int BASIC_UNLOCK

Basic (object) access: Remove the lock from an object

See Also:

Constant Field Values

BASIC_PROGRESS

public static final int BASIC_PROGRESS

Basic (object) access: Progress object to the next Stage

See Also:

Constant Field Values

BASIC_REGRESS

public static final int BASIC_REGRESS

Basic (object) access: Regress object to the previous Stage

See Also:

Constant Field Values

BASIC_ADDLINKTO

public static final int BASIC_ADDLINKTO

Basic (object) access: Add (in)Link to a given object from another

See Also:

Constant Field Values

BASIC_ADDLINKFROM

public static final int BASIC_ADDLINKFROM

Basic (object) access: Add (out)Link from a given object to another

See Also:

Constant Field Values

BASIC_REMOVELINKTO

public static final int BASIC_REMOVELINKTO

Basic (object) access: Remove (in)Link to a given object from another

See Also:

Constant Field Values

BASIC_REMOVELINKFROM

public static final int BASIC_REMOVELINKFROM

Basic (object) access: Remove (out)Link from a given object to another

See Also:

Constant Field Values

BASIC_DELEGATE

public static final int BASIC_DELEGATE

Basic (object) access: Delegate access to a object

See Also:

Constant Field Values

BASIC_REVOKE

public static final int BASIC_REVOKE

Basic (object) access: Revoke delegation for a object

See Also:

Constant Field Values

BASIC_UNDO

public static final int BASIC_UNDO

Basic (object) access: Undo latest edit operation

See Also:

Constant Field Values

BASIC_Length

public static final int BASIC_Length

Number of Basic (object) access flags

See Also:

Constant Field Values

BASIC_LINK_CREATE

public static final int BASIC_LINK_CREATE

Basic (link) access: Create new Link

See Also:

Constant Field Values

BASIC_LINK_DESTROY

public static final int BASIC_LINK_DESTROY

Basic (link) access: Destroy a link

See Also:

Constant Field Values

BASIC_LINK_EDIT

public static final int BASIC_LINK_EDIT

Basic (link) access: Edit link Field values

See Also:

Constant Field Values

BASIC_LINK_CHANGETYPE

public static final int BASIC_LINK_CHANGETYPE

Basic (link) access: Change the link LinkType

See Also:

Constant Field Values

BASIC_LINK_CHANGEHOLDER

public static final int BASIC_LINK_CHANGEHOLDER

Basic (link) access: Change the link holder

See Also:

Constant Field Values

BASIC_LINK_READ

public static final int BASIC_LINK_READ

Basic (link) access: Read link properties

See Also:

Constant Field Values

BASIC_LINK_UNDO

public static final int BASIC_LINK_UNDO

Basic (link) access: Undo latest edit operation

See Also:

Constant Field Values

BASIC_LINK_Length

public static final int BASIC_LINK_Length

Number of Basic (object) access flags

See Also:

Constant Field Values

ADMIN_FIELD

public static final int ADMIN_FIELD

Administrative access: manage Field admin objects)

See Also:

Constant Field Values

ADMIN_CLASS

public static final int ADMIN_CLASS

Administrative access: manage Class admin objects)

See Also:

Constant Field Values

ADMIN_LINKTYPE

public static final int ADMIN_LINKTYPE

Administrative access: manage LinkType admin objects)

See Also:

Constant Field Values

ADMIN_USER

public static final int ADMIN_USER

Administrative access: manage User admin objects)

See Also:

Constant Field Values

ADMIN_TEAM

public static final int ADMIN_TEAM

Administrative access: manage Team admin objects)

See Also:

Constant Field Values

ADMIN_ASSIGNMENT

public static final int ADMIN_ASSIGNMENT

Administrative access: manage Assignment admin objects)

See Also:

Constant Field Values

ADMIN_FILETYPE

public static final int ADMIN_FILETYPE

Administrative access: manage FileType admin objects)

See Also:

Constant Field Values

ADMIN_PROGRAM

public static final int ADMIN_PROGRAM

Administrative access: manage Program admin objects)

See Also:

Constant Field Values

ADMIN_LIFECYCLE

public static final int ADMIN_LIFECYCLE

Administrative access: manage Lifecycle admin objects)

See Also:

Constant Field Values

ADMIN_FEATURE

public static final int ADMIN_FEATURE

Administrative access: manage Feature admin objects)

See Also:

Constant Field Values

ADMIN_MENU

public static final int ADMIN_MENU

Administrative access: manage Menu admin objects)

See Also:

Constant Field Values

ADMIN_COMMAND

public static final int ADMIN_COMMAND

Administrative access: manage Command admin objects)

See Also:

Constant Field Values

ADMIN_DUMP

public static final int ADMIN_DUMP

Administrative access: perform data extractions [Dump])

See Also:

Constant Field Values

ADMIN_AUTONUMBER

public static final int ADMIN_AUTONUMBER

Administrative access: manage AutoNumber admin objects)

See Also:

Constant Field Values

ADMIN_DICTIONARY

public static final int ADMIN_DICTIONARY

Administrative access: manage Dictionary translations)

See Also:

Constant Field Values

ADMIN_GRAPH

public static final int ADMIN_GRAPH

Administrative access: manage Graph admin objects)

See Also:

Constant Field Values

ADMIN_FORM

public static final int ADMIN_FORM

Administrative access: manage Form admin objects)

See Also:

Constant Field Values

ADMIN_WEBSERVICE

public static final int ADMIN_WEBSERVICE

Administrative access: manage WebService admin objects)

See Also:

Constant Field Values

ADMIN_VIEW

public static final int ADMIN_VIEW

Administrative access: manage View admin objects)

See Also:

Constant Field Values

ADMIN_WORKFLOW

public static final int ADMIN_WORKFLOW

Administrative access: manage Workflow admin objects)

See Also:

Constant Field Values

ADMIN_QUERY

public static final int ADMIN_QUERY

Administrative access: manage Query admin objects)

See Also:

Constant Field Values

ADMIN_METRICSYSTEM

public static final int ADMIN_METRICSYSTEM

Administrative access: manage MetricSystem admin objects)

See Also:

Constant Field Values

ADMIN_UNITMEASURE

public static final int ADMIN_UNITMEASURE

Administrative access: manage UnitMeasure admin objects)

See Also:

Constant Field Values

ADMIN_Length

public static final int ADMIN_Length

Number of Administrative access flags

See Also:

Constant Field Values

SYSTEM_OBJECTSPACE

public static final int SYSTEM_OBJECTSPACE

System access: manage ObjectSpace system/admin objects)

See Also:

Constant Field Values

SYSTEM_FILESPACE

public static final int SYSTEM_FILESPACE

System access: manage FileSpace system/admin objects)

See Also:

Constant Field Values

SYSTEM_LOCALAREA

public static final int SYSTEM_LOCALAREA

System access: manage LocalArea system/admin objects)

See Also:

Constant Field Values

SYSTEM_Length

public static final int SYSTEM_Length

Number of System access flags

See Also:

Constant Field Values

INTMAIL_OPTION

public static final int INTMAIL_OPTION

The Internal Mail flag index inside the Option Set

See Also:

Constant Field Values

EXTMAIL_OPTION

public static final int EXTMAIL_OPTION

The External Mail flag index inside the Option Set

See Also:

Constant Field Values

ACTIVEPWD_OPTION

public static final int ACTIVEPWD_OPTION

The Active Password flag index inside the Option Set

See Also:

Constant Field Values

ENABLEDPWD_OPTION

public static final int ENABLEDPWD_OPTION

The Enabled Password Mail flag index inside the Option Set

See Also:

Constant Field Values

SUPERUSER_OPTION

public static final int SUPERUSER_OPTION

The SuperUser flag index inside the Option Set

See Also:

Constant Field Values

ACCESS_ALL

public static final java.lang.String ACCESS_ALL

Full access constant

See Also:

Constant Field Values

ACCESS_NONE

public static final java.lang.String ACCESS_NONE

No access constant

See Also:

Constant Field Values

COMMUNITY

public static final java.lang.String COMMUNITY

Community constant

See Also:

Constant Field Values

HOLDER

public static final java.lang.String HOLDER

Holder constant

See Also:

Constant Field Values

sLastAccess

public java.lang.String sLastAccess

Constructor Detail

User

public User()

User

public User(java.lang.String name)
     throws OberonException

Parameters:

name - the name of the administrative object

Throws:

OberonException - if the name contains invalid characters

Method Detail

open

public static User open(java.lang.String name,
                        Framework framework,
                        java.util.Hashtable<java.lang.String,java.lang.Integer> counters)
                 throws OberonException

Open an administrative object and read properties from the database or retrieve them from memory

Parameters:

name - the object name

framework - the current framework

counters - administrative object synch counters (if null read them from database)

Throws:

OberonException - usually due to DB SQL exceptions

link

public void link(Framework framework,
                 java.util.Hashtable<java.lang.String,java.lang.Integer> counters)
          throws OberonException

Open the User object: connect the memory instance with the database instance

Specified by:

link in class AdminBase

Parameters:

framework - the current framework

counters - administrative object synch counters (if null read them from database)

Throws:

OberonException - usually due to DB SQL exceptions

create

public void create(Framework framework)
            throws OberonException

Create a new User object on the database

Specified by:

create in class AdminBase

Parameters:

framework - the current framework

Throws:

OberonException - usually due to DB SQL exceptions or to limited user access rights

create

public void create(boolean force,
                   Framework framework)
            throws OberonException

Create a new User object on the database

Parameters:

force - if true ignores optional features

framework - the current framework

Throws:

OberonException - usually due to DB SQL exceptions or to limited user access rights

Since:

1.6

write

public void write(Framework framework)
           throws OberonException

Update the User object to the database

Specified by:

write in class AdminBase

Parameters:

framework - the current framework

Throws:

OberonException - usually due to DB SQL exceptions or to limited user access rights

write

public void write(boolean force,
                  Framework framework)
           throws OberonException

Update the User object to the database

Parameters:

force - if true ignores optional features

framework - the current framework

Throws:

OberonException - usually due to DB SQL exceptions or to limited user access rights

Since:

1.6

show

public void show(Selector selector,
                 java.io.DataOutputStream outStream,
                 Framework framework)
          throws java.io.IOException,
                 OberonException

Show the User object properties

Overrides:

show in class AdminBase

Parameters:

selector - selection parameters (if null return all the object properties)

outStream - the stream for the results (if null the result is stored into the framework)

framework - the current framework

Throws:

java.io.IOException - when the output stream return an exception

OberonException - for all other problems

See Also:

Framework.getResult()

unlink

public void unlink(Framework framework)
            throws OberonException

Close the object: disconnect the memory instance from the database instance

Specified by:

unlink in class AdminBase

Parameters:

framework - the current framework

Throws:

OberonException - usually due to DB SQL exceptions

destroy

public void destroy(Framework framework)
             throws OberonException

Remove the User object from the database.

Specified by:

destroy in class AdminBase

Parameters:

framework - the current framework

Throws:

OberonException - usually due to DB SQL exceptions or to limited user access rights

destroy

public void destroy(java.lang.String newHolder,
                    Framework framework)
             throws OberonException

Remove the User object from the database and reassign objects/link to the new holder

Parameters:

newHolder - new holder name

framework - the current framework

Throws:

OberonException - usually due to DB SQL exceptions or to limited user access rights

Since:

4.0

setAddress

public void setAddress(java.lang.String address)

Set the User address.

Parameters:

address - the User address

getAddress

public java.lang.String getAddress()

Get the User address.

setTelephone

public void setTelephone(java.lang.String telephone)

Set the User telephone.

Parameters:

telephone - the telephone number

getTelephone

public java.lang.String getTelephone()

Get the User telephone number.

setFax

public void setFax(java.lang.String fax)

Set the User fax.

Parameters:

fax - the fax number

getFax

public java.lang.String getFax()

Get the User fax number.

setObjectSpace

public void setObjectSpace(java.lang.String objectSpaceName)

Set the default ObjectSpace for this User. New ObjectObjs and Links created by this User are stored here if the ObjectSpace is not specified

Parameters:

objectSpaceName - the ObjectSpace name

getObjectSpace

public java.lang.String getObjectSpace()

Set the default ObjectSpace for this User.

setLocalArea

public void setLocalArea(java.lang.String localAreaName)

Set the default LocalArea for this User

Parameters:

localAreaName - the LocalArea name

getLocalArea

public java.lang.String getLocalArea()

Get the default LocalArea for this User

setMetricSystem

public void setMetricSystem(java.lang.String metricSystemName)

Set the default Metric System for this User

Parameters:

metricSystemName - the MetricSystem name

getMetricSystem

public java.lang.String getMetricSystem()

Get the MetricSystem for this User

setMailType

public void setMailType(boolean internal,
                        boolean external)

Set the mail type for this User.

Parameters:

internal - if true enable the internal OBEROn mail

external - if true enable the java mail to send mail to external addresses

setMailAddress

public void setMailAddress(java.lang.String emailAddress)

Set the mail address for this User.

Parameters:

emailAddress - the email address

See Also:

Mail.send(Framework)

isInternalMail

public boolean isInternalMail()

Check if the internal OBEROn mail is enabled

isExternalMail

public boolean isExternalMail()

Check if the external java mail is enabled

setMailType

public void setMailType(java.lang.String mailType)

Set the mail type for this User.

Parameters:

mailType - OOQL mail type ( "internal" / "external" )

getMailTypeAsString

public java.lang.String getMailTypeAsString(java.lang.String delim)

Get the mail type for this User as OOQL String

Returns:

"internal" or "external" or "internal"<delim>"external"

getMailAddress

public java.lang.String getMailAddress()

Get the mail address for this User

Returns:

the email address

setPassword

public void setPassword(java.lang.String password)

Set the User password for the OBEROn login The password is encrypted in MD5 format

setMD5Password

public void setMD5Password(java.lang.String password)

Set the User password for the OBEROn login in MD5 format

getPassword

public java.lang.String getPassword()

Get the User password (MD5 encrypted)

setPasswordEnabled

public void setPasswordEnabled(boolean enable)

Enable/disable the password

isPasswordEnabled

public boolean isPasswordEnabled()

Check if the password is enabled

setPasswordActive

public void setPasswordActive(boolean active)

Active the password

isPasswordActive

public boolean isPasswordActive()

Check if the password is active

getLastAccess

public java.lang.String getLastAccess()

Return the last access date

Returns:

the last access date

Since:

2.1.5

setSuperUser

public void setSuperUser(boolean superUser)

Set the User as super-User

isSuperUser

public boolean isSuperUser()

Check if the User is a super-User

setLanguage

public void setLanguage(java.lang.String language)

Set the default Language for this User

Parameters:

language - the language abbreviation (max 3 chars)

getLanguage

public java.lang.String getLanguage()

Get the Language for this User

Returns:

the language abbreviation

setSystemAccess

public void setSystemAccess(int accessType,
                            boolean accessFlag)

Set the access for system/administrative object manipulation

Parameters:

accessType - the access type

accessFlag - true to enable / false to disable the access

setAllSystemAccess

public void setAllSystemAccess()

Give the full access to all system/administrative objects

setNoSystemAccess

public void setNoSystemAccess()

Revoke access to all system/administrative objects

setSystemAccess

public void setSystemAccess(java.util.BitSet accessFlags)

Set the access for system/administrative object manipulation

getSystemAccess

public boolean getSystemAccess(int accessType)

Check the access status for a system/administrative object

Parameters:

accessType - the access type

getSystemAccess

public java.util.BitSet getSystemAccess()

Get the access for system/administrative object manipulation

getSystemAccessAsString

public static java.lang.String getSystemAccessAsString(int accessType)

Convert system/administrative object access to OOQL equivalent String

getSystemAccessAsString

public java.lang.String getSystemAccessAsString(java.lang.String delim)

Get the system/administrative object accesses as OOQL equivalent String

Parameters:

delim - the access string separator

getSystemAccessId

public static int getSystemAccessId(java.lang.String access)

Get the system/administrative access type from the equivalent OOQL String

setAdminAccess

public void setAdminAccess(int accessType,
                           boolean accessFlag)

Set the access for administrative object manipulation

Parameters:

accessType - the access type

accessFlag - true to enable / false to disable the access

setAllAdminAccess

public void setAllAdminAccess()

Give the full access to all administrative objects

setNoAdminAccess

public void setNoAdminAccess()

Revoke access to all administrative objects

setAdminAccess

public void setAdminAccess(java.util.BitSet accessFlags)

Set the access for administrative object manipulation

getAdminAccess

public boolean getAdminAccess(int accessType)

Check the access status for a administrative object

Parameters:

accessType - the access type

getAdminAccess

public java.util.BitSet getAdminAccess()

Get the access for administrative object manipulation

getAdminAccessAsString

public static java.lang.String getAdminAccessAsString(int accessType)

Convert administrative object access to OOQL equivalent String

getAdminAccessAsString

public java.lang.String getAdminAccessAsString(java.lang.String delim)

Get the administrative object accesses as OOQL equivalent String

Parameters:

delim - the access string separator

getAdminAccessId

public static int getAdminAccessId(java.lang.String access)

Get the administrative access type from the equivalent OOQL String

setBasicAccess

public void setBasicAccess(int accessType,
                           boolean accessFlag)

Set the global access for ObjectObj and Link manipulation. If the access is disabled the User can never perform the related operation

Parameters:

accessType - the basic access type

accessFlag - true to enable / false to disable the access

setAllBasicAccess

public void setAllBasicAccess()

Set the global access for all ObjectObj and Link operations.

setNoBasicAccess

public void setNoBasicAccess()

Remove the global access for all ObjectObj and Link operations. The User cannot perform any type of operation in the OBEROn environment.

setBasicAccess

public void setBasicAccess(java.util.BitSet accessFlags)

Set the global access for ObjectObj and Link manipulation.

getBasicAccess

public boolean getBasicAccess(int accessType)

Check the access status for a specific ObjectObj or Link manipulation

Parameters:

accessType - the basic access type

getBasicAccess

public java.util.BitSet getBasicAccess()

Get the global access for ObjectObj and Link manipulation.

getBasicAccessAsString

public static java.lang.String getBasicAccessAsString(int accessType)

Convert ObjectObj manipulation access to OOQL equivalent String

getBasicLinkAccessAsString

public static java.lang.String getBasicLinkAccessAsString(int accessType)

Convert Link manipulation access to OOQL equivalent String

getBasicAccessAsString

public java.lang.String getBasicAccessAsString(java.lang.String delim)

Get the ObjectObj and Link manipulation accesses as OOQL equivalent String

Parameters:

delim - the access string separator

getBasicAccessId

public static int getBasicAccessId(java.lang.String access)

Get the ObjectObj manipulation access type from the equivalent OOQL String

getBasicLinkAccessId

public static int getBasicLinkAccessId(java.lang.String access)

Get the Link manipulation access type from the equivalent OOQL String

addTeam

public void addTeam(java.lang.String teamName)

Add this User to a Team; the User will gain the access rights defined for the Team

Parameters:

teamName - the name of the Team

removeTeam

public void removeTeam(java.lang.String teamName)

Remove the User from a Team; the User will loose the access rights defined for the Team

Parameters:

teamName - the name of the Team

updateTeams

public void updateTeams(java.util.Vector<java.lang.String> teams)

Update the teams on the basis of a given list

Parameters:

teams - list of Team's names

Since:

4.0

getOwnTeams

public java.util.Vector<java.lang.String> getOwnTeams()

Return the list of Teams to which the User directly belong

Returns:

Vector of Team names

getOwnTeamsAsString

public java.lang.String getOwnTeamsAsString(java.lang.String delim)

Return the list of Teams to which the User directly belong as String

Parameters:

delim - the separator item

Returns:

list of Team names separated by the delim characters

getTeams

public java.util.Vector<java.lang.String> getTeams(Framework framework)

Return the list of Teams to which the User directly or indirectly belong

Returns:

Vector of Team names

getTeamsAsString

public java.lang.String getTeamsAsString(java.lang.String delim,
                                         Framework framework)

Return the list of Teams to which the User directly or indirectly belong as String

Parameters:

delim - the separator item

Returns:

list of Team names separated by the delim characters

addAssignment

public void addAssignment(java.lang.String assignmentName)

Add a Assignment to this User; the User will gain the access rights defined for the role

Parameters:

assignmentName - the name of the Assignment

removeAssignment

public void removeAssignment(java.lang.String assignmentName)

Remove a Assignment for this User; the User will loose the access rights defined for the role

Parameters:

assignmentName - the name of the Assignment

updateAssignments

public void updateAssignments(java.util.Vector<java.lang.String> assignments)

Update the assignments on the basis of a given list

Parameters:

assignments - list of Assignment's names

Since:

4.0

getOwnAssignments

public java.util.Vector<java.lang.String> getOwnAssignments()

Return the list of Assignment associated directly to this User

Returns:

Vector of Assignment names

getOwnAssignmentsAsString

public java.lang.String getOwnAssignmentsAsString(java.lang.String delim)

Return the list of Assignment associated directly to this User

Parameters:

delim - the separator item

Returns:

list of Assignment names separated by the delim characters

getAssignments

public java.util.Vector<java.lang.String> getAssignments(Framework framework)

Return the list of Assignment associated directly or indirectly to this User. The indirect Assignments are those associated to the User related Teams

Returns:

Vector of Assignment names

getAssignmentsAsString

public java.lang.String getAssignmentsAsString(java.lang.String delim,
                                               Framework framework)

Return the list of Assignment associated directly or indirectly to this User. The indirect Assignments are those associated to the User related Teams

Parameters:

delim - the separator item

Returns:

list of Assignment names separated by the delim characters

getProperty

public java.lang.String getProperty(java.lang.String propertyName,
                                    java.util.Vector<java.lang.Object> filterArgs,
                                    java.lang.String token,
                                    Framework framework)

Get a property for this User object by its OOQL identifier

Specified by:

getProperty in class OBBase

Parameters:

propertyName - OOQL property identifier/name (example: address , fax ...)

filterArgs - extra arguments used to compute properties

token - separator token for complex properties

framework - the current framework

Returns:

the property value

getTargetNames

public java.util.Vector<?> getTargetNames(java.lang.String composedName,
                                          java.util.Vector<java.lang.Object> filterArgs,
                                          Framework framework)

Return a Vector of administrative object names extracted by using an OOQL selector

Specified by:

getTargetNames in class OBBase

Parameters:

composedName - OOQL property identifier/name (example: ownteam, assignment, .. )

filterArgs - extra arguments used to compute properties

framework - the current framework

Returns:

a Vector of target names, used to extract their (sub)properties values

toString

public java.lang.String toString()

Return the User object basic properties as a single String

Overrides:

toString in class AdminBase

toString

public java.lang.String toString(Framework framework)

Return the User object extended properties as a single String

Overrides:

toString in class AdminBase

Parameters:

framework - the current framework

getXMLSystemAccess

public org.jdom.Element getXMLSystemAccess()

Return the system access as XML element tree

getXMLAdminAccess

public org.jdom.Element getXMLAdminAccess()

Return the admin access as XML element tree

getXMLBasicAccess

public org.jdom.Element getXMLBasicAccess()

Return the basic access as XML element tree

toXML

public org.jdom.Element toXML(Framework framework)

Return the User object properties as XML element tree

Specified by:

toXML in class AdminBase

Parameters:

framework - the current framework

toXML

public org.jdom.Element toXML(boolean getImage,
                              boolean fullDump,
                              Framework framework)

Return the User object properties as XML element tree

Specified by:

toXML in class AdminBase

Parameters:

getImage - true to include "imagedata" element with the base64 encoded image data

fullDump - true to include detailed information

framework - the current framework

fromXML

public void fromXML(org.jdom.Element rootElement)

Load the User object from XML element tree

Overrides:

fromXML in class AdminBase

getCreateCommand

public java.lang.String getCreateCommand(boolean force)

Return the OOQL command to create this User object with the settled properties

Specified by:

getCreateCommand in class AdminBase

Parameters:

force - if true append the "force" options at the end

getSaveCommand

public java.lang.String getSaveCommand(boolean force)

Return the OOQL command to update this User object with the modified properties.
If the object is new, it returns the create command.

Specified by:

getSaveCommand in class AdminBase

Parameters:

force - if true append the "force" options at the end

compareUpdate

public java.lang.String compareUpdate(User refUser,
                                      boolean checkImage,
                                      boolean overwrite,
                                      boolean force,
                                      Framework framework)
                               throws OberonException

Return/apply the OOQL command to update this User object and let it become equals to another reference object.
This method is useful to import objects from an XML file.

Parameters:

refUser - the reference User object

checkImage - if true compare also the image icon

overwrite - if true update the database object instance

force - if true ignores optional properties

framework - the current framework

Throws:

OberonException

See Also:

fromXML(Element)