com.openexchange.admin.rmi.dataobjects
Class User

java.lang.Object
  extended by com.openexchange.admin.rmi.dataobjects.EnforceableDataObject
      extended by com.openexchange.admin.rmi.dataobjects.ExtendableDataObject
          extended by com.openexchange.admin.rmi.dataobjects.User
All Implemented Interfaces:
NameAndIdObject, PasswordMechObject, Serializable, Cloneable

public class User
extends ExtendableDataObject
implements NameAndIdObject, PasswordMechObject

Class representing a user.

Author:
Manuel Kraft, Carsten Hoeger, Dennis Sieben
See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.openexchange.admin.rmi.dataobjects.PasswordMechObject
CRYPT_MECH, SHA_MECH
 
Constructor Summary
User()
          Instantiates a new empty user object
User(int id)
          Instantiates a new user object with the given id set
 
Method Summary
 void addAlias(String alias)
          Adds an E-Mail alias to the current list of aliases of this user object
 void addExtension(OXUserExtensionInterface extension)
          Deprecated.  
 void addGuiPreferences(String path, String guiValue)
          add a path/value pair to gui settings
 Object clone()
           
 boolean equals(Object obj)
           
 HashSet<String> getAliases()
          Returns the complete E-mail aliases of this user object
 List<String> getAliasesForSOAP()
           
 Date getAnniversary()
          Returns the anniversary of this user object
 String getAssistant_name()
          Returns the name of the assistant of this user object
 Date getBirthday()
          Returns the birthday of this user object
 String getBranches()
          Returns the branches of this user object
 String getBusiness_category()
          Returns the business_category of this user object
 String getCategories()
          Returns the categories of this user object
 String getCellular_telephone1()
          Returns the mobile phone number of this user object
 String getCellular_telephone2()
          Returns the second mobile phone number of this user object
 String getCity_business()
          Returns the city for the business location of this user object
 String getCity_home()
          Returns the city for the home location of this user object
 String getCity_other()
          Returns the city for a further location of this user object
 String getCommercial_register()
          Returns the commercial_register of this user object
 String getCompany()
          Returns the company of this user object
 String getCountry_business()
          Returns the country for the business location of this user object
 String getCountry_home()
          Returns the country of the home location of this user object
 String getCountry_other()
          Returns the country for a further location of this user object
 Group getDefault_group()
          Returns the default group of this user object
 String getDefaultSenderAddress()
          Returns the default sender address of this user object
 String getDepartment()
          Returns the department of this user object
 String getDisplay_name()
          Returns the display name of this user object
 String getEmail1()
           
 String getEmail2()
          Returns the home E-Mail of this user object
 String getEmail3()
          Returns the E-Mail (other) of this user object
 String getEmployeeType()
          Returns the job title of this user object
 ArrayList<OXUserExtensionInterface> getExtensionbyName(String extname)
          Deprecated.  
 ArrayList<OXUserExtensionInterface> getExtensions()
          Deprecated.  
 String getFax_business()
          Returns the fax number for the business location of this user object
 String getFax_home()
          Returns the fax number for the home location of this user object
 String getFax_other()
          Returns the fax number for a further location of this user object
 OXUserExtensionInterface getFirstExtensionbyName(String extname)
          Deprecated.  
 Integer getFolderTree()
           
 String getGiven_name()
          Returns the the first name of user
 Boolean getGUI_Spam_filter_capabilities_enabled()
          Deprecated. use getGui_spam_filter_enabled() instead
 Boolean getGui_spam_filter_enabled()
           
 Map<String,String> getGuiPreferences()
           
 Integer getId()
          Returns the id of the user
 String getImapLogin()
          Returns the login for the imap server of this user object
 int getImapPort()
          Deprecated. since 6.20. Use getImapServerString() instead.
 String getImapSchema()
          Deprecated. since 6.20. Use getImapServerString() instead.
 String getImapServer()
          Deprecated. since 6.20. Use getImapServerString() instead.
 String getImapServerString()
          Returns the URL of the IMAP server of this user object.
 String getInfo()
          Returns the info field of this user object
 String getInstant_messenger1()
          Returns the instant messenger address for the business location of this user object
 String getInstant_messenger2()
          Returns the instant messenger address for the private location of this user object
 String getLanguage()
          Returns the language setting of this user object
 String getMail_folder_confirmed_ham_name()
           
 String getMail_folder_confirmed_spam_name()
           
 String getMail_folder_drafts_name()
          Returns the mail folder name of the drafts folder of this user object
 String getMail_folder_sent_name()
          Returns the mail folder name of the sent folder of this user object
 String getMail_folder_spam_name()
          Returns the mail folder name of the spam folder of this user object
 String getMail_folder_trash_name()
          Returns the mail folder name of the trash folder of this user object
 Boolean getMailenabled()
          Currently not used
 String getManager_name()
          Returns the name of the manager of this user object
 String[] getMandatoryMembersChange()
          At the moment no fields are defined here
 String[] getMandatoryMembersCreate()
          At the moment setName(java.lang.String), setDisplay_name(java.lang.String), setPassword(String), setGiven_name(String), setSur_name(String) and setPrimaryEmail(String) are defined here
 String[] getMandatoryMembersDelete()
          At the moment no fields are defined here
 String[] getMandatoryMembersRegister()
          At the moment no fields are defined here
 String getMarital_status()
          Returns the marital status of this user object
 String getMiddle_name()
          Returns the middle name of this user object
 String getName()
          Returns the name of this object
 Map<String,String> getNamespace(String namespace)
           
 String getNickname()
          Returns the nickname of this user object
 String getNote()
          Returns the note field of this user object
 String getNumber_of_children()
          Returns the number of children of this user object
 String getNumber_of_employee()
          Returns the employee identifier of this user object
 Boolean getPassword_expired()
          Returns if the password of this user object is expired
 String getPassword()
          Return the password of this user object.
 String getPasswordMech()
           
 String getPosition()
          Returns the position field of this user object
 String getPostal_code_business()
          Returns the postal_code_otherset of this user object
 String getPostal_code_home()
          Returns the postal code of the home location of this user object
 String getPostal_code_other()
          Returns the postal code for a further location of this user object
 String getPrimaryEmail()
          Returns the primary E-Mail address of this user object
 String getProfession()
          Returns the profession of this user object
 String getRoom_number()
          Returns the room number of this user object
 String getSales_volume()
          Returns the sales volume of this user object
 int getSmtpPort()
          Deprecated. since 6.20. Use getSmtpServerString() instead.
 String getSmtpSchema()
          Deprecated. since 6.20. Use getSmtpServerString() instead.
 String getSmtpServer()
          Deprecated. since 6.20. Use getSmtpServerString() instead.
 String getSmtpServerString()
          Returns the URL of the SMTP server of this user object.
 Boolean getSpam_filter_enabled()
          Deprecated. use getGui_spam_filter_enabled() instead
 String getSpouse_name()
          Returns the name of the spouse of this user object
 String getState_business()
          Returns the state of the business of this user object
 String getState_home()
          Returns the state of the home location of this user object
 String getState_other()
          Returns the state for a further location of this user object
 String getStreet_business()
          Returns the street of the business of this user object
 String getStreet_home()
          Returns the street of the home location of this user object
 String getStreet_other()
          Returns the street for a further location of this user object
 String getSuffix()
          Returns the suffix of this user object
 String getSur_name()
          Return the last name of this user object
 String getTax_id()
          Returns the tax id of this user object
 String getTelephone_assistant()
          Returns the telephone number of the assistant of this user object
 String getTelephone_business1()
          Returns the telephone number of the business location of this user object
 String getTelephone_business2()
          Returns the second telephone number of the business location of this user object
 String getTelephone_callback()
          Returns the telephone_callback of this user object
 String getTelephone_car()
          Returns the telephone number for the car phone of this user object
 String getTelephone_company()
          Returns the telephone number of the company of this user object
 String getTelephone_home1()
          Returns the first telephone number of the home location of this user object
 String getTelephone_home2()
          Returns the second telephone number of the home location of this user object
 String getTelephone_ip()
          Returns the telephone number for ip telephony of this user object
 String getTelephone_isdn()
          Returns the telephone number for isdn telephony of this user object
 String getTelephone_other()
          Returns a further specified telephone number of this user object
 String getTelephone_pager()
          Returns the number of the telephone pager of this user object
 String getTelephone_primary()
          Currently not used
 String getTelephone_radio()
          Currently not used
 String getTelephone_telex()
          Returns the telephone number for the telex of this user object
 String getTelephone_ttytdd()
          Returns the telephone number for the TTY/TDD of this user object
 String getTimezone()
          Returns the timezone of this user object
 String getTitle()
          Returns the title of this user object
 Integer getUploadFileSizeLimit()
          Returns the upload file size limit of this user object
 Integer getUploadFileSizeLimitPerFile()
          Returns the upload file size limit per file of this user object
 String getUrl()
          Returns the URL of this user object
 String getUserAttribute(String namespace, String name)
          Read a generic user attribute
 Map<String,Map<String,String>> getUserAttributes()
           
 String getUserfield01()
          Returns the dynamic field no 1 of this user object
 String getUserfield02()
          Returns the dynamic field no 2 of this user object
 String getUserfield03()
          Returns the dynamic field no 3 of this user object
 String getUserfield04()
          Returns the dynamic field no 4 of this user object
 String getUserfield05()
          Returns the dynamic field no 5 of this user object
 String getUserfield06()
          Returns the dynamic field no 6 of this user object
 String getUserfield07()
          Returns the dynamic field no 7 of this user object
 String getUserfield08()
          Returns the dynamic field no 8 of this user object
 String getUserfield09()
          Returns the dynamic field no 9 of this user object
 String getUserfield10()
          Returns the dynamic field no 10 of this user object
 String getUserfield11()
          Returns the dynamic field no 11 of this user object
 String getUserfield12()
          Returns the dynamic field no 12 of this user object
 String getUserfield13()
          Returns the dynamic field no 13 of this user object
 String getUserfield14()
          Returns the dynamic field no 14 of this user object
 String getUserfield15()
          Returns the dynamic field no 15 of this user object
 String getUserfield16()
          Returns the dynamic field no 16 of this user object
 String getUserfield17()
          Returns the dynamic field no 17 of this user object
 String getUserfield18()
          Returns the dynamic field no 18 of this user object
 String getUserfield19()
          Returns the dynamic field no 19 of this user object
 String getUserfield20()
          Returns the dynamic field no 20 of this user object
 int hashCode()
           
static User hashmapToUser(HashMap<String,Object> hm)
           
 boolean isAliasesset()
          Used to check if the aliases field of this user object has been changed
 boolean isAnniversaryset()
          Used to check if the anniversary field of this user object has been changed
 boolean isAssistant_nameset()
          Used to check if the assistant_name field of this user object has been changed
 boolean isBirthdayset()
          Used to check if the birthday field of this user object has been changed
 boolean isBranchesset()
          Used to check if the branches field of this user object has been changed
 boolean isBusiness_categoryset()
          Used to check if the business_category field of this user object has been changed
 boolean isCategoriesset()
          Used to check if the categories field of this user user has been changed
 boolean isCellular_telephone1set()
          Used to check if the cellular_telephone1 field of this user object has been changed
 boolean isCellular_telephone2set()
          Used to check if the cellular_telephone2 field of this user object has been changed
 boolean isCity_businessset()
          Used to check if the city_business field of this user object has been changed
 boolean isCity_homeset()
          Used to check if the city_home field of this user object has been changed
 boolean isCity_otherset()
          Used to check if the city_other field of this user object has been changed
 boolean isCommercial_registerset()
          Used to check if the commercial_register field of this user object has been changed
 boolean isCompanyset()
          Used to check if the company field of this user object has been changed
 boolean isContextadmin()
          Used to check if the contextadmin field of this user object has been changed
 boolean isCountry_businessset()
          Used to check if the country_business field of this user object has been changed
 boolean isCountry_homeset()
          Used to check if the country_home field of this user object has been changed
 boolean isCountry_otherset()
          Used to check if the country_other field of this user object has been changed
 boolean isDefault_groupset()
          Used to check if the default_group field of this user object has been changed
 boolean isDefaultSenderAddressset()
          Used to check if the contextadmin field of this user object has been changed
 boolean isDepartmentset()
          Used to check if the department field of this user object has been changed
 boolean isDisplay_nameset()
          Used to check if the display_name field of this user object has been changed
 boolean isEmail1set()
          Used to check if the email1 field of this user object has been changed
 boolean isEmail2set()
          Used to check if the email2 field of this user object has been changed
 boolean isEmail3set()
          Used to check if the email3 field of this user object has been changed
 boolean isEmployeeTypeset()
          Used to check if the employeetype field of this user object has been changed
 boolean isFax_businessset()
          Used to check if the fax_business field of this user object has been changed
 boolean isFax_homeset()
          Used to check if the fax_home field of this user object has been changed
 boolean isFax_otherset()
          Used to check if the fax_other field of this user object has been changed
 boolean isFolderTreeSet()
           
 boolean isGiven_nameset()
          Used to check if the given_name field of this user object has been changed
 boolean isGUI_Spam_filter_capabilities_enabledset()
          Deprecated. use isGui_spam_filter_enabledset() instead
 boolean isGui_spam_filter_enabledset()
          Used to check if the gui_spam_filter_capabilities_enabled field of this user object has been changed
 boolean isGuiPreferencesset()
           
 boolean isIdset()
          Used to check if the id field of this user object has been changed
 boolean isImapLoginset()
          Used to check if the imaplogin field of this user object has been changed
 boolean isImapServerset()
          Used to check if the imapserver field of this user object has been changed
 boolean isInfoset()
          Used to check if the info field of this user object has been changed
 boolean isInstant_messenger1set()
          Used to check if the instant_messenger1 field of this user object has been changed
 boolean isInstant_messenger2set()
          Used to check if the instant_messenger2 field of this user object has been changed
 boolean isLanguageset()
          Used to check if the language field of this user object has been changed
 boolean isMail_folder_confirmed_hamset()
          Used to check if the mail_folder_confirmed_ham field of this user object has been changed
 boolean isMail_folder_confirmed_spamset()
          Used to check if the mail_folder_confirmed_spam field of this user object has been changed
 boolean isMail_folder_drafts_nameset()
          Used to check if the mail_folder_drafts_name field of this user object has been changed
 boolean isMail_folder_sent_nameset()
          Used to check if the mail_folder_sent_name field of this user object has been changed
 boolean isMail_folder_spam_nameset()
          Used to check if the mail_folder_spam_name field of this user object has been changed
 boolean isMail_folder_trash_nameset()
          Used to check if the mail_folder_trash_name field of this user object has been changed
 boolean isMailenabledset()
          Currently not used
 boolean isManager_nameset()
          Used to check if the manager_name field of this user object has been changed
 boolean isMarital_statusset()
          Used to check if the marital_status field of this user object has been changed
 boolean isMiddle_nameset()
          Used to check if the middle_name field of this user object has been changed
 boolean isNameset()
          Used to check if the name field of this user object has been changed
 boolean isNicknameset()
          Used to check if the nickname field of this user object has been changed
 boolean isNoteset()
          Used to check if the note field of this user object has been changed
 boolean isNumber_of_childrenset()
          Used to check if the number_of_children field of this user object has been changed
 boolean isNumber_of_employeeset()
          Used to check if the number_of_employee field of this user object has been changed
 boolean isPassword_expiredset()
          Used to check if the password_expired field of this user object has been changed
 boolean isPasswordMechset()
          Used to check if the passwordmech field of this user object has been changed
 boolean isPasswordset()
          Used to check if the password field of this user object has been changed
 boolean isPositionset()
          Used to check if the position field of this user object has been changed
 boolean isPostal_code_businessset()
          Used to check if the postal_code_business field of this user object has been changed
 boolean isPostal_code_homeset()
          Used to check if the postal_code_home field of this user object has been changed
 boolean isPostal_code_otherset()
          Used to check if the postal_code_other field of this user object has been changed
 boolean isPrimaryEmailset()
          Used to check if the primaryemail field of this user object has been changed
 boolean isProfessionset()
          Used to check if the profession field of this user object has been changed
 boolean isRoom_numberset()
          Used to check if the room_number field of this user object has been changed
 boolean isSales_volumeset()
          Used to check if the sales_volume field of this user object has been changed
 boolean isSmtpServerset()
          Used to check if the smtpserver field of this user object has been changed
 boolean isSpouse_nameset()
          Used to check if the spouse_name field of this user object has been changed
 boolean isState_businessset()
          Used to check if the state_business field of this user object has been changed
 boolean isState_homeset()
          Used to check if the state_home field of this user object has been changed
 boolean isState_otherset()
          Used to check if the state_other field of this user object has been changed
 boolean isStreet_businessset()
          Used to check if the street_business field of this user object has been changed
 boolean isStreet_homeset()
          Used to check if the street_home field of this user object has been changed
 boolean isStreet_otherset()
          Used to check if the street_other field of this user object has been changed
 boolean isSuffixset()
          Used to check if the suffix field of this user object has been changed
 boolean isSur_nameset()
          Used to check if the sur_name field of this user object has been changed
 boolean isTax_idset()
          Used to check if the tax_id field of this user object has been changed
 boolean isTelephone_assistantset()
          Used to check if the telephone_assistant field of this user object has been changed
 boolean isTelephone_business1set()
          Used to check if the telephone_business1 field of this user object has been changed
 boolean isTelephone_business2set()
          Used to check if the telephone_business2 field of this user object has been changed
 boolean isTelephone_callbackset()
          Used to check if the telephone_callback field of this user object has been changed
 boolean isTelephone_carset()
          Used to check if the telephone_car field of this user object has been changed
 boolean isTelephone_companyset()
          Used to check if the telephone_company field of this user object has been changed
 boolean isTelephone_home1set()
          Used to check if the telephone_home1 field of this user object has been changed
 boolean isTelephone_home2set()
          Used to check if the telephone_home2 field of this user object has been changed
 boolean isTelephone_ipset()
          Used to check if the telephone_ip field of this user object has been changed
 boolean isTelephone_isdnset()
          Used to check if the telephone_isdn field of this user object has been changed
 boolean isTelephone_otherset()
          Used to check if the telephone_other field of this user object has been changed
 boolean isTelephone_pagerset()
          Used to check if the telephone_pager field of this user object has been changed
 boolean isTelephone_primaryset()
          Used to check if the telephone_primary field of this user object has been changed
 boolean isTelephone_radioset()
          Used to check if the telephone_radio field of this user object has been changed
 boolean isTelephone_telexset()
          Used to check if the telephone_telex field of this user object has been changed
 boolean isTelephone_ttytddset()
          Used to check if the telephone_ttytdd field of this user object has been changed
 boolean isTimezoneset()
          Used to check if the timezone field of this user object has been changed
 boolean isTitleset()
          Used to check if the title field of this user object has been changed
 boolean isUploadFileSizeLimitPerFileset()
          Used to check if the upload file size limit per file of this user object has been changed
 boolean isUploadFileSizeLimitset()
          Used to check if the upload quota of this user object has been changed
 boolean isUrlset()
          Used to check if the url field of this user object has been changed
 boolean isUserAttributesset()
          Used to check if the user attributes have been modified
 boolean isUserfield01set()
          Used to check if the userfield01 field of this user object has been changed
 boolean isUserfield02set()
          Used to check if the userfield02 field of this user object has been changed
 boolean isUserfield03set()
          Used to check if the userfield03 field of this user object has been changed
 boolean isUserfield04set()
          Used to check if the userfield04 field of this user object has been changed
 boolean isUserfield05set()
          Used to check if the userfield05 field of this user object has been changed
 boolean isUserfield06set()
          Used to check if the userfield06 field of this user object has been changed
 boolean isUserfield07set()
          Used to check if the userfield07 field of this user object has been changed
 boolean isUserfield08set()
          Used to check if the userfield08 field of this user object has been changed
 boolean isUserfield09set()
          Used to check if the userfield09 field of this user object has been changed
 boolean isUserfield10set()
          Used to check if the userfield10 field of this user object has been changed
 boolean isUserfield11set()
          Used to check if the userfield11 field of this user object has been changed
 boolean isUserfield12set()
          Used to check if the userfield12 field of this user object has been changed
 boolean isUserfield13set()
          Used to check if the userfield13 field of this user object has been changed
 boolean isUserfield14set()
          Used to check if the userfield14 field of this user object has been changed
 boolean isUserfield15set()
          Used to check if the userfield15 field of this user object has been changed
 boolean isUserfield16set()
          Used to check if the userfield16 field of this user object has been changed
 boolean isUserfield17set()
          Used to check if the userfield17 field of this user object has been changed
 boolean isUserfield18set()
          Used to check if the userfield18 field of this user object has been changed
 boolean isUserfield19set()
          Used to check if the userfield19 field of this user object has been changed
 boolean isUserfield20set()
          Used to check if the userfield20 field of this user object has been changed
 boolean removeAlias(String alias)
          Removes the specified E-Mail alias from the list of this user object
 boolean removeExtension(OXUserExtensionInterface o)
          Deprecated.  
 OXUserExtensionInterface removeExtensionByIndex(int index)
          Deprecated.  
 void removeGuiPreferences(String path)
          remove a path/value pair from gui settings
 void setAliases(HashSet<String> aliases)
          Sets the E-Mail aliases for this user object
 void setAliasesForSOAP(List<String> aliases)
           
 void setAnniversary(Date anniversary)
          Sets the anniversary for this user object
 void setAssistant_name(String assistant_name)
          Sets the name of the assistant for this user object
 void setBirthday(Date birthday)
          Sets the birthday for this user object
 void setBranches(String branches)
          Sets the branches for this user object
 void setBusiness_category(String business_category)
          Sets the business_category for this user object
 void setCategories(String categories)
          Sets the categories for this user object
 void setCellular_telephone1(String cellular_telephone1)
          Sets the mobile phone number for this user object
 void setCellular_telephone2(String cellular_telephone2)
          Sets the second mobile phone number for this user object
 void setCity_business(String city_business)
          Sets the city for the business location for this user object
 void setCity_home(String city_home)
          Sets the city for the home location for this user object
 void setCity_other(String city_other)
          Sets the city for a further location for this user object
 void setCommercial_register(String commercial_register)
          Sets the commercial_register for this user object
 void setCompany(String company)
          Sets the company for this user object
 void setContextadmin(boolean contextadmin)
          Note: calling this setter on a user object has no influence on the user stored within the ox subsystem, as it is not possible to change the admin status of a user.
 void setCountry_business(String country_business)
          Sets the country for the business location for this user object
 void setCountry_home(String country_home)
          Sets the country of the home location for this user object
 void setCountry_other(String country_other)
          Sets the country for a further location for this user object
 void setDefault_group(Group default_group)
          The default group when creating an user.
 void setDefaultSenderAddress(String defaultSenderAddress)
          Sets the default sender address for this user object
 void setDepartment(String department)
          Sets the department for this user object
 void setDisplay_name(String display_name)
          Sets the display name for this user object
 void setEmail1(String email1)
          Sets the E-Mail for the business location for this user object
 void setEmail2(String email2)
          Sets the home E-Mail for this user object
 void setEmail3(String email3)
          Sets the E-Mail (other) for this user object
 void setEmployeeType(String employeeType)
          Sets the job title for this user object
 void setFax_business(String fax_business)
          Sets the fax number for the business location for this user object
 void setFax_home(String fax_home)
          Sets the fax number for the home location for this user object
 void setFax_other(String fax_other)
          Sets the fax number for a further location for this user object
 void setFolderTree(Integer folderTree)
           
 void setGiven_name(String given_name)
          Sets the first name of user
 void setGUI_Spam_filter_capabilities_enabled(Boolean gui_spam_filter_enabled)
          Deprecated. use setGui_spam_filter_enabled(Boolean) instead
 void setGui_spam_filter_enabled(Boolean gui_spam_filter_enabled)
           
 void setGuiPreferences(Map<String,String> guiPreferences)
           
 void setId(Integer userid)
          Sets the numeric user id
 void setImapLogin(String imapLogin)
          Sets the login for the imap server for this user object
 void setImapServer(String imapServer)
          Sets the users imap server if not localhost should be used.
 void setInfo(String info)
          Sets the info field for this user object
 void setInstant_messenger1(String instant_messenger1)
          Sets the instant messenger address for the business location for this user object
 void setInstant_messenger2(String instant_messenger2)
          Sets the instant messenger address for the private location for this user object
 void setLanguage(String language)
          Sets the language for this user object.
 void setMail_folder_confirmed_ham_name(String mail_folder_confirmed_ham_name)
          Set the name of the folder where mail should be copied, that should be learned as HAM using whatever mechanism on the server side
 void setMail_folder_confirmed_spam_name(String mail_folder_confirmed_spam_name)
          Set the name of the folder where mail should be moved, that should be learned as SPAM using whatever mechanism on the server side
 void setMail_folder_drafts_name(String mail_folder_drafts_name)
          Sets the mail folder name of the drafts folder for this user object
 void setMail_folder_sent_name(String mail_folder_sent_name)
          Sets the mail folder name of the sent folder for this user object
 void setMail_folder_spam_name(String mail_folder_spam_name)
          Sets the name of the users SPAM folder where detected SPAM mail will be moved into.
 void setMail_folder_trash_name(String mail_folder_trash_name)
          Sets the mail folder name of the trash folder of this user object
 void setMailenabled(Boolean enabled)
          Currently not used
 void setManager_name(String manager_name)
          Sets the name of the manager for this user object
 void setMarital_status(String marital_status)
          Sets the marital status for this user object
 void setMiddle_name(String middle_name)
          Sets the middle name for this user object
 void setName(String username)
          Sets the symbolic user identifier
 void setNickname(String nickname)
          Sets the nickname of this user object
 void setNote(String note)
          Sets the note field for this user object
 void setNumber_of_children(String number_of_children)
          Sets the number of children for this user object
 void setNumber_of_employee(String number_of_employee)
          Sets the employee identifier for this user object
 void setPassword_expired(Boolean password_expired)
          Sets if the password for this user object is expired
 void setPassword(String passwd)
          Sets the password for this user object.
 void setPasswordMech(String passwordMech)
          Represents the password encryption mechanism, value is a password mechanism.
 void setPosition(String position)
          Sets the position field for this user object
 void setPostal_code_business(String postal_code_business)
          Sets the postal_code_business for this user object
 void setPostal_code_home(String postal_code_home)
          Sets the postal code of the home location for this user object
 void setPostal_code_other(String postal_code_other)
          Sets the postal code for a further location for this user object
 void setPrimaryEmail(String primaryEmail)
          Sets the primary mail address of this user object.
 void setProfession(String profession)
          Sets the profession for this user object
 void setRoom_number(String room_number)
          Sets the room number for this user object
 void setSales_volume(String sales_volume)
          Sets the sales volume for this user object
 void setSmtpServer(String smtpServer)
          Set the users smtp server if not localhost should be used.
 void setSpouse_name(String spouse_name)
          Sets the name of the spouse for this user object
 void setState_business(String state_business)
          Sets the state of the business for this user object
 void setState_home(String state_home)
          Sets the state of the home location for this user object
 void setState_other(String state_other)
          Sets the state for a further location for this user object
 void setStreet_business(String street_business)
          Sets the street of the business for this user object
 void setStreet_home(String street_home)
          Sets the street of the home location for this user object
 void setStreet_other(String street_other)
          Sets the street for a further location for this user object
 void setSuffix(String suffix)
          Sets the suffix for this user object
 void setSur_name(String sur_name)
          Sets the last name of user object
 void setTax_id(String tax_id)
          Sets the tax id for this user object
 void setTelephone_assistant(String telephone_assistant)
          Sets the telephone number of the assistant for this user object
 void setTelephone_business1(String telephone_business1)
          Sets the telephone number of the business location for this user object
 void setTelephone_business2(String telephone_business2)
          Sets the second telephone number of the business location for this user object
 void setTelephone_callback(String telephone_callback)
          Sets the telephone_callback for this user object
 void setTelephone_car(String telephone_car)
          Sets the telephone number for the car phone for this user object
 void setTelephone_company(String telephone_company)
          Sets the telephone number of the company for this user object
 void setTelephone_home1(String telephone_home1)
          Sets the first telephone number of the home location for this user object
 void setTelephone_home2(String telephone_home2)
          Sets the second telephone number of the home location for this user object
 void setTelephone_ip(String telephone_ip)
          Sets the telephone number for ip telephony for this user object
 void setTelephone_isdn(String telephone_isdn)
          Sets the telephone number for isdn telephony for this user object
 void setTelephone_other(String telephone_other)
          Sets the further telephone number for this user object
 void setTelephone_pager(String telephone_pager)
          Sets the number of the telephone pager of this user object
 void setTelephone_primary(String telephone_primary)
          Currently not used
 void setTelephone_radio(String telephone_radio)
          Currently not used
 void setTelephone_telex(String telephone_telex)
          Sets the telephone number for the telex for this user object
 void setTelephone_ttytdd(String telephone_ttytdd)
          Sets the telephone number for the TTY/TDD for this user object
 void setTimezone(String timezone)
          Sets the timezone for this user object.
 void setTitle(String title)
          Sets the title for this user object
 void setUploadFileSizeLimit(Integer upload_quota)
          Sets the upload file size limit for this user object
 void setUploadFileSizeLimitPerFile(Integer upload_quota_per_file)
          Sets the upload file size limit per file for this user object
 void setUrl(String url)
          Sets the URL for this user object
 void setUserAttribute(String namespace, String name, String value)
          Sets a generic user attribute
 void setUserAttributes(Map<String,Map<String,String>> userAttributes)
           
 void setUserfield01(String userfield01)
          Sets the dynamic field no 1 for this user object
 void setUserfield02(String userfield02)
          Sets the dynamic field no 2 for this user object
 void setUserfield03(String userfield03)
          Sets the dynamic field no 3 for this user object
 void setUserfield04(String userfield04)
          Sets the dynamic field no 4 for this user object
 void setUserfield05(String userfield05)
          Sets the dynamic field no 5 for this user object
 void setUserfield06(String userfield06)
          Sets the dynamic field no 6 for this user object
 void setUserfield07(String userfield07)
          Sets the dynamic field no 7 for this user object
 void setUserfield08(String userfield08)
          Sets the dynamic field no 8 for this user object
 void setUserfield09(String userfield09)
          Sets the dynamic field no 9 for this user object
 void setUserfield10(String userfield10)
          Sets the dynamic field no 10 for this user object
 void setUserfield11(String userfield11)
          Sets the dynamic field no 11 for this user object
 void setUserfield12(String userfield12)
          Sets the dynamic field no 12 for this user object
 void setUserfield13(String userfield13)
          Sets the dynamic field no 13 for this user object
 void setUserfield14(String userfield14)
          Sets the dynamic field no 14 for this user object
 void setUserfield15(String userfield15)
          Sets the dynamic field no 15 for this user object
 void setUserfield16(String userfield16)
          Sets the dynamic field no 16 for this user object
 void setUserfield17(String userfield17)
          Sets the dynamic field no 17 for this user object
 void setUserfield18(String userfield18)
          Sets the dynamic field no 18 for this user object
 void setUserfield19(String userfield19)
          Sets the dynamic field no 19 for this user object
 void setUserfield20(String userfield20)
          Sets the dynamic field no 20 for this user object
 Hashtable<String,Object> toHashtable()
          A wrapper function to get fields of this user object as key/value pairs in a Hashtable
 String toString()
          
 
Methods inherited from class com.openexchange.admin.rmi.dataobjects.ExtendableDataObject
addExtension, getAllExtensionsAsHash, getFirstExtensionByName, isExtensionsok, isExtensionsset, removeExtension, setExtensionsok
 
Methods inherited from class com.openexchange.admin.rmi.dataobjects.EnforceableDataObject
getUnsetMembers, mandatoryChangeMembersSet, mandatoryCreateMembersSet, mandatoryDeleteMembersSet, mandatoryRegisterMembersSet, testMandatoryCreateFieldsNull
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

User

public User()
Instantiates a new empty user object


User

public User(int id)
Instantiates a new user object with the given id set

Parameters:
id - An int value
Method Detail

getId

public final Integer getId()
Returns the id of the user

Specified by:
getId in interface NameAndIdObject
Returns:
Returns the id of the user as a long.

isAliasesset

public final boolean isAliasesset()
Used to check if the aliases field of this user object has been changed

Returns:
true if set; false if not

isAnniversaryset

public final boolean isAnniversaryset()
Used to check if the anniversary field of this user object has been changed

Returns:
true if set; false if not

isAssistant_nameset

public final boolean isAssistant_nameset()
Used to check if the assistant_name field of this user object has been changed

Returns:
true if set; false if not

isBirthdayset

public final boolean isBirthdayset()
Used to check if the birthday field of this user object has been changed

Returns:
true if set; false if not

isBranchesset

public final boolean isBranchesset()
Used to check if the branches field of this user object has been changed

Returns:
true if set; false if not

isBusiness_categoryset

public final boolean isBusiness_categoryset()
Used to check if the business_category field of this user object has been changed

Returns:
true if set; false if not

isCategoriesset

public final boolean isCategoriesset()
Used to check if the categories field of this user user has been changed

Returns:
true if set; false if not

isCellular_telephone1set

public final boolean isCellular_telephone1set()
Used to check if the cellular_telephone1 field of this user object has been changed

Returns:
true if set; false if not

isCellular_telephone2set

public final boolean isCellular_telephone2set()
Used to check if the cellular_telephone2 field of this user object has been changed

Returns:
true if set; false if not

isCity_businessset

public final boolean isCity_businessset()
Used to check if the city_business field of this user object has been changed

Returns:
true if set; false if not

isCity_homeset

public final boolean isCity_homeset()
Used to check if the city_home field of this user object has been changed

Returns:
true if set; false if not

isCity_otherset

public final boolean isCity_otherset()
Used to check if the city_other field of this user object has been changed

Returns:
true if set; false if not

isCommercial_registerset

public final boolean isCommercial_registerset()
Used to check if the commercial_register field of this user object has been changed

Returns:
true if set; false if not

isCompanyset

public final boolean isCompanyset()
Used to check if the company field of this user object has been changed

Returns:
true if set; false if not

isCountry_businessset

public final boolean isCountry_businessset()
Used to check if the country_business field of this user object has been changed

Returns:
true if set; false if not

isCountry_homeset

public final boolean isCountry_homeset()
Used to check if the country_home field of this user object has been changed

Returns:
true if set; false if not

isCountry_otherset

public final boolean isCountry_otherset()
Used to check if the country_other field of this user object has been changed

Returns:
true if set; false if not

isDefault_groupset

public final boolean isDefault_groupset()
Used to check if the default_group field of this user object has been changed

Returns:
true if set; false if not

isDepartmentset

public final boolean isDepartmentset()
Used to check if the department field of this user object has been changed

Returns:
true if set; false if not

isDisplay_nameset

public final boolean isDisplay_nameset()
Used to check if the display_name field of this user object has been changed

Returns:
true if set; false if not

isEmail1set

public final boolean isEmail1set()
Used to check if the email1 field of this user object has been changed

Returns:
true if set; false if not

isEmail2set

public final boolean isEmail2set()
Used to check if the email2 field of this user object has been changed

Returns:
true if set; false if not

isEmail3set

public final boolean isEmail3set()
Used to check if the email3 field of this user object has been changed

Returns:
true if set; false if not

isEmployeeTypeset

public final boolean isEmployeeTypeset()
Used to check if the employeetype field of this user object has been changed

Returns:
true if set; false if not

getMailenabled

public final Boolean getMailenabled()
Currently not used

Returns:
true if set; false if not

isMailenabledset

public final boolean isMailenabledset()
Currently not used

Returns:
true if set; false if not

isFax_businessset

public final boolean isFax_businessset()
Used to check if the fax_business field of this user object has been changed

Returns:
true if set; false if not

isFax_homeset

public final boolean isFax_homeset()
Used to check if the fax_home field of this user object has been changed

Returns:
true if set; false if not

isFax_otherset

public final boolean isFax_otherset()
Used to check if the fax_other field of this user object has been changed

Returns:
true if set; false if not

isGiven_nameset

public final boolean isGiven_nameset()
Used to check if the given_name field of this user object has been changed

Returns:
true if set; false if not

isIdset

public final boolean isIdset()
Used to check if the id field of this user object has been changed

Returns:
true if set; false if not

isImapServerset

public final boolean isImapServerset()
Used to check if the imapserver field of this user object has been changed

Returns:
true if set; false if not

isImapLoginset

public final boolean isImapLoginset()
Used to check if the imaplogin field of this user object has been changed

Returns:
true if set; false if not

isInfoset

public final boolean isInfoset()
Used to check if the info field of this user object has been changed

Returns:
true if set; false if not

isInstant_messenger1set

public final boolean isInstant_messenger1set()
Used to check if the instant_messenger1 field of this user object has been changed

Returns:
true if set; false if not

isInstant_messenger2set

public final boolean isInstant_messenger2set()
Used to check if the instant_messenger2 field of this user object has been changed

Returns:
true if set; false if not

isLanguageset

public final boolean isLanguageset()
Used to check if the language field of this user object has been changed

Returns:
true if set; false if not

isMail_folder_drafts_nameset

public final boolean isMail_folder_drafts_nameset()
Used to check if the mail_folder_drafts_name field of this user object has been changed

Returns:
true if set; false if not

isMail_folder_sent_nameset

public final boolean isMail_folder_sent_nameset()
Used to check if the mail_folder_sent_name field of this user object has been changed

Returns:
true if set; false if not

isMail_folder_spam_nameset

public final boolean isMail_folder_spam_nameset()
Used to check if the mail_folder_spam_name field of this user object has been changed

Returns:
true if set; false if not

isMail_folder_trash_nameset

public final boolean isMail_folder_trash_nameset()
Used to check if the mail_folder_trash_name field of this user object has been changed

Returns:
true if set; false if not

isManager_nameset

public final boolean isManager_nameset()
Used to check if the manager_name field of this user object has been changed

Returns:
true if set; false if not

isMarital_statusset

public final boolean isMarital_statusset()
Used to check if the marital_status field of this user object has been changed

Returns:
true if set; false if not

isMiddle_nameset

public final boolean isMiddle_nameset()
Used to check if the middle_name field of this user object has been changed

Returns:
true if set; false if not

isNicknameset

public final boolean isNicknameset()
Used to check if the nickname field of this user object has been changed

Returns:
true if set; false if not

isNoteset

public final boolean isNoteset()
Used to check if the note field of this user object has been changed

Returns:
true if set; false if not

isNumber_of_childrenset

public final boolean isNumber_of_childrenset()
Used to check if the number_of_children field of this user object has been changed

Returns:
true if set; false if not

isNumber_of_employeeset

public final boolean isNumber_of_employeeset()
Used to check if the number_of_employee field of this user object has been changed

Returns:
true if set; false if not

isPassword_expiredset

public final boolean isPassword_expiredset()
Used to check if the password_expired field of this user object has been changed

Returns:
true if set; false if not

isPasswordMechset

public final boolean isPasswordMechset()
Used to check if the passwordmech field of this user object has been changed

Returns:
true if set; false if not

isPasswordset

public final boolean isPasswordset()
Used to check if the password field of this user object has been changed

Returns:
true if set; false if not

isPositionset

public final boolean isPositionset()
Used to check if the position field of this user object has been changed

Returns:
true if set; false if not

isPostal_code_businessset

public final boolean isPostal_code_businessset()
Used to check if the postal_code_business field of this user object has been changed

Returns:
true if set; false if not

isPostal_code_homeset

public final boolean isPostal_code_homeset()
Used to check if the postal_code_home field of this user object has been changed

Returns:
true if set; false if not

isPostal_code_otherset

public final boolean isPostal_code_otherset()
Used to check if the postal_code_other field of this user object has been changed

Returns:
true if set; false if not

isPrimaryEmailset

public final boolean isPrimaryEmailset()
Used to check if the primaryemail field of this user object has been changed

Returns:
true if set; false if not

isProfessionset

public final boolean isProfessionset()
Used to check if the profession field of this user object has been changed

Returns:
true if set; false if not

isRoom_numberset

public final boolean isRoom_numberset()
Used to check if the room_number field of this user object has been changed

Returns:
true if set; false if not

isSales_volumeset

public final boolean isSales_volumeset()
Used to check if the sales_volume field of this user object has been changed

Returns:
true if set; false if not

isSmtpServerset

public final boolean isSmtpServerset()
Used to check if the smtpserver field of this user object has been changed

Returns:
true if set; false if not

isSpouse_nameset

public final boolean isSpouse_nameset()
Used to check if the spouse_name field of this user object has been changed

Returns:
true if set; false if not

isState_businessset

public final boolean isState_businessset()
Used to check if the state_business field of this user object has been changed

Returns:
true if set; false if not

isState_homeset

public final boolean isState_homeset()
Used to check if the state_home field of this user object has been changed

Returns:
true if set; false if not

isState_otherset

public final boolean isState_otherset()
Used to check if the state_other field of this user object has been changed

Returns:
true if set; false if not

isStreet_businessset

public final boolean isStreet_businessset()
Used to check if the street_business field of this user object has been changed

Returns:
true if set; false if not

isStreet_homeset

public final boolean isStreet_homeset()
Used to check if the street_home field of this user object has been changed

Returns:
true if set; false if not

isStreet_otherset

public final boolean isStreet_otherset()
Used to check if the street_other field of this user object has been changed

Returns:
true if set; false if not

isSuffixset

public final boolean isSuffixset()
Used to check if the suffix field of this user object has been changed

Returns:
true if set; false if not

isSur_nameset

public final boolean isSur_nameset()
Used to check if the sur_name field of this user object has been changed

Returns:
true if set; false if not

isTax_idset

public final boolean isTax_idset()
Used to check if the tax_id field of this user object has been changed

Returns:
true if set; false if not

isTelephone_assistantset

public final boolean isTelephone_assistantset()
Used to check if the telephone_assistant field of this user object has been changed

Returns:
true if set; false if not

isTelephone_business1set

public final boolean isTelephone_business1set()
Used to check if the telephone_business1 field of this user object has been changed

Returns:
true if set; false if not

isTelephone_business2set

public final boolean isTelephone_business2set()
Used to check if the telephone_business2 field of this user object has been changed

Returns:
true if set; false if not

isTelephone_callbackset

public final boolean isTelephone_callbackset()
Used to check if the telephone_callback field of this user object has been changed

Returns:
true if set; false if not

isTelephone_carset

public final boolean isTelephone_carset()
Used to check if the telephone_car field of this user object has been changed

Returns:
true if set; false if not

isTelephone_companyset

public final boolean isTelephone_companyset()
Used to check if the telephone_company field of this user object has been changed

Returns:
true if set; false if not

isTelephone_home1set

public final boolean isTelephone_home1set()
Used to check if the telephone_home1 field of this user object has been changed

Returns:
true if set; false if not

isTelephone_home2set

public final boolean isTelephone_home2set()
Used to check if the telephone_home2 field of this user object has been changed

Returns:
true if set; false if not

isTelephone_ipset

public final boolean isTelephone_ipset()
Used to check if the telephone_ip field of this user object has been changed

Returns:
true if set; false if not

isTelephone_isdnset

public final boolean isTelephone_isdnset()
Used to check if the telephone_isdn field of this user object has been changed

Returns:
true if set; false if not

isTelephone_otherset

public final boolean isTelephone_otherset()
Used to check if the telephone_other field of this user object has been changed

Returns:
true if set; false if not

isTelephone_pagerset

public final boolean isTelephone_pagerset()
Used to check if the telephone_pager field of this user object has been changed

Returns:
true if set; false if not

isTelephone_primaryset

public final boolean isTelephone_primaryset()
Used to check if the telephone_primary field of this user object has been changed

Returns:
true if set; false if not

isTelephone_radioset

public final boolean isTelephone_radioset()
Used to check if the telephone_radio field of this user object has been changed

Returns:
true if set; false if not

isTelephone_telexset

public final boolean isTelephone_telexset()
Used to check if the telephone_telex field of this user object has been changed

Returns:
true if set; false if not

isTelephone_ttytddset

public final boolean isTelephone_ttytddset()
Used to check if the telephone_ttytdd field of this user object has been changed

Returns:
true if set; false if not

isTimezoneset

public final boolean isTimezoneset()
Used to check if the timezone field of this user object has been changed

Returns:
true if set; false if not

isTitleset

public final boolean isTitleset()
Used to check if the title field of this user object has been changed

Returns:
true if set; false if not

isUploadFileSizeLimitset

public boolean isUploadFileSizeLimitset()
Used to check if the upload quota of this user object has been changed

Returns:
true if set; false if not

isUploadFileSizeLimitPerFileset

public boolean isUploadFileSizeLimitPerFileset()
Used to check if the upload file size limit per file of this user object has been changed

Returns:
true if set; false if not

isUrlset

public final boolean isUrlset()
Used to check if the url field of this user object has been changed

Returns:
true if set; false if not

isUserfield01set

public final boolean isUserfield01set()
Used to check if the userfield01 field of this user object has been changed

Returns:
true if set; false if not

isUserfield02set

public final boolean isUserfield02set()
Used to check if the userfield02 field of this user object has been changed

Returns:
true if set; false if not

isUserfield03set

public final boolean isUserfield03set()
Used to check if the userfield03 field of this user object has been changed

Returns:
true if set; false if not

isUserfield04set

public final boolean isUserfield04set()
Used to check if the userfield04 field of this user object has been changed

Returns:
true if set; false if not

isUserfield05set

public final boolean isUserfield05set()
Used to check if the userfield05 field of this user object has been changed

Returns:
true if set; false if not

isUserfield06set

public final boolean isUserfield06set()
Used to check if the userfield06 field of this user object has been changed

Returns:
true if set; false if not

isUserfield07set

public final boolean isUserfield07set()
Used to check if the userfield07 field of this user object has been changed

Returns:
true if set; false if not

isUserfield08set

public final boolean isUserfield08set()
Used to check if the userfield08 field of this user object has been changed

Returns:
true if set; false if not

isUserfield09set

public final boolean isUserfield09set()
Used to check if the userfield09 field of this user object has been changed

Returns:
true if set; false if not

isUserfield10set

public final boolean isUserfield10set()
Used to check if the userfield10 field of this user object has been changed

Returns:
true if set; false if not

isUserfield11set

public final boolean isUserfield11set()
Used to check if the userfield11 field of this user object has been changed

Returns:
true if set; false if not

isUserfield12set

public final boolean isUserfield12set()
Used to check if the userfield12 field of this user object has been changed

Returns:
true if set; false if not

isUserfield13set

public final boolean isUserfield13set()
Used to check if the userfield13 field of this user object has been changed

Returns:
true if set; false if not

isUserfield14set

public final boolean isUserfield14set()
Used to check if the userfield14 field of this user object has been changed

Returns:
true if set; false if not

isUserfield15set

public final boolean isUserfield15set()
Used to check if the userfield15 field of this user object has been changed

Returns:
true if set; false if not

isUserfield16set

public final boolean isUserfield16set()
Used to check if the userfield16 field of this user object has been changed

Returns:
true if set; false if not

isUserfield17set

public final boolean isUserfield17set()
Used to check if the userfield17 field of this user object has been changed

Returns:
true if set; false if not

isUserfield18set

public final boolean isUserfield18set()
Used to check if the userfield18 field of this user object has been changed

Returns:
true if set; false if not

isUserfield19set

public final boolean isUserfield19set()
Used to check if the userfield19 field of this user object has been changed

Returns:
true if set; false if not

isUserfield20set

public final boolean isUserfield20set()
Used to check if the userfield20 field of this user object has been changed

Returns:
true if set; false if not

isNameset

public final boolean isNameset()
Used to check if the name field of this user object has been changed

Returns:
true if set; false if not

setId

public final void setId(Integer userid)
Sets the numeric user id

Specified by:
setId in interface NameAndIdObject
Parameters:
userid - An Integer containing the user id

getName

public final String getName()
Description copied from interface: NameAndIdObject
Returns the name of this object

Specified by:
getName in interface NameAndIdObject
Returns:
A String containing the name

setName

public final void setName(String username)
Sets the symbolic user identifier

Specified by:
setName in interface NameAndIdObject
Parameters:
username - A String containing the user name

getPassword

public final String getPassword()
Description copied from interface: PasswordMechObject
Return the password of this user object.

Specified by:
getPassword in interface PasswordMechObject
Returns:
A String containing the password

setPassword

public final void setPassword(String passwd)
Sets the password for this user object. The users password must be plaintext

Parameters:
passwd - A String containing the password
See Also:
setPasswordMech

getPrimaryEmail

public final String getPrimaryEmail()
Returns the primary E-Mail address of this user object

Returns:
A String containing the primary E-Mail address

setPrimaryEmail

public final void setPrimaryEmail(String primaryEmail)
Sets the primary mail address of this user object. Primary mail address is the default email address of the user

Parameters:
primaryEmail - A String containing the primary E-Mail address

getSur_name

public final String getSur_name()
Return the last name of this user object

Returns:
A String containing the last name

setSur_name

public final void setSur_name(String sur_name)
Sets the last name of user object

Parameters:
sur_name - A String containing the last name

getGiven_name

public final String getGiven_name()
Returns the the first name of user

Returns:
A String containing the first name

setGiven_name

public final void setGiven_name(String given_name)
Sets the first name of user

Parameters:
given_name - A String containing the first name

setMailenabled

public final void setMailenabled(Boolean enabled)
Currently not used

Parameters:
enabled - A Boolean to activate/deactivate

getBirthday

public final Date getBirthday()
Returns the birthday of this user object

Returns:
A Date containing the birthday

setBirthday

public final void setBirthday(Date birthday)
Sets the birthday for this user object

Parameters:
birthday - A Date containing the birthday

getAnniversary

public final Date getAnniversary()
Returns the anniversary of this user object

Returns:
A Date containing the anniversary

setAnniversary

public final void setAnniversary(Date anniversary)
Sets the anniversary for this user object

Parameters:
anniversary - A Date containing the anniversary

getBranches

public final String getBranches()
Returns the branches of this user object

Returns:
A String containing the branches

setBranches

public final void setBranches(String branches)
Sets the branches for this user object

Parameters:
branches - A String containing the branches

getBusiness_category

public final String getBusiness_category()
Returns the business_category of this user object

Returns:
A String containing the business_category

setBusiness_category

public final void setBusiness_category(String business_category)
Sets the business_category for this user object

Parameters:
business_category - A String containing the business_category

getPostal_code_business

public final String getPostal_code_business()
Returns the postal_code_otherset of this user object

Returns:
A String containing the postal_code_otherset

setPostal_code_business

public final void setPostal_code_business(String postal_code_business)
Sets the postal_code_business for this user object

Parameters:
postal_code_business - A String containing the postal_code_otherset

getState_business

public final String getState_business()
Returns the state of the business of this user object

Returns:
A String containing the state of the business

setState_business

public final void setState_business(String state_business)
Sets the state of the business for this user object

Parameters:
state_business - A String containing the state of the business

getStreet_business

public final String getStreet_business()
Returns the street of the business of this user object

Returns:
A String containing the street of the business

setStreet_business

public final void setStreet_business(String street_business)
Sets the street of the business for this user object

Parameters:
street_business - A String containing the street of the business

getTelephone_callback

public final String getTelephone_callback()
Returns the telephone_callback of this user object

Returns:
A String containing the telephone_callback

setTelephone_callback

public final void setTelephone_callback(String telephone_callback)
Sets the telephone_callback for this user object

Parameters:
telephone_callback - A String containing the telephone_callback

getCity_home

public final String getCity_home()
Returns the city for the home location of this user object

Returns:
A String containing the city for the home location

setCity_home

public final void setCity_home(String city_home)
Sets the city for the home location for this user object

Parameters:
city_home - A String containing the city for the home location

getCommercial_register

public final String getCommercial_register()
Returns the commercial_register of this user object

Returns:
A String containing commercial_register

setCommercial_register

public final void setCommercial_register(String commercial_register)
Sets the commercial_register for this user object

Parameters:
commercial_register - A String containing commercial_register

getCountry_home

public final String getCountry_home()
Returns the country of the home location of this user object

Returns:
A String containing the country of the home location

setCountry_home

public final void setCountry_home(String country_home)
Sets the country of the home location for this user object

Parameters:
country_home - A String containing the country of the home location

getCompany

public final String getCompany()
Returns the company of this user object

Returns:
A String containing the company

setCompany

public final void setCompany(String company)
Sets the company for this user object

Parameters:
company - A String containing the company

getDefault_group

public final Group getDefault_group()
Returns the default group of this user object

Returns:
A Group object containing the default group

setDefault_group

public final void setDefault_group(Group default_group)
The default group when creating an user. If not supplied, a default group is used.

Parameters:
default_group - A Group object containing the default group

getDepartment

public final String getDepartment()
Returns the department of this user object

Returns:
A String containing the department

setDepartment

public final void setDepartment(String department)
Sets the department for this user object

Parameters:
department - A String containing the department

getDisplay_name

public final String getDisplay_name()
Returns the display name of this user object

Returns:
A String containing the display name

setDisplay_name

public final void setDisplay_name(String display_name)
Sets the display name for this user object

Parameters:
display_name - A String containing the display name

getEmail2

public final String getEmail2()
Returns the home E-Mail of this user object

Returns:
A String containing the home E-Mail

setEmail2

public final void setEmail2(String email2)
Sets the home E-Mail for this user object

Parameters:
email2 - A String containing the home E-Mail

getEmail3

public final String getEmail3()
Returns the E-Mail (other) of this user object

Returns:
A String containing the E-Mail (other)

setEmail3

public final void setEmail3(String email3)
Sets the E-Mail (other) for this user object

Parameters:
email3 - A String containing the E-Mail (other)

getEmployeeType

public final String getEmployeeType()
Returns the job title of this user object

Returns:
A String containing the job title

setEmployeeType

public final void setEmployeeType(String employeeType)
Sets the job title for this user object

Parameters:
employeeType - A String containing the job title

getFax_business

public final String getFax_business()
Returns the fax number for the business location of this user object

Returns:
A String containing the fax number for the business location

setFax_business

public final void setFax_business(String fax_business)
Sets the fax number for the business location for this user object

Parameters:
fax_business - A String containing the fax number for the business location

getFax_home

public final String getFax_home()
Returns the fax number for the home location of this user object

Returns:
A String containing the fax number for the home location

setFax_home

public final void setFax_home(String fax_home)
Sets the fax number for the home location for this user object

Parameters:
fax_home - A String containing the fax number for the home location

getFax_other

public final String getFax_other()
Returns the fax number for a further location of this user object

Returns:
A String containing the fax number for a further location

setFax_other

public final void setFax_other(String fax_other)
Sets the fax number for a further location for this user object

Parameters:
fax_other - A String containing the fax number for a further location

getImapPort

@Deprecated
public final int getImapPort()
Deprecated. since 6.20. Use getImapServerString() instead.

Returns the port of the imap server of this user object

Returns:
An int containing the port number

getImapServer

@Deprecated
public final String getImapServer()
Deprecated. since 6.20. Use getImapServerString() instead.

Returns the hostname for the imap server of this user object

Returns:
A String containing the hostname for the imap server

getImapServerString

public final String getImapServerString()
Returns the URL of the IMAP server of this user object. This method will once be replaced by the getImapServer() method to get a Bean style conform API.

Returns:
A String containing the URL for the IMAP server.

getImapSchema

@Deprecated
public final String getImapSchema()
Deprecated. since 6.20. Use getImapServerString() instead.

Returns the schema part of the imap server url of this user object

Returns:
A String containing the schema of the imap server url

setImapServer

public final void setImapServer(String imapServer)
Sets the users imap server if not localhost should be used. Syntax of imap server String: HOSTNAME[:PORT] if PORT is omitted, the default port is used Note: to get used imap server and port, the methods getImapPort and getImapServer are used

Parameters:
imapServer - A String containing the imap server

setImapLogin

public final void setImapLogin(String imapLogin)
Sets the login for the imap server for this user object

Parameters:
imapLogin - A String containing the login

getImapLogin

public final String getImapLogin()
Returns the login for the imap server of this user object

Returns:
A String containing the login

getSmtpServer

@Deprecated
public final String getSmtpServer()
Deprecated. since 6.20. Use getSmtpServerString() instead.

Returns the hostname for the smtp server of this user object

Returns:
A String containing the hostname for the smtp server

getSmtpSchema

@Deprecated
public final String getSmtpSchema()
Deprecated. since 6.20. Use getSmtpServerString() instead.

Returns the schema part of the smtp server url of this user object

Returns:
A String containing the schema of the smtp server url

getSmtpServerString

public final String getSmtpServerString()
Returns the URL of the SMTP server of this user object. This method will once be replaced by the getImapServer() method to get a Bean style conform API.

Returns:
A String containing the URL for the SMTP server.

setSmtpServer

public final void setSmtpServer(String smtpServer)
Set the users smtp server if not localhost should be used. Syntax of smtp server String: HOSTNAME[:PORT] if PORT is omitted, the default port is used Note: to get used smtp server and port, the methods getSmtpPort and getSmtpServer are used

Parameters:
smtpServer - A String containting the smtp server

getSmtpPort

@Deprecated
public final int getSmtpPort()
Deprecated. since 6.20. Use getSmtpServerString() instead.

Returns the port for the smtp server of this user object

Returns:
An int containing the port for the smtp server

getInstant_messenger1

public final String getInstant_messenger1()
Returns the instant messenger address for the business location of this user object

Returns:
A String containing the instant messenger address

setInstant_messenger1

public final void setInstant_messenger1(String instant_messenger1)
Sets the instant messenger address for the business location for this user object

Parameters:
instant_messenger1 - A String containing the instant messenger address

getInstant_messenger2

public final String getInstant_messenger2()
Returns the instant messenger address for the private location of this user object

Returns:
A String containing the instant messenger address for the private location

setInstant_messenger2

public final void setInstant_messenger2(String instant_messenger2)
Sets the instant messenger address for the private location for this user object

Parameters:
instant_messenger2 - A String containing the instant messenger address for the private location

getTelephone_ip

public final String getTelephone_ip()
Returns the telephone number for ip telephony of this user object

Returns:
A String containing the telephone number for ip telephony

setTelephone_ip

public final void setTelephone_ip(String telephone_ip)
Sets the telephone number for ip telephony for this user object

Parameters:
telephone_ip - A String containing the telephone number for ip telephony

getTelephone_isdn

public final String getTelephone_isdn()
Returns the telephone number for isdn telephony of this user object

Returns:
A String containing the telephone number for isdn telephony

setTelephone_isdn

public final void setTelephone_isdn(String telephone_isdn)
Sets the telephone number for isdn telephony for this user object

Parameters:
telephone_isdn - A String containing the telephone number for isdn telephony

getLanguage

public final String getLanguage()
Returns the language setting of this user object

Returns:
A String object containing the language setting

setLanguage

public final void setLanguage(String language)
Sets the language for this user object. Note: Language must be constructed like _ See http://www.loc.gov/standards/iso639-2/englangn.html for possible values of and http://www.iso.org/iso/country_codes/iso_3166_code_lists/english_country_names_and_code_elements.htm for possible values of NOTE: Of course not all variants are supported by OX

Parameters:
language - A String object containing the language setting

getMail_folder_drafts_name

public final String getMail_folder_drafts_name()
Returns the mail folder name of the drafts folder of this user object

Returns:
A String containing the mail folder name of the drafts folder

setMail_folder_drafts_name

public final void setMail_folder_drafts_name(String mail_folder_drafts_name)
Sets the mail folder name of the drafts folder for this user object

Parameters:
mail_folder_drafts_name - A String containing the mail folder name of the drafts folder

getMail_folder_sent_name

public final String getMail_folder_sent_name()
Returns the mail folder name of the sent folder of this user object

Returns:
A String containing the mail folder name of the sent folder

setMail_folder_sent_name

public final void setMail_folder_sent_name(String mail_folder_sent_name)
Sets the mail folder name of the sent folder for this user object

Parameters:
mail_folder_sent_name - A String containing the mail folder name of the sent folder

getMail_folder_spam_name

public final String getMail_folder_spam_name()
Returns the mail folder name of the spam folder of this user object

Returns:
A String containing the mail folder name of the spam folder

setMail_folder_spam_name

public final void setMail_folder_spam_name(String mail_folder_spam_name)
Sets the name of the users SPAM folder where detected SPAM mail will be moved into.

Parameters:
mail_folder_spam_name - A String containing the mail folder name of the spam folder

getMail_folder_trash_name

public final String getMail_folder_trash_name()
Returns the mail folder name of the trash folder of this user object

Returns:
A String containing the mail folder name of the trash folder

setMail_folder_trash_name

public final void setMail_folder_trash_name(String mail_folder_trash_name)
Sets the mail folder name of the trash folder of this user object

Parameters:
mail_folder_trash_name - A String containing the mail folder name of the trash folder

getManager_name

public final String getManager_name()
Returns the name of the manager of this user object

Returns:
A String containing the name of the manager

setManager_name

public final void setManager_name(String manager_name)
Sets the name of the manager for this user object

Parameters:
manager_name - A String containing the name of the manager

getMarital_status

public final String getMarital_status()
Returns the marital status of this user object

Returns:
A String containing the marital status

setMarital_status

public final void setMarital_status(String marital_status)
Sets the marital status for this user object

Parameters:
marital_status - A String containing the marital status

getCellular_telephone1

public final String getCellular_telephone1()
Returns the mobile phone number of this user object

Returns:
A String containing the mobile phone number

setCellular_telephone1

public final void setCellular_telephone1(String cellular_telephone1)
Sets the mobile phone number for this user object

Parameters:
cellular_telephone1 - A String containing the mobile phone number

getCellular_telephone2

public final String getCellular_telephone2()
Returns the second mobile phone number of this user object

Returns:
A String containing the second mobile phone number

setCellular_telephone2

public final void setCellular_telephone2(String cellular_telephone2)
Sets the second mobile phone number for this user object

Parameters:
cellular_telephone2 - A String containing the second mobile phone number

getInfo

public final String getInfo()
Returns the info field of this user object

Returns:
A String containing the info field

setInfo

public final void setInfo(String info)
Sets the info field for this user object

Parameters:
info - A String containing the info field

getNickname

public final String getNickname()
Returns the nickname of this user object

Returns:
A String containing the nickname

setNickname

public final void setNickname(String nickname)
Sets the nickname of this user object

Parameters:
nickname - A String containing the nickname

getNumber_of_children

public final String getNumber_of_children()
Returns the number of children of this user object

Returns:
A String containing the number of children

setNumber_of_children

public final void setNumber_of_children(String number_of_children)
Sets the number of children for this user object

Parameters:
number_of_children - A String containing the number of children

getNote

public final String getNote()
Returns the note field of this user object

Returns:
A String containing the note field

setNote

public final void setNote(String note)
Sets the note field for this user object

Parameters:
note - A String containing the note field

getNumber_of_employee

public final String getNumber_of_employee()
Returns the employee identifier of this user object

Returns:
A String containing the employee identifier

setNumber_of_employee

public final void setNumber_of_employee(String number_of_employee)
Sets the employee identifier for this user object

Parameters:
A - String containing the employee identifier

getTelephone_pager

public final String getTelephone_pager()
Returns the number of the telephone pager of this user object

Returns:
A String containing the number of the telephone pager

setTelephone_pager

public final void setTelephone_pager(String telephone_pager)
Sets the number of the telephone pager of this user object

Parameters:
telephone_pager - A String containing the number of the telephone pager

getPassword_expired

public final Boolean getPassword_expired()
Returns if the password of this user object is expired

Returns:
true if the password is expired; false otherwise

setPassword_expired

public final void setPassword_expired(Boolean password_expired)
Sets if the password for this user object is expired

Parameters:
password_expired - A Boolean containing the value

getTelephone_assistant

public final String getTelephone_assistant()
Returns the telephone number of the assistant of this user object

Returns:
A String containing the telephone number of the assistant

setTelephone_assistant

public final void setTelephone_assistant(String telephone_assistant)
Sets the telephone number of the assistant for this user object

Parameters:
telephone_assistant - A String containing the telephone number of the assistant

getTelephone_business1

public final String getTelephone_business1()
Returns the telephone number of the business location of this user object

Returns:
A String containing the telephone number of the business location

setTelephone_business1

public final void setTelephone_business1(String telephone_business1)
Sets the telephone number of the business location for this user object

Parameters:
telephone_business1 - A String containing the telephone number of the business location

getTelephone_business2

public final String getTelephone_business2()
Returns the second telephone number of the business location of this user object

Returns:
A String containing the second telephone number of the business location

setTelephone_business2

public final void setTelephone_business2(String telephone_business2)
Sets the second telephone number of the business location for this user object

Parameters:
telephone_business2 - A String containing the second telephone number of the business location

getTelephone_car

public final String getTelephone_car()
Returns the telephone number for the car phone of this user object

Returns:
A String containing the telephone number for the car phone

setTelephone_car

public final void setTelephone_car(String telephone_car)
Sets the telephone number for the car phone for this user object

Parameters:
telephone_car - A String containing the telephone number for the car phone

getTelephone_company

public final String getTelephone_company()
Returns the telephone number of the company of this user object

Returns:
A String containing the telephone number of the company

setTelephone_company

public final void setTelephone_company(String telephone_company)
Sets the telephone number of the company for this user object

Parameters:
telephone_company - A String containing the telephone number of the company

getTelephone_home1

public final String getTelephone_home1()
Returns the first telephone number of the home location of this user object

Returns:
A String containing the first telephone number of the home location

setTelephone_home1

public final void setTelephone_home1(String telephone_home1)
Sets the first telephone number of the home location for this user object

Parameters:
telephone_home1 - A String containing the first telephone number of the home location

getTelephone_home2

public final String getTelephone_home2()
Returns the second telephone number of the home location of this user object

Returns:
A String containing the second telephone number of the home location

setTelephone_home2

public final void setTelephone_home2(String telephone_home2)
Sets the second telephone number of the home location for this user object

Parameters:
telephone_home2 - A String containing the second telephone number of the home location

getTelephone_other

public final String getTelephone_other()
Returns a further specified telephone number of this user object

Returns:
A String containing the number

setTelephone_other

public final void setTelephone_other(String telephone_other)
Sets the further telephone number for this user object

Parameters:
telephone_other - A String containing the further telephone number

getPosition

public final String getPosition()
Returns the position field of this user object

Returns:
A String containing the position

setPosition

public final void setPosition(String position)
Sets the position field for this user object

Parameters:
position - A String containing the position field

getPostal_code_home

public final String getPostal_code_home()
Returns the postal code of the home location of this user object

Returns:
A String containing the postal code of the home location

setPostal_code_home

public final void setPostal_code_home(String postal_code_home)
Sets the postal code of the home location for this user object

Parameters:
postal_code_home - A String containing the postal code of the home location

getProfession

public final String getProfession()
Returns the profession of this user object

Returns:
A String containing the profession

setProfession

public final void setProfession(String profession)
Sets the profession for this user object

Parameters:
profession - A String containing the profession

getTelephone_radio

public final String getTelephone_radio()
Currently not used

Returns:
A String containing the field content

setTelephone_radio

public final void setTelephone_radio(String telephone_radio)
Currently not used

Parameters:
test2 - A String containing the field content

getRoom_number

public final String getRoom_number()
Returns the room number of this user object

Returns:
A String containing the room number

setRoom_number

public final void setRoom_number(String room_number)
Sets the room number for this user object

Parameters:
room_number - A String containing the room number

getSales_volume

public final String getSales_volume()
Returns the sales volume of this user object

Returns:
A String containing the sales volume

setSales_volume

public final void setSales_volume(String sales_volume)
Sets the sales volume for this user object

Parameters:
sales_volume - A String containing the sales volume

getCity_other

public final String getCity_other()
Returns the city for a further location of this user object

Returns:
A String containing the city for a further location

setCity_other

public final void setCity_other(String city_other)
Sets the city for a further location for this user object

Parameters:
city_other - A String containing the city for a further location

getCountry_other

public final String getCountry_other()
Returns the country for a further location of this user object

Returns:
A String containing the country for a further location

setCountry_other

public final void setCountry_other(String country_other)
Sets the country for a further location for this user object

Parameters:
country_other - A String containing the country for a further location

getMiddle_name

public final String getMiddle_name()
Returns the middle name of this user object

Returns:
A String containing the middle name

setMiddle_name

public final void setMiddle_name(String middle_name)
Sets the middle name for this user object

Parameters:
middle_name - A String containing the middle name

getPostal_code_other

public final String getPostal_code_other()
Returns the postal code for a further location of this user object

Returns:
A String containing the postal code for a further location

setPostal_code_other

public final void setPostal_code_other(String postal_code_other)
Sets the postal code for a further location for this user object

Parameters:
postal_code_other - A String containing the postal code for a further location

getState_other

public final String getState_other()
Returns the state for a further location of this user object

Returns:
A String containing the state for a further location

setState_other

public final void setState_other(String state_other)
Sets the state for a further location for this user object

Parameters:
state_other - A String containing the state for a further location

getStreet_other

public final String getStreet_other()
Returns the street for a further location of this user object

Returns:
A String containing the street for a further location

setStreet_other

public final void setStreet_other(String street_other)
Sets the street for a further location for this user object

Parameters:
street_other - A String containing the street for a further location

getSpouse_name

public final String getSpouse_name()
Returns the name of the spouse of this user object

Returns:
A String containing the name of the spouse

setSpouse_name

public final void setSpouse_name(String spouse_name)
Sets the name of the spouse for this user object

Parameters:
spouse_name - A String containing the name of the spouse

getState_home

public final String getState_home()
Returns the state of the home location of this user object

Returns:
A String containing the state of the home location

setState_home

public final void setState_home(String state_home)
Sets the state of the home location for this user object

Parameters:
state_home - A String containing the state of the home location

getStreet_home

public final String getStreet_home()
Returns the street of the home location of this user object

Returns:
A String containing the street of the home location

setStreet_home

public final void setStreet_home(String street_home)
Sets the street of the home location for this user object

Parameters:
street_home - A String containing the street of the home location

getSuffix

public final String getSuffix()
Returns the suffix of this user object

Returns:
A String containing the suffix

setSuffix

public final void setSuffix(String suffix)
Sets the suffix for this user object

Parameters:
suffix - A String containing the suffix

getTax_id

public final String getTax_id()
Returns the tax id of this user object

Returns:
A String containing the tax id

setTax_id

public final void setTax_id(String tax_id)
Sets the tax id for this user object

Parameters:
tax_id - A String containing the tax id

getTelephone_telex

public final String getTelephone_telex()
Returns the telephone number for the telex of this user object

Returns:
A String containing the telephone number for the telex

setTelephone_telex

public final void setTelephone_telex(String telephone_telex)
Sets the telephone number for the telex for this user object

Parameters:
telephone_telex - A String containing the telephone number for the telex

getTimezone

public final String getTimezone()
Returns the timezone of this user object

Returns:
A String containing the timezone

setTimezone

public final void setTimezone(String timezone)
Sets the timezone for this user object. See http://java.sun.com/j2se/1.5.0/docs/api/java/util/TimeZone.html for possible Timezone Strings

Parameters:
timezone - A String containing the timezone

getTitle

public final String getTitle()
Returns the title of this user object

Returns:
A String containing the title

setTitle

public final void setTitle(String title)
Sets the title for this user object

Parameters:
title - A String containing the title

getTelephone_ttytdd

public final String getTelephone_ttytdd()
Returns the telephone number for the TTY/TDD of this user object

Returns:
A String containing the telephone number for the TTY/TDD

setTelephone_ttytdd

public final void setTelephone_ttytdd(String telephone_ttytdd)
Sets the telephone number for the TTY/TDD for this user object

Parameters:
telephone_ttytdd - A String containing the telephone number for the TTY/TDD

getUploadFileSizeLimit

public final Integer getUploadFileSizeLimit()
Returns the upload file size limit of this user object

Returns:
An int containing the upload file size limit

setUploadFileSizeLimit

public final void setUploadFileSizeLimit(Integer upload_quota)
Sets the upload file size limit for this user object

Parameters:
upload_quota - An int containing the upload file size limit

getUploadFileSizeLimitPerFile

public final Integer getUploadFileSizeLimitPerFile()
Returns the upload file size limit per file of this user object

Returns:
An int containing the upload file size limit per file

setUploadFileSizeLimitPerFile

public final void setUploadFileSizeLimitPerFile(Integer upload_quota_per_file)
Sets the upload file size limit per file for this user object

Parameters:
upload_quota_per_file - An int containing the upload file size limit per file

getUrl

public final String getUrl()
Returns the URL of this user object

Returns:
A String containing the URL

setUrl

public final void setUrl(String url)
Sets the URL for this user object

Parameters:
url - A String containing the URL

getUserfield01

public final String getUserfield01()
Returns the dynamic field no 1 of this user object

Returns:
A String containing the dynamic field no 1

setUserfield01

public final void setUserfield01(String userfield01)
Sets the dynamic field no 1 for this user object

Parameters:
userfield01 - A String containing the dynamic field no 1

getUserfield02

public final String getUserfield02()
Returns the dynamic field no 2 of this user object

Returns:
A String containing the dynamic field no 2

setUserfield02

public final void setUserfield02(String userfield02)
Sets the dynamic field no 2 for this user object

Parameters:
userfield02 - A String containing the dynamic field no 2

getUserfield03

public final String getUserfield03()
Returns the dynamic field no 3 of this user object

Returns:
A String containing the dynamic field no 3

setUserfield03

public final void setUserfield03(String userfield03)
Sets the dynamic field no 3 for this user object

Parameters:
userfield03 - A String containing the dynamic field no 3

getUserfield04

public final String getUserfield04()
Returns the dynamic field no 4 of this user object

Returns:
A String containing the dynamic field no 4

setUserfield04

public final void setUserfield04(String userfield04)
Sets the dynamic field no 4 for this user object

Parameters:
userfield04 - A String containing the dynamic field no 4

getUserfield05

public final String getUserfield05()
Returns the dynamic field no 5 of this user object

Returns:
A String containing the dynamic field no 5

setUserfield05

public final void setUserfield05(String userfield05)
Sets the dynamic field no 5 for this user object

Parameters:
userfield05 - A String containing the dynamic field no 5

getUserfield06

public final String getUserfield06()
Returns the dynamic field no 6 of this user object

Returns:
A String containing the dynamic field no 6

setUserfield06

public final void setUserfield06(String userfield06)
Sets the dynamic field no 6 for this user object

Parameters:
userfield06 - A String containing the dynamic field no 6

getUserfield07

public final String getUserfield07()
Returns the dynamic field no 7 of this user object

Returns:
A String containing the dynamic field no 7

setUserfield07

public final void setUserfield07(String userfield07)
Sets the dynamic field no 7 for this user object

Parameters:
userfield07 - A String containing the dynamic field no 7

getUserfield08

public final String getUserfield08()
Returns the dynamic field no 8 of this user object

Returns:
A String containing the dynamic field no 8

setUserfield08

public final void setUserfield08(String userfield08)
Sets the dynamic field no 8 for this user object

Parameters:
userfield08 - A String containing the dynamic field no 8

getUserfield09

public final String getUserfield09()
Returns the dynamic field no 9 of this user object

Returns:
A String containing the dynamic field no 9

setUserfield09

public final void setUserfield09(String userfield09)
Sets the dynamic field no 9 for this user object

Parameters:
userfield09 - A String containing the dynamic field no 9

getUserfield10

public final String getUserfield10()
Returns the dynamic field no 10 of this user object

Returns:
A String containing the dynamic field no 10

setUserfield10

public final void setUserfield10(String userfield10)
Sets the dynamic field no 10 for this user object

Parameters:
userfield10 - A String containing the dynamic field no 10

getUserfield11

public final String getUserfield11()
Returns the dynamic field no 11 of this user object

Returns:
A String containing the dynamic field no 11

setUserfield11

public final void setUserfield11(String userfield11)
Sets the dynamic field no 11 for this user object

Parameters:
userfield11 - A String containing the dynamic field no 11

getUserfield12

public final String getUserfield12()
Returns the dynamic field no 12 of this user object

Returns:
A String containing the dynamic field no 12

setUserfield12

public final void setUserfield12(String userfield12)
Sets the dynamic field no 12 for this user object

Parameters:
userfield12 - A String containing the dynamic field no 12

getUserfield13

public final String getUserfield13()
Returns the dynamic field no 13 of this user object

Returns:
A String containing the dynamic field no 13

setUserfield13

public final void setUserfield13(String userfield13)
Sets the dynamic field no 13 for this user object

Parameters:
userfield13 - A String containing the dynamic field no 13

getUserfield14

public final String getUserfield14()
Returns the dynamic field no 14 of this user object

Returns:
A String containing the dynamic field no 14

setUserfield14

public final void setUserfield14(String userfield14)
Sets the dynamic field no 14 for this user object

Parameters:
userfield14 - A String containing the dynamic field no 14

getUserfield15

public final String getUserfield15()
Returns the dynamic field no 15 of this user object

Returns:
A String containing the dynamic field no 15

setUserfield15

public final void setUserfield15(String userfield15)
Sets the dynamic field no 15 for this user object

Parameters:
userfield15 - A String containing the dynamic field no 15

getUserfield16

public final String getUserfield16()
Returns the dynamic field no 16 of this user object

Returns:
A String containing the dynamic field no 16

setUserfield16

public final void setUserfield16(String userfield16)
Sets the dynamic field no 16 for this user object

Parameters:
userfield16 - A String containing the dynamic field no 16

getUserfield17

public final String getUserfield17()
Returns the dynamic field no 17 of this user object

Returns:
A String containing the dynamic field no 17

setUserfield17

public final void setUserfield17(String userfield17)
Sets the dynamic field no 17 for this user object

Parameters:
userfield17 - A String containing the dynamic field no 17

getUserfield18

public final String getUserfield18()
Returns the dynamic field no 18 of this user object

Returns:
A String containing the dynamic field no 18

setUserfield18

public final void setUserfield18(String userfield18)
Sets the dynamic field no 18 for this user object

Parameters:
userfield18 - A String containing the dynamic field no 18

getUserfield19

public final String getUserfield19()
Returns the dynamic field no 19 of this user object

Returns:
A String containing the dynamic field no 19

setUserfield19

public final void setUserfield19(String userfield19)
Sets the dynamic field no 19 for this user object

Parameters:
userfield19 - A String containing the dynamic field no 19

getUserfield20

public final String getUserfield20()
Returns the dynamic field no 20 of this user object

Returns:
A String containing the dynamic field no 20

setUserfield20

public final void setUserfield20(String userfield20)
Sets the dynamic field no 20 for this user object

Parameters:
userfield20 - A String containing the dynamic field no 20

setAliases

public final void setAliases(HashSet<String> aliases)
Sets the E-Mail aliases for this user object

Parameters:
aliases - A HashSet containing the E-Mail aliases

addAlias

public final void addAlias(String alias)
Adds an E-Mail alias to the current list of aliases of this user object

Parameters:
alias - A String containing the E-Mail alias to add

removeAlias

public final boolean removeAlias(String alias)
Removes the specified E-Mail alias from the list of this user object

Parameters:
alias - A String containing the E-Mail alias to be removed
Returns:
true if removing was successful; false otherwise

getAliases

public final HashSet<String> getAliases()
Returns the complete E-mail aliases of this user object

Returns:
A HashSet containing the complete E-mail aliases

setAliasesForSOAP

public final void setAliasesForSOAP(List<String> aliases)

getAliasesForSOAP

public final List<String> getAliasesForSOAP()

getCity_business

public final String getCity_business()
Returns the city for the business location of this user object

Returns:
A String containing the city for the business location

setCity_business

public final void setCity_business(String city_business)
Sets the city for the business location for this user object

Parameters:
city_business - A String containing the city for the business location

getCountry_business

public final String getCountry_business()
Returns the country for the business location of this user object

Returns:
A String containing the country for the business location

setCountry_business

public final void setCountry_business(String country_business)
Sets the country for the business location for this user object

Parameters:
country_business - A String containing the country for the business location

getAssistant_name

public final String getAssistant_name()
Returns the name of the assistant of this user object

Returns:
A String containing the name of the assistant

setAssistant_name

public final void setAssistant_name(String assistant_name)
Sets the name of the assistant for this user object

Parameters:
assistant_name - A String containing the name of the assistant

getTelephone_primary

public final String getTelephone_primary()
Currently not used

Returns:
A String containing the fields value

setTelephone_primary

public final void setTelephone_primary(String telephone_primary)
Currently not used

Parameters:
telephone_primary - A String containing the fields value

getCategories

public final String getCategories()
Returns the categories of this user object

Returns:
A String containing the categories

setCategories

public final void setCategories(String categories)
Sets the categories for this user object

Parameters:
categories - A String containing the categories

getEmail1

public final String getEmail1()

setEmail1

public final void setEmail1(String email1)
Sets the E-Mail for the business location for this user object

Parameters:
email1 - A String containing the E-Mail for the business location

hashmapToUser

public static final User hashmapToUser(HashMap<String,Object> hm)
                                throws IllegalArgumentException,
                                       IllegalAccessException,
                                       InvocationTargetException
Parameters:
ht -
Returns:
key/value pairs in Hashtable as a User Object
Throws:
IllegalArgumentException
IllegalAccessException
InvocationTargetException

toHashtable

public final Hashtable<String,Object> toHashtable()
A wrapper function to get fields of this user object as key/value pairs in a Hashtable

Returns:
The Hashtable containing the keys/values of this user object

toString

public String toString()
Description copied from class: EnforceableDataObject

Overrides:
toString in class ExtendableDataObject

clone

public Object clone()
             throws CloneNotSupportedException
Throws:
CloneNotSupportedException

addExtension

@Deprecated
public final void addExtension(OXUserExtensionInterface extension)
Deprecated. 

Parameters:
extension -

getExtensions

@Deprecated
public final ArrayList<OXUserExtensionInterface> getExtensions()
Deprecated. 

Returns:

removeExtension

@Deprecated
public final boolean removeExtension(OXUserExtensionInterface o)
Deprecated. 

Parameters:
o -
Returns:

removeExtensionByIndex

@Deprecated
public final OXUserExtensionInterface removeExtensionByIndex(int index)
Deprecated. 

Parameters:
index -
Returns:

getExtensionbyName

@Deprecated
public final ArrayList<OXUserExtensionInterface> getExtensionbyName(String extname)
Deprecated. 

This method is used to get the extensions through the name of the extension. An Array with all extensions where the name fits will be returned, or an empty array if no fitting extension was found.

Parameters:
extname - a String for the extension
Returns:
the ArrayList of OXUserExtensionInterface with extname

getFirstExtensionbyName

@Deprecated
public final OXUserExtensionInterface getFirstExtensionbyName(String extname)
Deprecated. 

A convenience method for getting the first extension in a list of equal extension names. The use of this method is not recommended because you won't get notifications how many extensions of the same name exist.

Parameters:
extname -
Returns:

getPasswordMech

public final String getPasswordMech()
Specified by:
getPasswordMech in interface PasswordMechObject
Returns:
the passwordMech

setPasswordMech

public final void setPasswordMech(String passwordMech)
Description copied from interface: PasswordMechObject
Represents the password encryption mechanism, value is a password mechanism. Currently supported mechanisms are "{CRYPT}" and "{SHA}", see User.CRYPT_MECH and User.SHA_MECH.

Specified by:
setPasswordMech in interface PasswordMechObject
Parameters:
passwordMech - the passwordMech to set

getMail_folder_confirmed_ham_name

public final String getMail_folder_confirmed_ham_name()
Returns:
the mail_folder_confirmed_ham_name

setMail_folder_confirmed_ham_name

public final void setMail_folder_confirmed_ham_name(String mail_folder_confirmed_ham_name)
Set the name of the folder where mail should be copied, that should be learned as HAM using whatever mechanism on the server side


getMail_folder_confirmed_spam_name

public final String getMail_folder_confirmed_spam_name()
Returns:
the mail_folder_confirmed_spam_name

setMail_folder_confirmed_spam_name

public final void setMail_folder_confirmed_spam_name(String mail_folder_confirmed_spam_name)
Set the name of the folder where mail should be moved, that should be learned as SPAM using whatever mechanism on the server side


isMail_folder_confirmed_spamset

public final boolean isMail_folder_confirmed_spamset()
Used to check if the mail_folder_confirmed_spam field of this user object has been changed

Returns:
true if set; false if not

isMail_folder_confirmed_hamset

public final boolean isMail_folder_confirmed_hamset()
Used to check if the mail_folder_confirmed_ham field of this user object has been changed

Returns:
true if set; false if not

isGui_spam_filter_enabledset

public final boolean isGui_spam_filter_enabledset()
Used to check if the gui_spam_filter_capabilities_enabled field of this user object has been changed

Returns:
true if set; false if not

isGUI_Spam_filter_capabilities_enabledset

@Deprecated
public final boolean isGUI_Spam_filter_capabilities_enabledset()
Deprecated. use isGui_spam_filter_enabledset() instead

Used to check if the gui_spam_filter_capabilities_enabled field of this user object has been changed

Returns:
true if set; false if not

getGui_spam_filter_enabled

public final Boolean getGui_spam_filter_enabled()
Returns:
the gui_spam_filter_enabled

getGUI_Spam_filter_capabilities_enabled

@Deprecated
public final Boolean getGUI_Spam_filter_capabilities_enabled()
Deprecated. use getGui_spam_filter_enabled() instead

Returns:
the gui_spam_filter_enabled

getSpam_filter_enabled

@Deprecated
public final Boolean getSpam_filter_enabled()
Deprecated. use getGui_spam_filter_enabled() instead

Returns:

setGui_spam_filter_enabled

public final void setGui_spam_filter_enabled(Boolean gui_spam_filter_enabled)
Parameters:
gui_spam_filter_enabled - the gui_spam_filter_enabled to set

setGUI_Spam_filter_capabilities_enabled

@Deprecated
public final void setGUI_Spam_filter_capabilities_enabled(Boolean gui_spam_filter_enabled)
Deprecated. use setGui_spam_filter_enabled(Boolean) instead

Parameters:
gui_spam_filter_enabled - the gui_spam_filter_enabled to set

isContextadmin

public final boolean isContextadmin()
Used to check if the contextadmin field of this user object has been changed

Returns:
true if set; false if not

setContextadmin

public final void setContextadmin(boolean contextadmin)
Note: calling this setter on a user object has no influence on the user stored within the ox subsystem, as it is not possible to change the admin status of a user.


getDefaultSenderAddress

public final String getDefaultSenderAddress()
Returns the default sender address of this user object

Returns:
A String containing the default sender address

setDefaultSenderAddress

public final void setDefaultSenderAddress(String defaultSenderAddress)
Sets the default sender address for this user object

Parameters:
defaultSenderAddress - A String containing the default sender address

isDefaultSenderAddressset

public final boolean isDefaultSenderAddressset()
Used to check if the contextadmin field of this user object has been changed

Returns:
true if set; false if not

getFolderTree

public Integer getFolderTree()

setFolderTree

public void setFolderTree(Integer folderTree)

isFolderTreeSet

public boolean isFolderTreeSet()

setUserAttribute

public void setUserAttribute(String namespace,
                             String name,
                             String value)
Sets a generic user attribute


getUserAttribute

public String getUserAttribute(String namespace,
                               String name)
Read a generic user attribute


getUserAttributes

public Map<String,Map<String,String>> getUserAttributes()

setUserAttributes

public void setUserAttributes(Map<String,Map<String,String>> userAttributes)

getNamespace

public Map<String,String> getNamespace(String namespace)

isUserAttributesset

public boolean isUserAttributesset()
Used to check if the user attributes have been modified


isGuiPreferencesset

public final boolean isGuiPreferencesset()
Returns:
true if set; false if not

getGuiPreferences

public final Map<String,String> getGuiPreferences()
Returns:
the guiPreferences

addGuiPreferences

public final void addGuiPreferences(String path,
                                    String guiValue)
add a path/value pair to gui settings

Parameters:
path -
guiValue -

removeGuiPreferences

public final void removeGuiPreferences(String path)
remove a path/value pair from gui settings

Parameters:
path -

setGuiPreferences

public final void setGuiPreferences(Map<String,String> guiPreferences)
Parameters:
guiPreferences - the guiPreferences to set

getMandatoryMembersCreate

public final String[] getMandatoryMembersCreate()
At the moment setName(java.lang.String), setDisplay_name(java.lang.String), setPassword(String), setGiven_name(String), setSur_name(String) and setPrimaryEmail(String) are defined here

Specified by:
getMandatoryMembersCreate in class EnforceableDataObject
Returns:
String array containing names of mandatory members or null if unwanted

getMandatoryMembersChange

public final String[] getMandatoryMembersChange()
At the moment no fields are defined here

Specified by:
getMandatoryMembersChange in class EnforceableDataObject
Returns:
String array containing names of mandatory members or null if unwanted

getMandatoryMembersDelete

public String[] getMandatoryMembersDelete()
At the moment no fields are defined here

Specified by:
getMandatoryMembersDelete in class EnforceableDataObject
Returns:
String array containing names of mandatory members or null if unwanted

getMandatoryMembersRegister

public String[] getMandatoryMembersRegister()
At the moment no fields are defined here

Specified by:
getMandatoryMembersRegister in class EnforceableDataObject
Returns:
String array containing names of mandatory members or null if unwanted

hashCode

public int hashCode()
Overrides:
hashCode in class ExtendableDataObject

equals

public boolean equals(Object obj)
Overrides:
equals in class ExtendableDataObject