com.ibm.edms.od
Class ODUser

java.lang.Object
  com.ibm.edms.od.ODUser

All Implemented Interfaces:

java.io.Serializable

public class ODUser
extends java.lang.Object
implements java.io.Serializable

A class representing an OnDemand User. From this class you can gather user information such as Address and Phone Number that is stored in the OnDemand Server. For a more detailed description of an OnDemand user please see Chapter 14 of the OnDemand Administrator's Guide and the online help for the OnDemand Administrative GUI.
See the ODServer.getUser() to get an ODUser object for the user that is currently logged on.

(c) Copyright IBM Corp. 1993, 2003. All Rights Reserved

See Also:

ODServer.getUser(), Serialized Form

Method Summary

java.lang.String	getAcctInfo() Get the Account Info.
java.lang.String	getAddr1() Get address1
java.lang.String	getAddr2() Get Address2
java.lang.String	getAddr3() Get Address3
java.lang.String	getAddr4() Get Address4
long	getAuthority() Get User Authority
java.lang.String	getBuilding() Get User Building
java.lang.String	getCompany() Get User Company
java.lang.String	getCoverPage() Get User cover page
java.lang.String	getDept() Get User Department
java.lang.String	getDesc() Get User Description.
java.lang.String	getEmail() Get User email.
java.lang.String	getFax() Get User Fax number
java.lang.String	getFullName() Get User Full Name.
java.lang.String[]	getGroupNames() Get the Group names of which this user is a member.
java.lang.String	getPhone() Get User Phone Number.
java.lang.String	getPrintBanner() Get User Print Banner
java.lang.String	getPrintClass() Get Print Class
java.lang.String	getPrinter() Get User Printer.
java.lang.String	getPrinterID() Get the Printer Dest
java.lang.String	getPrintFormDef() Get the User's Print FormDef
java.lang.String	getPrintForms() Get the User's Print Forms
java.lang.String	getPrintNode() Get the User's Print Node.
java.lang.String	getPrintPageDef() Get the User's PageDef
java.lang.String	getPrintRouting() Get the User's Print Routing.
java.lang.String	getPrintWriter() Get the User's Print writer
java.lang.String	getRoom() Get User Room
int	getTimeOut() Get User TimeOut
java.lang.String	getTitle() Get User Title
long	getUid() Get UserID
java.lang.String	getUserName() Get the User Name
void	setPrintBanner(java.lang.String printBanner) Set Print Banner.
void	setPrintClass(java.lang.String printClass) Set Print Class
void	setPrinterID(java.lang.String printerID) Set Printer Dest
void	setPrintFormDef(java.lang.String printFormDef) Set the User's Print FormDef
void	setPrintForms(java.lang.String printForms) Set the User's Print Forms.
void	setPrintNode(java.lang.String printNode) Set the User's Print Node.
void	setPrintPageDef(java.lang.String printPageDef) Set the User's PageDef.
void	setPrintRouting(java.lang.String printRouting) Set the User's Print Routing.
void	setPrintWriter(java.lang.String printWriter) Set the User's Print Writer
java.lang.String	toString()
void	updateUserPrintOpts() Update the Print options for this user on the OnDemand Server.

Methods inherited from class java.lang.Object

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

Method Detail

updateUserPrintOpts

public void updateUserPrintOpts()
                         throws ODException

Update the Print options for this user on the OnDemand Server. This method will overwrite the existing print settings in the OnDemand User definition at the OnDemand Server.

Throws:

ODException

getUserName

public java.lang.String getUserName()

Get the User Name

Returns:

Returns the UserName.

getAcctInfo

public java.lang.String getAcctInfo()

Get the Account Info.

Returns:

Returns the acctInfo.

getAddr1

public java.lang.String getAddr1()

Get address1

Returns:

Returns the addr1.

getAddr2

public java.lang.String getAddr2()

Get Address2

Returns:

Returns the addr2.

getAddr3

public java.lang.String getAddr3()

Get Address3

Returns:

Returns the addr3.

getAddr4

public java.lang.String getAddr4()

Get Address4

Returns:

Returns the addr4.

getAuthority

public long getAuthority()

Get User Authority

Returns:

Returns the user authority as defined by the OnDemand Admin.

See Also:

ODConstant.OD_USER_TYPE_USER, and other USER_TYPE definitions for values that can be returned.

getBuilding

public java.lang.String getBuilding()

Get User Building

Returns:

Returns the building.

getCompany

public java.lang.String getCompany()

Get User Company

Returns:

Returns the company.

getCoverPage

public java.lang.String getCoverPage()

Get User cover page

Returns:

Returns the coverPage.

getDept

public java.lang.String getDept()

Get User Department

Returns:

Returns the department specified for this user.

getDesc

public java.lang.String getDesc()

Get User Description.

Returns:

Returns the description for this user.

getEmail

public java.lang.String getEmail()

Get User email.

Returns:

Returns the email.

getFax

public java.lang.String getFax()

Get User Fax number

Returns:

Returns the fax.

getFullName

public java.lang.String getFullName()

Get User Full Name.

Returns:

Returns the fullName.

getPhone

public java.lang.String getPhone()

Get User Phone Number.

Returns:

Returns the phone.

getPrinter

public java.lang.String getPrinter()
                            throws java.lang.Exception

Get User Printer.

Returns:

Returns the name of the User's default printer.

Throws:

java.lang.Exception

getRoom

public java.lang.String getRoom()

Get User Room

Returns:

Returns the room.

getTimeOut

public int getTimeOut()

Get User TimeOut

Returns:

Returns the timeOut.

getTitle

public java.lang.String getTitle()

Get User Title

Returns:

Returns the title.

getUid

public long getUid()

Get UserID

Returns:

Returns the user id.

getPrintBanner

public java.lang.String getPrintBanner()

Get User Print Banner

Returns:

Returns the printBanner.

setPrintBanner

public void setPrintBanner(java.lang.String printBanner)

Set Print Banner. Enter "Y" or "N".

Parameters:

printBanner - The printBanner to set.

NOTE: Only applicable when running against OnDemand Z/OS servers.

getPrintClass

public java.lang.String getPrintClass()

Get Print Class

Returns:

Returns the printClass.

NOTE: Only applicable when running against OnDemand Z/OS servers.

setPrintClass

public void setPrintClass(java.lang.String printClass)

Set Print Class

Parameters:

printClass - The printClass to set.

NOTE: Only applicable when running against OnDemand Z/OS servers.

getPrinterID

public java.lang.String getPrinterID()

Get the Printer Dest

Returns:

Returns the printer Dest.

NOTE: Only applicable when running against OnDemand Z/OS servers.

setPrinterID

public void setPrinterID(java.lang.String printerID)

Set Printer Dest

Parameters:

printerID - The printer Dest to set.

NOTE: Only applicable when running against OnDemand Z/OS servers.

getPrintFormDef

public java.lang.String getPrintFormDef()

Get the User's Print FormDef

Returns:

Returns the printFormDef.

NOTE: Only applicable when running against OnDemand Z/OS servers.

setPrintFormDef

public void setPrintFormDef(java.lang.String printFormDef)

Set the User's Print FormDef

Parameters:

printFormDef - The printFormDef to set.

NOTE: Only applicable when running against OnDemand Z/OS servers.

getPrintForms

public java.lang.String getPrintForms()

Get the User's Print Forms

Returns:

Returns the printForms.

NOTE: Only applicable when running against OnDemand Z/OS servers.

setPrintForms

public void setPrintForms(java.lang.String printForms)

Set the User's Print Forms.

Parameters:

printForms - The printForms to set.

NOTE: Only applicable when running against OnDemand Z/OS servers.

getPrintNode

public java.lang.String getPrintNode()

Get the User's Print Node.

Returns:

Returns the printNode.

NOTE: Only applicable when running against OnDemand Z/OS servers.

setPrintNode

public void setPrintNode(java.lang.String printNode)

Set the User's Print Node.

Parameters:

printNode - The printNode to set.

NOTE: Only applicable when running against OnDemand Z/OS servers.

getPrintPageDef

public java.lang.String getPrintPageDef()

Get the User's PageDef

Returns:

Returns the printPageDef.

NOTE: Only applicable when running against OnDemand Z/OS servers.

setPrintPageDef

public void setPrintPageDef(java.lang.String printPageDef)

Set the User's PageDef.

Parameters:

printPageDef - The printPageDef to set.

NOTE: Only applicable when running against OnDemand Z/OS servers.

getPrintRouting

public java.lang.String getPrintRouting()

Get the User's Print Routing.

Returns:

Returns the printRouting.

NOTE: Only applicable when running against OnDemand Z/OS servers.

setPrintRouting

public void setPrintRouting(java.lang.String printRouting)

Set the User's Print Routing.

Parameters:

printRouting - The printRouting to set.

NOTE: Only applicable when running against OnDemand Z/OS servers.

getPrintWriter

public java.lang.String getPrintWriter()

Get the User's Print writer

Returns:

Returns the printWriter.

NOTE: Only applicable when running against OnDemand Z/OS servers.

setPrintWriter

public void setPrintWriter(java.lang.String printWriter)

Set the User's Print Writer

Parameters:

printWriter - The printWriter to set.

NOTE: Only applicable when running against OnDemand Z/OS servers.

getGroupNames

public java.lang.String[] getGroupNames()
                                 throws java.lang.Exception

Get the Group names of which this user is a member.

Returns:

an array containing User Group names. This array will be empty if user is not a member of any groups.

Throws:

java.lang.Exception

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object