public class TdbUser extends TdbSerializableObject implements com.tietoenator.trip.jxp.internal.utils.DOMSink
Constructor and Description |
---|
TdbUser(TdbSession session)
Constructor, creates a blank instance
|
TdbUser(TdbSession session,
TdbControlObject ob)
Constructor, creates a user instance for the user referenced by the provided Control object
|
Modifier and Type | Method and Description |
---|---|
void |
changeMgr(java.lang.String newmgr)
Move all objects owned by the current user to another user.
|
void |
changeMgr(java.lang.String newmgr,
java.lang.String oldmgr)
Move all objects owned by one user to another user.
|
void |
changeMgr(java.lang.String newmgr,
java.lang.String oldmgr,
java.lang.String name)
Move objects owned by one user to another user.
|
void |
changePassword(java.lang.String oldpw,
java.lang.String newpw)
Change the current user's password.
|
void |
clear()
Clear any state established for this object
|
void |
copy(java.lang.String newname,
java.lang.String newpw,
boolean groups,
TdbControlObject ob)
Create a new user as a copy of an existing one, optionally including group memberships
and private procedures.
|
void |
create(java.lang.String username,
java.lang.String password)
Create a new user on the server with the specified credentials.
|
void |
delete()
Remove the user from the server.
|
void |
delete(java.lang.String username)
Remove a user from the server.
|
void |
export(java.lang.String filename,
boolean groups)
Export the definition of the user to a file.
|
void |
export(java.lang.String filename,
java.lang.String username,
boolean groups)
Export the definition of the user to a file.
|
void |
get()
Retrieve the user's properties from the server.
|
void |
get(java.lang.String username)
Retrieve the specified user's properties from the server.
|
java.lang.String |
getAddress1()
Retrieve the first line of the user's address
|
java.lang.String |
getAddress2()
Retrieve the second line of the user's address
|
java.lang.String |
getCompany()
Retrieve the user's company name
|
int |
getDateform()
Retrieve the date format in use by the user; to retrieve the text version
of a date format, use the
TdbSession.getDateform methods. |
java.lang.String |
getDateformSep()
Retrieve the separators used when formatting date strings
|
boolean |
getIsFM()
Retrieve the user's FM status
|
boolean |
getIsUM()
Retrieve the user's UM status
|
java.lang.String |
getLoginProcedure()
Retrieve the name of the user's login procedure, i.e. the procedure that will always
be run whenever the user initializes a session.
|
java.lang.String |
getPhoneNumber()
Retrieve the user's phone number
|
java.lang.String |
getRealName()
Retrieve the user's "real" name
|
int |
getStartModule()
Obsolete
|
boolean |
getUsesBypass()
Check if the user can enter TRIP without providing a password if the server O/S in
use supports single sign-on
|
void |
importUpdate(java.lang.String filename)
Update the user's definition from a saved file.
|
void |
importUser(java.lang.String filename,
java.lang.String username,
java.lang.String password)
Create a new user from a saved definition.
|
void |
put()
Update the user's properties on the server.
|
void |
put(java.lang.String username)
Update a user's properties on the server.
|
void |
rename(java.lang.String newname)
Rename the user.
|
void |
resetPassword(java.lang.String password)
Reset the user's password -- can only be accomplished by the system manager.
|
void |
setAddress1(java.lang.String address)
Establish the first line of the user's address
|
void |
setAddress2(java.lang.String address)
Established the second line of the user's address
|
void |
setCompany(java.lang.String name)
Establish the user's company name
|
void |
setDateform(int dform)
Establish the date format that will be used by the user; to retrieve the text version
of a date format, use the
TdbSession.getDateform methods. |
void |
setDateformSep(java.lang.String sep)
Establish the separates that will be used when formatting date strings for the user.
|
void |
setIsFM(boolean fm)
Modify the user's FM status; this can only successfully be invoked by the SYSTEM user
|
void |
setIsUM(boolean um)
Modify the user's UM status; this can only successfully be invoked by the SYSTEM user
|
void |
setLoginProcedure(java.lang.String proc)
Establish the name of the user's login procedure, i.e. the procedure that will always
be run whenever the user initializes a session.
|
void |
setPhoneNumber(java.lang.String number)
Establish the user's phone number
|
void |
setRealName(java.lang.String name)
Establish the user's "real" name
|
void |
setStartModule(int module)
Obsolete
|
void |
setUsesBypass(boolean bypass)
Establish the user's ability to enter TRIP without providing a password, provided that
the server O/S supports single sign-on; if the O/S does not support single sign-on, this
setting is ignored
|
getControlObject
codeList, getLastCode, getLastMessage, hasMessages, messageList, resetMessages
cancel, getSession, isCancelable, setCancelable
public TdbUser(TdbSession session, TdbControlObject ob) throws TdbException
session
- Active sessionob
- The Control object reference for the user that will be manipulated by this instanceTdbException
public TdbUser(TdbSession session) throws TdbException
session
- Active sessionTdbException
public java.lang.String getRealName()
public void setRealName(java.lang.String name)
name
- The user's new real namepublic java.lang.String getCompany()
public void setCompany(java.lang.String name)
name
- The user's new company namepublic java.lang.String getAddress1()
public void setAddress1(java.lang.String address)
address
- The first line of the user's new addresspublic java.lang.String getAddress2()
public void setAddress2(java.lang.String address)
address
- The second line of the user's new addresspublic java.lang.String getPhoneNumber()
public void setPhoneNumber(java.lang.String number)
number
- The user's new phone numberpublic java.lang.String getLoginProcedure()
public void setLoginProcedure(java.lang.String proc)
proc
- The name of the user's new login procedurepublic java.lang.String getDateformSep()
public void setDateformSep(java.lang.String sep)
sep
- The user's new date separatorspublic boolean getIsUM()
public void setIsUM(boolean um)
um
- if true, the user will be granted UM privilegepublic boolean getIsFM()
public void setIsFM(boolean fm)
fm
- if true, the user will be granted FM privilegepublic boolean getUsesBypass()
public void setUsesBypass(boolean bypass)
bypass
- If true, the user will be able to enter TRIP without a password if the
server O/S supports single sign-onpublic int getDateform()
TdbSession.getDateform
methods.public void setDateform(int dform)
TdbSession.getDateform
methods.dform
- The index of the dateform to be usedpublic int getStartModule()
public void setStartModule(int module)
module
- N/Apublic void clear()
public void get(java.lang.String username) throws TdbException
username
- The name of user for whom properties are to be retrievedTdbException
public void get() throws TdbException
TdbException
public void create(java.lang.String username, java.lang.String password) throws TdbException
username
- The username of the new userpassword
- The password of the new userTdbException
public void delete(java.lang.String username) throws TdbException
username
- The name of the user to be removedTdbException
public void delete() throws TdbException
TdbException
public void put(java.lang.String username) throws TdbException
username
- The name of user for whom properties are to be updatedTdbException
public void put() throws TdbException
TdbException
public void resetPassword(java.lang.String password) throws TdbException
password
- The new password to setTdbException
public void changePassword(java.lang.String oldpw, java.lang.String newpw) throws TdbException
oldpw
- The current passwordnewpw
- The password to be assigned to the currently logged-in userTdbException
public void rename(java.lang.String newname) throws TdbException
newname
- The new name of the user.TdbException
public void changeMgr(java.lang.String newmgr, java.lang.String oldmgr, java.lang.String name) throws TdbException
newmgr
- Name of planned new owner of objectsoldmgr
- Name of current owner of objectsname
- Name of object to moveTdbException
public void changeMgr(java.lang.String newmgr, java.lang.String oldmgr) throws TdbException
newmgr
- Name of planned new owner of objectsoldmgr
- Name of current owner of objectsTdbException
public void changeMgr(java.lang.String newmgr) throws TdbException
newmgr
- Name of planned new owner of objectsTdbException
public void export(java.lang.String filename, java.lang.String username, boolean groups) throws TdbException
filename
- The name of the file to which to write the user's definitionusername
- The name of the user to exportgroups
- If true, the user's group membership associations will also be exportedTdbException
public void export(java.lang.String filename, boolean groups) throws TdbException
filename
- The name of the file to which to write the user's definitiongroups
- If true, the user's group membership associations will also be exportedTdbException
public void importUpdate(java.lang.String filename) throws TdbException
filename
- The name of the file from which to read the user's definitionTdbException
public void importUser(java.lang.String filename, java.lang.String username, java.lang.String password) throws TdbException
filename
- The name of the file containing the saved definitionusername
- The name of the user to createpassword
- The password to assign to the new userTdbException
public void copy(java.lang.String newname, java.lang.String newpw, boolean groups, TdbControlObject ob) throws TdbException
newname
- The name of the new user to be creatednewpw
- The password to be assigned to the new usergroups
- If set true, group memberships are copiedob
- If not null, the Control object pointed to will be updated with information about
the new user upon completion of the operationTdbException