java.lang.Object
com.primavera.integration.client.BOBase
com.primavera.integration.client.bo.BusinessObject
com.primavera.integration.client.bo.base.UserBase
com.primavera.integration.client.bo.object.User

public class User extends com.primavera.integration.client.bo.base.UserBase

The set of application users who are allowed to use the system. Each user is assigned a global security profile. Zero or more project security profiles can be assigned via the UserOBS business object. A utility class, SecurityHelper, has convenience methods for some of the more common tasks related to security.

Note that the Password and MailServerPassword fields are writable fields only; these fields may not be loaded from the database and are therefore not included in the AllFields array. A user may only change his own password, and only if the old password is specified. An administrator may change any user's password and does not have to specify the user's old password when doing so.

See Also:   Quick reference of User fields

  • Constructor Details

    • User

      public User(Session session)
      Class constructor specifying the Session. This constructor is most commonly used when create() is intended to be called on this object.
      Parameters:
      session - the Session
    • User

      public User(Session session, ObjectId objId) throws BusinessObjectException
      Class constructor specifying the Session and ObjectId of the object. This constructor is most commonly used when update() will be called on this object.
      Parameters:
      session - the Session
      objId - the ObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • User

      public User(Session session, com.primavera.infr.db.PrmRowSet rowSet, int iIndex) throws BusinessObjectException
      Class constructor called internally after objects are retrieved from the server. Client code should use one of the other constructors for this class.
      Parameters:
      session - the Session
      rowSet - the PrmRowSet retrieved from the server
      iIndex - the row index in the PrmRowSet associated with this business object
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
  • Method Details

    • createUserOBS

      public ObjectId createUserOBS(UserOBS userobs) throws ServerException, NetworkException, BusinessObjectException
      Creates an associated UserOBS object in the database.
      Parameters:
      userobs - UserOBS object to create
      Returns:
      ObjectId unique ID of the newly created UserOBS object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • createUserOBS

      public ObjectId[] createUserOBS(UserOBS[] userobs) throws ServerException, NetworkException, BusinessObjectException
      Creates multiple associated UserOBS objects in the database.
      Parameters:
      userobs - array of UserOBS objects to create
      Returns:
      ObjectId[] array of object ids of newly created UserOBS objects
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • loadUserOBS

      public BOIterator<UserOBS> loadUserOBS(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated UserOBS objects from the database.
      Parameters:
      fields - fields to load
      sWhereClause - where clause
      sOrderBy - order-by clause
      Returns:
      BOIterator a business object iterator used to get the results of the load request
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • updateUserOBS

      public void updateUserOBS(UserOBS[] userobs) throws ServerException, NetworkException, BusinessObjectException
      Updates multiple associated UserOBS objects in the database.
      Parameters:
      userobs - array of UserOBS objects to update
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • deleteUserOBS

      public void deleteUserOBS(UserOBS[] userobs) throws ServerException, NetworkException, BusinessObjectException
      Deletes multiple associated UserOBS objects from the database.
      Parameters:
      userobs - array of UserOBS objects to delete
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • createUserLicense

      public ObjectId createUserLicense(UserLicense userlicense) throws ServerException, NetworkException, BusinessObjectException
      Creates an associated UserLicense object in the database.
      Parameters:
      userlicense - UserLicense object to create
      Returns:
      ObjectId unique ID of the newly created UserLicense object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • createUserLicenses

      public ObjectId[] createUserLicenses(UserLicense[] userlicenses) throws ServerException, NetworkException, BusinessObjectException
      Creates multiple associated UserLicense objects in the database.
      Parameters:
      userlicenses - array of UserLicense objects to create
      Returns:
      ObjectId[] array of object ids of newly created UserLicense objects
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • loadUserLicenses

      public BOIterator<UserLicense> loadUserLicenses(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated UserLicense objects from the database.
      Parameters:
      fields - fields to load
      sWhereClause - where clause
      sOrderBy - order-by clause
      Returns:
      BOIterator a business object iterator used to get the results of the load request
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • updateUserLicenses

      public void updateUserLicenses(UserLicense[] userlicenses) throws ServerException, NetworkException, BusinessObjectException
      Updates multiple associated UserLicense objects in the database.
      Parameters:
      userlicenses - array of UserLicense objects to update
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • deleteUserLicenses

      public void deleteUserLicenses(UserLicense[] userlicenses) throws ServerException, NetworkException, BusinessObjectException
      Deletes multiple associated UserLicense objects from the database.
      Parameters:
      userlicenses - array of UserLicense objects to delete
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • loadCurrency

      public Currency loadCurrency(String[] fields) throws ServerException, NetworkException, BusinessObjectException
      Loads an associated Currency object from the database.
      Parameters:
      fields - fields to load
      Returns:
      Currency the Currency object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • loadResource

      public Resource loadResource(String[] fields) throws ServerException, NetworkException, BusinessObjectException
      Loads an associated Resource object from the database.
      Parameters:
      fields - fields to load
      Returns:
      Resource the Resource object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • loadResourceAccess

      public ResourceAccess loadResourceAccess(String[] fields) throws ServerException, NetworkException, BusinessObjectException
      Loads an associated ResourceAccess object from the database.
      Parameters:
      fields - fields to load
      Returns:
      ResourceAccess the ResourceAccess object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • loadGlobalProfile

      public GlobalProfile loadGlobalProfile(String[] fields) throws ServerException, NetworkException, BusinessObjectException
      Loads an associated GlobalProfile object from the database.
      Parameters:
      fields - fields to load
      Returns:
      GlobalProfile the GlobalProfile object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • createProjectPortfolio

      public ObjectId createProjectPortfolio(ProjectPortfolio projectportfolio) throws ServerException, NetworkException, BusinessObjectException
      Creates an associated ProjectPortfolio object in the database.
      Parameters:
      projectportfolio - ProjectPortfolio object to create
      Returns:
      ObjectId unique ID of the newly created ProjectPortfolio object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • createProjectPortfolios

      public ObjectId[] createProjectPortfolios(ProjectPortfolio[] projectportfolios) throws ServerException, NetworkException, BusinessObjectException
      Creates multiple associated ProjectPortfolio objects in the database.
      Parameters:
      projectportfolios - array of ProjectPortfolio objects to create
      Returns:
      ObjectId[] array of object ids of newly created ProjectPortfolio objects
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • loadProjectPortfolios

      public BOIterator<ProjectPortfolio> loadProjectPortfolios(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated ProjectPortfolio objects from the database.
      Parameters:
      fields - fields to load
      sWhereClause - where clause
      sOrderBy - order-by clause
      Returns:
      BOIterator a business object iterator used to get the results of the load request
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • updateProjectPortfolios

      public void updateProjectPortfolios(ProjectPortfolio[] projectportfolios) throws ServerException, NetworkException, BusinessObjectException
      Updates multiple associated ProjectPortfolio objects in the database.
      Parameters:
      projectportfolios - array of ProjectPortfolio objects to update
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • deleteProjectPortfolios

      public void deleteProjectPortfolios(ProjectPortfolio[] projectportfolios) throws ServerException, NetworkException, BusinessObjectException
      Deletes multiple associated ProjectPortfolio objects from the database.
      Parameters:
      projectportfolios - array of ProjectPortfolio objects to delete
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • createResourceTeam

      public ObjectId createResourceTeam(ResourceTeam resourceteam) throws ServerException, NetworkException, BusinessObjectException
      Creates an associated ResourceTeam object in the database.
      Parameters:
      resourceteam - ResourceTeam object to create
      Returns:
      ObjectId unique ID of the newly created ResourceTeam object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • createResourceTeams

      public ObjectId[] createResourceTeams(ResourceTeam[] resourceteams) throws ServerException, NetworkException, BusinessObjectException
      Creates multiple associated ResourceTeam objects in the database.
      Parameters:
      resourceteams - array of ResourceTeam objects to create
      Returns:
      ObjectId[] array of object ids of newly created ResourceTeam objects
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • loadResourceTeams

      public BOIterator<ResourceTeam> loadResourceTeams(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated ResourceTeam objects from the database.
      Parameters:
      fields - fields to load
      sWhereClause - where clause
      sOrderBy - order-by clause
      Returns:
      BOIterator a business object iterator used to get the results of the load request
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • updateResourceTeams

      public void updateResourceTeams(ResourceTeam[] resourceteams) throws ServerException, NetworkException, BusinessObjectException
      Updates multiple associated ResourceTeam objects in the database.
      Parameters:
      resourceteams - array of ResourceTeam objects to update
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • deleteResourceTeams

      public void deleteResourceTeams(ResourceTeam[] resourceteams) throws ServerException, NetworkException, BusinessObjectException
      Deletes multiple associated ResourceTeam objects from the database.
      Parameters:
      resourceteams - array of ResourceTeam objects to delete
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • createRoleTeam

      public ObjectId createRoleTeam(RoleTeam roleteam) throws ServerException, NetworkException, BusinessObjectException
      Creates an associated RoleTeam object in the database.
      Parameters:
      roleteam - RoleTeam object to create
      Returns:
      ObjectId unique ID of the newly created RoleTeam object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • createRoleTeams

      public ObjectId[] createRoleTeams(RoleTeam[] roleteams) throws ServerException, NetworkException, BusinessObjectException
      Creates multiple associated RoleTeam objects in the database.
      Parameters:
      roleteams - array of RoleTeam objects to create
      Returns:
      ObjectId[] array of object ids of newly created RoleTeam objects
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • loadRoleTeams

      public BOIterator<RoleTeam> loadRoleTeams(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated RoleTeam objects from the database.
      Parameters:
      fields - fields to load
      sWhereClause - where clause
      sOrderBy - order-by clause
      Returns:
      BOIterator a business object iterator used to get the results of the load request
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • updateRoleTeams

      public void updateRoleTeams(RoleTeam[] roleteams) throws ServerException, NetworkException, BusinessObjectException
      Updates multiple associated RoleTeam objects in the database.
      Parameters:
      roleteams - array of RoleTeam objects to update
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • deleteRoleTeams

      public void deleteRoleTeams(RoleTeam[] roleteams) throws ServerException, NetworkException, BusinessObjectException
      Deletes multiple associated RoleTeam objects from the database.
      Parameters:
      roleteams - array of RoleTeam objects to delete
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • loadActivityOwners

      public BOIterator<ActivityOwner> loadActivityOwners(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated ActivityOwner objects from the database.
      Parameters:
      fields - fields to load
      sWhereClause - where clause
      sOrderBy - order-by clause
      Returns:
      BOIterator a business object iterator used to get the results of the load request
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setPassword

      public void setPassword(String sOldPassword, String sNewPassword) throws BusinessObjectException
      Sets user password for the non-admin user; must specify old password.
      Parameters:
      sOldPassword - the old password. sOldPassword may be null for admin superuser
      sNewPassword - the new password
      Throws:
      BusinessObjectException - if the password change failed
    • setMailServerPassword

      public void setMailServerPassword(String sNewPassword) throws BusinessObjectException
      Sets e-mail server password.
      Parameters:
      sNewPassword - the new password for email server
      Throws:
      BusinessObjectException - if the password change failed
    • getPrimaryBaselineProject

      public ObjectId getPrimaryBaselineProject(ObjectId projectId) throws BusinessObjectException
      Gets the user's primary BaselineProject for the specified project. Note that the PrimaryBaselines field must be loaded to get the data.
      Parameters:
      projectId - the unique identifier for the Project
      Returns:
      ObjectId the unique identifier for the BaselineProject
      Throws:
      BusinessObjectException
    • setPrimaryBaselineProject

      public void setPrimaryBaselineProject(ObjectId projectId, ObjectId baselineProjectId) throws BusinessObjectException
      Sets the value of the user's primary BaselineProject for a specific project.
      Parameters:
      projectId - the unique identifier for the project
      baselineProjectId - the unique identifier for the BaselineProject
      Throws:
      BusinessObjectException - if the value cannot be set
    • getSecondaryBaselineProject

      public ObjectId getSecondaryBaselineProject(ObjectId projectId) throws BusinessObjectException
      Gets the user's secondary BaselineProject for the specified project. Note that the SecondaryBaselines field must be loaded to get the data.
      Parameters:
      projectId - the unique identifier for the Project
      Returns:
      ObjectId the unique identifier for the BaselineProject
      Throws:
      BusinessObjectException
    • setSecondaryBaselineProject

      public void setSecondaryBaselineProject(ObjectId projectId, ObjectId baselineProjectId) throws BusinessObjectException
      Sets the value of the user's secondary BaselineProject for a specific project.
      Parameters:
      projectId - the unique identifier for the project
      baselineProjectId - the unique identifier for the BaselineProject
      Throws:
      BusinessObjectException - if the value cannot be set
    • getTertiaryBaselineProject

      public ObjectId getTertiaryBaselineProject(ObjectId projectId) throws BusinessObjectException
      Gets the user's tertiary BaselineProject for the specified project. Note that the TertiaryBaselines field must be loaded to get the data.
      Parameters:
      projectId - the unique identifier for the Project
      Returns:
      ObjectId the unique identifier for the BaselineProject
      Throws:
      BusinessObjectException
    • setTertiaryBaselineProject

      public void setTertiaryBaselineProject(ObjectId projectId, ObjectId baselineProjectId) throws BusinessObjectException
      Sets the value of the user's primary baseline for a specific project.
      Parameters:
      projectId - the unique identifier for the project
      baselineProjectId - the unique identifier for the BaselineProject
      Throws:
      BusinessObjectException - if the value cannot be set
    • loadUserFilteredActivities

      public BOIterator<Activity> loadUserFilteredActivities(String[] fields, String sWhereClause, String sOrderBy) throws BusinessObjectException, ServerException, NetworkException
      Loads Non-Milestone activities matching filters set on User.
      Overrides:
      loadUserFilteredActivities in class com.primavera.integration.client.bo.base.UserBase
      Returns:
      BOIterator that contains Non-Milestone Activities
      Throws:
      BusinessObjectException - if problem occurs in processing user filters
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
    • loadUserFilteredMilestoneActivities

      public BOIterator<Activity> loadUserFilteredMilestoneActivities(String[] fields, String sWhereClause, String sOrderBy) throws BusinessObjectException, ServerException, NetworkException
      Loads Milestone activities matching filters set on User.
      Overrides:
      loadUserFilteredMilestoneActivities in class com.primavera.integration.client.bo.base.UserBase
      Returns:
      BOIterator that contains Milestone Activities
      Throws:
      BusinessObjectException - if problem occurs in processing user filters
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
    • update

      public static void update(Session session, User[] users, boolean resetUserData) throws ServerException, NetworkException, BusinessObjectException
      Updates multiple User objects in the database with the option to reset User Data.
      Parameters:
      session - the Session object
      users - array of User objects to update
      resetUserData - whether to reset user data
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getEnableUserToModifyViewSettingsFlag

      public boolean getEnableUserToModifyViewSettingsFlag() throws BusinessObjectException
      Gets the flag that when set to true allows the user to change his or her personal view settings in P6 Web Access. When a user changes the user interface view settings, the changes do not affect the settings of other users assigned to the same view.
      Returns:
      the value in the field EnableUserToModifyViewSettingsFlag
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setEnableUserToModifyViewSettingsFlag

      public void setEnableUserToModifyViewSettingsFlag(boolean b) throws BusinessObjectException
      Sets the flag that when set to true allows the user to change his or her personal view settings in P6 Web Access. When a user changes the user interface view settings, the changes do not affect the settings of other users assigned to the same view.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getObjectId

      public ObjectId getObjectId() throws BusinessObjectException
      Gets the unique ID generated by the system. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Overrides:
      getObjectId in class BusinessObject
      Returns:
      the value in the field ObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setObjectId

      public void setObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID generated by the system. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Overrides:
      setObjectId in class BusinessObject
      Parameters:
      o - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getEditGlobalUserPreferences

      public boolean getEditGlobalUserPreferences() throws BusinessObjectException
      Gets the flag that when set to true allows the user to change his or her Global Settings under My Preferences.
      Returns:
      the value in the field EditGlobalUserPreferences
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setEditGlobalUserPreferences

      public void setEditGlobalUserPreferences(boolean b) throws BusinessObjectException
      Sets the flag that when set to true allows the user to change his or her Global Settings under My Preferences.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getEmailProtocol

      public EmailType getEmailProtocol() throws BusinessObjectException
      Gets the email type for the user: 'Internet Mail' or 'MAPI Mail'.
      Returns:
      the value in the field EmailProtocol
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setEmailProtocol

      public void setEmailProtocol(EmailType enm) throws BusinessObjectException
      Sets the email type for the user: 'Internet Mail' or 'MAPI Mail'.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getName

      public String getName() throws BusinessObjectException
      Gets the user's login name. This field is automatically loaded by default whenever this type of business object is loaded from the database. This field must contain a valid value in order to create this type of business object in the database.
      Returns:
      the value in the field Name
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setName

      public void setName(String s) throws BusinessObjectException
      Sets the user's login name. This field is automatically loaded by default whenever this type of business object is loaded from the database. This field must contain a valid value in order to create this type of business object in the database.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getGlobalProfileObjectId

      public ObjectId getGlobalProfileObjectId() throws BusinessObjectException
      Gets the unique ID of the global security profile assigned to the user. See the GlobalProfile class for constants defining the fixed profiles of Admin Superuser and No Global Privileges. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Returns:
      the value in the field GlobalProfileObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setGlobalProfileObjectId

      public void setGlobalProfileObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the global security profile assigned to the user. See the GlobalProfile class for constants defining the fixed profiles of Admin Superuser and No Global Privileges. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Parameters:
      o - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getMailServerLoginName

      public String getMailServerLoginName() throws BusinessObjectException
      Gets the mail login name (profile name) for the current user to send outgoing email. If the email protocol is MAPI, this field should contain the MAPI profile name (e.g. "Microsoft Mail Settings"). This field is not required for Internet email users.
      Returns:
      the value in the field MailServerLoginName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setMailServerLoginName

      public void setMailServerLoginName(String s) throws BusinessObjectException
      Sets the mail login name (profile name) for the current user to send outgoing email. If the email protocol is MAPI, this field should contain the MAPI profile name (e.g. "Microsoft Mail Settings"). This field is not required for Internet email users.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getOfficePhone

      public String getOfficePhone() throws BusinessObjectException
      Gets the work phone number of the user.
      Returns:
      the value in the field OfficePhone
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setOfficePhone

      public void setOfficePhone(String s) throws BusinessObjectException
      Sets the work phone number of the user.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getPersonalName

      public String getPersonalName() throws BusinessObjectException
      Gets the user's personal or actual name.
      Returns:
      the value in the field PersonalName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setPersonalName

      public void setPersonalName(String s) throws BusinessObjectException
      Sets the user's personal or actual name.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getOutgoingMailServer

      public String getOutgoingMailServer() throws BusinessObjectException
      Gets the outgoing mail server (SMTP) address used to send outgoing email for this user. The address may be a host name or an IP address. This field is used only with the Internet email protocol, and is not required for MAPI. Example: "smtp.yourdomain.com".
      Returns:
      the value in the field OutgoingMailServer
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setOutgoingMailServer

      public void setOutgoingMailServer(String s) throws BusinessObjectException
      Sets the outgoing mail server (SMTP) address used to send outgoing email for this user. The address may be a host name or an IP address. This field is used only with the Internet email protocol, and is not required for MAPI. Example: "smtp.yourdomain.com".
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getEmailAddress

      public String getEmailAddress() throws BusinessObjectException
      Gets the current user's return email address. This will be used in the "FROM" line for any email sent by this user. Example: "yourname@yourdomain.com". For MAPI users, this may just be the MAPI profile name or mailbox name.
      Returns:
      the value in the field EmailAddress
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setEmailAddress

      public void setEmailAddress(String s) throws BusinessObjectException
      Sets the current user's return email address. This will be used in the "FROM" line for any email sent by this user. Example: "yourname@yourdomain.com". For MAPI users, this may just be the MAPI profile name or mailbox name.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getCurrencyObjectId

      public ObjectId getCurrencyObjectId() throws BusinessObjectException
      Gets the unique ID of the associated currency. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Returns:
      the value in the field CurrencyObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setCurrencyObjectId

      public void setCurrencyObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the associated currency. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Parameters:
      o - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getUserInterfaceViewObjectId

      public ObjectId getUserInterfaceViewObjectId() throws BusinessObjectException
      Gets the unique ID of the associated user interface view.
      Returns:
      the value in the field UserInterfaceViewObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setUserInterfaceViewObjectId

      public void setUserInterfaceViewObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the associated user interface view.
      Parameters:
      o - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getGUID

      public String getGUID() throws BusinessObjectException
      Gets the globally unique ID generated by the system.
      Returns:
      the value in the field GUID
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setGUID

      public void setGUID(String s) throws BusinessObjectException
      Sets the globally unique ID generated by the system.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getCurrencyName

      public String getCurrencyName() throws BusinessObjectException
      Gets the name of the currency associated with this user.
      Returns:
      the value in the field CurrencyName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getCurrencyId

      public String getCurrencyId() throws BusinessObjectException
      Gets the unique currency abbreviation for the currency associated with this user.
      Returns:
      the value in the field CurrencyId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getAllResourceAccessFlag

      public boolean getAllResourceAccessFlag() throws BusinessObjectException
      Gets the flag that determines whether the user has all resource access (TRUE) or restricted resource access (FALSE). Admin Superusers always have all resource access.
      Returns:
      the value in the field AllResourceAccessFlag
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setAllResourceAccessFlag

      public void setAllResourceAccessFlag(boolean b) throws BusinessObjectException
      Sets the flag that determines whether the user has all resource access (TRUE) or restricted resource access (FALSE). Admin Superusers always have all resource access.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSmallScaleUnitType

      public UnitType getSmallScaleUnitType() throws BusinessObjectException
      Gets the Small Scale Unit Type for the user is the Display Time units In: 'Hour','Day','Week','Month' or 'Year'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SmallScaleUnitType
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setSmallScaleUnitType

      public void setSmallScaleUnitType(UnitType enm) throws BusinessObjectException
      Sets the Small Scale Unit Type for the user is the Display Time units In: 'Hour','Day','Week','Month' or 'Year'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSmallScaleUseFraction

      public boolean getSmallScaleUseFraction() throws BusinessObjectException
      Gets the flag which when set to true will show sub units for the Time units format specified, and when set to false will not show sub units. Possible values : 'True' or 'False'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SmallScaleUseFraction
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setSmallScaleUseFraction

      public void setSmallScaleUseFraction(boolean b) throws BusinessObjectException
      Sets the flag which when set to true will show sub units for the Time units format specified, and when set to false will not show sub units. Possible values : 'True' or 'False'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getShowTimeUnit

      public boolean getShowTimeUnit() throws BusinessObjectException
      Gets the flag which when set to true will show units for the Time, and when set to false will not show units. Possible values : 'True' or 'False'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field ShowTimeUnit
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setShowTimeUnit

      public void setShowTimeUnit(boolean b) throws BusinessObjectException
      Sets the flag which when set to true will show units for the Time, and when set to false will not show units. Possible values : 'True' or 'False'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getSmallScaleDecimalCount

      public DecimalCount getSmallScaleDecimalCount() throws BusinessObjectException
      Gets the Small Scale Decimal count for the user is the number of decimal places to be displayed for the Time. : '0','1' or '2'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field SmallScaleDecimalCount
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setSmallScaleDecimalCount

      public void setSmallScaleDecimalCount(DecimalCount enm) throws BusinessObjectException
      Sets the Small Scale Decimal count for the user is the number of decimal places to be displayed for the Time. : '0','1' or '2'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getDurationUnitType

      public UnitType getDurationUnitType() throws BusinessObjectException
      Gets the Duration Unit Type for the user is the Display Time units In: 'Hour','Day','Week','Month' or 'Year'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field DurationUnitType
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setDurationUnitType

      public void setDurationUnitType(UnitType enm) throws BusinessObjectException
      Sets the Duration Unit Type for the user is the Display Time units In: 'Hour','Day','Week','Month' or 'Year'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getDurationUseFraction

      public boolean getDurationUseFraction() throws BusinessObjectException
      Gets the flag which when set to true will show units for the Duration, and when set to false will not show units. Possible values : 'True' or 'False'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field DurationUseFraction
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setDurationUseFraction

      public void setDurationUseFraction(boolean b) throws BusinessObjectException
      Sets the flag which when set to true will show units for the Duration, and when set to false will not show units. Possible values : 'True' or 'False'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getDurationDecimalCount

      public DecimalCount getDurationDecimalCount() throws BusinessObjectException
      Gets the Duration Decimal count for the user is the number of decimal places to be displayed for the Duration. : '0','1' or '2'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field DurationDecimalCount
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setDurationDecimalCount

      public void setDurationDecimalCount(DecimalCount enm) throws BusinessObjectException
      Sets the Duration Decimal count for the user is the number of decimal places to be displayed for the Duration. : '0','1' or '2'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getShowDurationTimeUnit

      public boolean getShowDurationTimeUnit() throws BusinessObjectException
      Gets the flag which when set to true will show units for the Duration, and when set to false will not show units. Possible values : 'True' or 'False'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field ShowDurationTimeUnit
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setShowDurationTimeUnit

      public void setShowDurationTimeUnit(boolean b) throws BusinessObjectException
      Sets the flag which when set to true will show units for the Duration, and when set to false will not show units. Possible values : 'True' or 'False'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getUnitsPerTimeShowAsPercentage

      public boolean getUnitsPerTimeShowAsPercentage() throws BusinessObjectException
      Gets the flag which when set to true will show Units/Time as Percentage, and when set to false will display as Units/Duration. Possible values : 'True' or 'False'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field UnitsPerTimeShowAsPercentage
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setUnitsPerTimeShowAsPercentage

      public void setUnitsPerTimeShowAsPercentage(boolean b) throws BusinessObjectException
      Sets the flag which when set to true will show Units/Time as Percentage, and when set to false will display as Units/Duration. Possible values : 'True' or 'False'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getDateFormatType

      public DateFormatType getDateFormatType() throws BusinessObjectException
      Gets the date format type for the user: 'Month, Day, Year' , 'Day, Month, Year' or 'Year, Month, Day'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field DateFormatType
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setDateFormatType

      public void setDateFormatType(DateFormatType enm) throws BusinessObjectException
      Sets the date format type for the user: 'Month, Day, Year' , 'Day, Month, Year' or 'Year, Month, Day'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getDateTimeFormatType

      public DateTimeFormatType getDateTimeFormatType() throws BusinessObjectException
      Gets the date format type for the user: '12 hour (1:30 PM)' , '24 hour (13:30)' or 'Do not show time'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field DateTimeFormatType
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setDateTimeFormatType

      public void setDateTimeFormatType(DateTimeFormatType enm) throws BusinessObjectException
      Sets the date format type for the user: '12 hour (1:30 PM)' , '24 hour (13:30)' or 'Do not show time'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getDateShowMinutes

      public boolean getDateShowMinutes() throws BusinessObjectException
      Gets the flag which when set to true will show minutes value for the Time format specified, and when set to false will not show minutes value. Possible values : 'True' or 'False'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field DateShowMinutes
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setDateShowMinutes

      public void setDateShowMinutes(boolean b) throws BusinessObjectException
      Sets the flag which when set to true will show minutes value for the Time format specified, and when set to false will not show minutes value. Possible values : 'True' or 'False'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getDateShowFourDigitYear

      public boolean getDateShowFourDigitYear() throws BusinessObjectException
      Gets the flag which when set to true will show four digit year for the Date format specified, and when set to false will not show four digit year. Possible values : 'True' or 'False'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field DateShowFourDigitYear
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setDateShowFourDigitYear

      public void setDateShowFourDigitYear(boolean b) throws BusinessObjectException
      Sets the flag which when set to true will show four digit year for the Date format specified, and when set to false will not show four digit year. Possible values : 'True' or 'False'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getDateUseMonthName

      public boolean getDateUseMonthName() throws BusinessObjectException
      Gets the flag which when set to true will show month value for the Date format specified, and when set to false will not show month value. Possible values : 'True' or 'False'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field DateUseMonthName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setDateUseMonthName

      public void setDateUseMonthName(boolean b) throws BusinessObjectException
      Sets the flag which when set to true will show month value for the Date format specified, and when set to false will not show month value. Possible values : 'True' or 'False'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getDateUseLeadingZero

      public boolean getDateUseLeadingZero() throws BusinessObjectException
      Gets the flag which when set to true will show leading zero for the Date format specified, and when set to false will not show leading zero. Possible values : 'True' or 'False'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field DateUseLeadingZero
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setDateUseLeadingZero

      public void setDateUseLeadingZero(boolean b) throws BusinessObjectException
      Sets the flag which when set to true will show leading zero for the Date format specified, and when set to false will not show leading zero. Possible values : 'True' or 'False'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getDateSeparator

      public DateSeparator getDateSeparator() throws BusinessObjectException
      Gets the date Separator for the user: '/' , '-' or '.'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field DateSeparator
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setDateSeparator

      public void setDateSeparator(DateSeparator enm) throws BusinessObjectException
      Sets the date Separator for the user: '/' , '-' or '.'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getCurrencyShowSymbol

      public boolean getCurrencyShowSymbol() throws BusinessObjectException
      Gets the flag which when set to true will show Currency Symbol for the currency, and when set to false will not Display Currency Symbol. Possible values : 'True' or 'False'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field CurrencyShowSymbol
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setCurrencyShowSymbol

      public void setCurrencyShowSymbol(boolean b) throws BusinessObjectException
      Sets the flag which when set to true will show Currency Symbol for the currency, and when set to false will not Display Currency Symbol. Possible values : 'True' or 'False'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getCurrencyShowDecimals

      public boolean getCurrencyShowDecimals() throws BusinessObjectException
      Gets the flag which when set to true will show decimal places for the currency, and when set to false will not Display decimal places. Possible values : 'True' or 'False'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field CurrencyShowDecimals
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setCurrencyShowDecimals

      public void setCurrencyShowDecimals(boolean b) throws BusinessObjectException
      Sets the flag which when set to true will show decimal places for the currency, and when set to false will not Display decimal places. Possible values : 'True' or 'False'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getRespectActivityDurationType

      public boolean getRespectActivityDurationType() throws BusinessObjectException
      Gets the setting that indicates whether to recalculate the Duration, Units, or Units/Time for existing assignments based on the activity Duration Type (true) or to preserve the Duration, Units, or Units/Time for existing assignments (false) when adding or removing assignments on activities. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field RespectActivityDurationType
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setRespectActivityDurationType

      public void setRespectActivityDurationType(boolean b) throws BusinessObjectException
      Sets the setting that indicates whether to recalculate the Duration, Units, or Units/Time for existing assignments based on the activity Duration Type (true) or to preserve the Duration, Units, or Units/Time for existing assignments (false) when adding or removing assignments on activities. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getRateSourcePreference

      public RateSourcePreference getRateSourcePreference() throws BusinessObjectException
      Gets the value that determines which price/unit will be used by default to calculate costs for the assignment when both a resource and role are assigned. If the value is 'Resource', the resource's price/unit will be used. If the value is 'Role', the role's price/unit will be used. If the value is 'Ask me', the default is set to 'Resource'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field RateSourcePreference
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setRateSourcePreference

      public void setRateSourcePreference(RateSourcePreference enm) throws BusinessObjectException
      Sets the value that determines which price/unit will be used by default to calculate costs for the assignment when both a resource and role are assigned. If the value is 'Resource', the resource's price/unit will be used. If the value is 'Role', the role's price/unit will be used. If the value is 'Ask me', the default is set to 'Resource'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getAssignmentStaffingPreference

      public AssignmentStaffingPreference getAssignmentStaffingPreference() throws BusinessObjectException
      Gets the value that determines whether the current or the new resource's Units per Time and Overtime factor is used to calculate costs when assigning the resource to an existing activity assignment. If the AssignmentStaffingPreference is set to 'Ask Me', the default value is then current resource. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field AssignmentStaffingPreference
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setAssignmentStaffingPreference

      public void setAssignmentStaffingPreference(AssignmentStaffingPreference enm) throws BusinessObjectException
      Sets the value that determines whether the current or the new resource's Units per Time and Overtime factor is used to calculate costs when assigning the resource to an existing activity assignment. If the AssignmentStaffingPreference is set to 'Ask Me', the default value is then current resource. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getNewProjectDurationType

      public DurationType getNewProjectDurationType() throws BusinessObjectException
      Gets the default duration type assigned to new activities. Valid values are 'Fixed Units/Time', 'Fixed Duration and Units/Time', 'Fixed Units', or 'Fixed Duration and Units'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field NewProjectDurationType
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setNewProjectDurationType

      public void setNewProjectDurationType(DurationType enm) throws BusinessObjectException
      Sets the default duration type assigned to new activities. Valid values are 'Fixed Units/Time', 'Fixed Duration and Units/Time', 'Fixed Units', or 'Fixed Duration and Units'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getFinancialPeriodStartObjectId

      public ObjectId getFinancialPeriodStartObjectId() throws BusinessObjectException
      Gets the unique ID generated by the system of the first financial period viewable in columns in Project Management. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field FinancialPeriodStartObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setFinancialPeriodStartObjectId

      public void setFinancialPeriodStartObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID generated by the system of the first financial period viewable in columns in Project Management. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      o - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getFinancialPeriodEndObjectId

      public ObjectId getFinancialPeriodEndObjectId() throws BusinessObjectException
      Gets the unique ID generated by the system of the last financial period viewable in columns in Project Management. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field FinancialPeriodEndObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setFinancialPeriodEndObjectId

      public void setFinancialPeriodEndObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID generated by the system of the last financial period viewable in columns in Project Management. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      o - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getResourceRequests

      public ResourceRequest[] getResourceRequests() throws BusinessObjectException
      Gets the resource requests used as search templates to search for qualified resources. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field ResourceRequests
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setResourceRequests

      public void setResourceRequests(ResourceRequest[] r) throws BusinessObjectException
      Sets the resource requests used as search templates to search for qualified resources. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      r - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getRoleLimitDisplayOption

      public RoleLimitDisplayOption getRoleLimitDisplayOption() throws BusinessObjectException
      Gets the option for how RoleLimit is displayed. Valid values are 'Custom', and 'PrimaryRole'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field RoleLimitDisplayOption
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setRoleLimitDisplayOption

      public void setRoleLimitDisplayOption(RoleLimitDisplayOption enm) throws BusinessObjectException
      Sets the option for how RoleLimit is displayed. Valid values are 'Custom', and 'PrimaryRole'. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getReportingFlag

      public boolean getReportingFlag() throws BusinessObjectException
      Gets the flag that determines whether the user can access ODS database as a database user.
      Returns:
      the value in the field ReportingFlag
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setReportingFlag

      public void setReportingFlag(boolean b) throws BusinessObjectException
      Sets the flag that determines whether the user can access ODS database as a database user.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getCreateDate

      public Date getCreateDate() throws BusinessObjectException
      Gets the date this user was created.
      Returns:
      the value in the field CreateDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getLastUpdateDate

      public Date getLastUpdateDate() throws BusinessObjectException
      Gets the date this user was last updated.
      Returns:
      the value in the field LastUpdateDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getCreateUser

      public String getCreateUser() throws BusinessObjectException
      Gets the name of the user that created this user.
      Returns:
      the value in the field CreateUser
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getLastUpdateUser

      public String getLastUpdateUser() throws BusinessObjectException
      Gets the name of the user that last updated this user.
      Returns:
      the value in the field LastUpdateUser
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getDoNotShowNewFeaturesAgain

      public boolean getDoNotShowNewFeaturesAgain() throws BusinessObjectException
      Gets do not show again option in new features dialog. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field DoNotShowNewFeaturesAgain
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setDoNotShowNewFeaturesAgain

      public void setDoNotShowNewFeaturesAgain(boolean b) throws BusinessObjectException
      Sets do not show again option in new features dialog. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTeamMemberApplicationTheme

      public String getTeamMemberApplicationTheme() throws BusinessObjectException
      Gets the user interface theme setting for the Team Member application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field TeamMemberApplicationTheme
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setTeamMemberApplicationTheme

      public void setTeamMemberApplicationTheme(String s) throws BusinessObjectException
      Sets the user interface theme setting for the Team Member application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTeamMemberDateFormat

      public String getTeamMemberDateFormat() throws BusinessObjectException
      Gets the date format setting for the Team Member application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field TeamMemberDateFormat
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setTeamMemberDateFormat

      public void setTeamMemberDateFormat(String s) throws BusinessObjectException
      Sets the date format setting for the Team Member application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTeamMemberLocale

      public String getTeamMemberLocale() throws BusinessObjectException
      Gets the user-specific locale for the Team Member application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field TeamMemberLocale
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setTeamMemberLocale

      public void setTeamMemberLocale(String s) throws BusinessObjectException
      Sets the user-specific locale for the Team Member application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTeamMemberDisplayTimeFlag

      public boolean getTeamMemberDisplayTimeFlag() throws BusinessObjectException
      Gets the display hours setting for Team Member application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field TeamMemberDisplayTimeFlag
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setTeamMemberDisplayTimeFlag

      public void setTeamMemberDisplayTimeFlag(boolean b) throws BusinessObjectException
      Sets the display hours setting for Team Member application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTeamMemberAllTimeframeForCompleted

      public String getTeamMemberAllTimeframeForCompleted() throws BusinessObjectException
      Gets timeframe for loading completed activities in Team Member application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field TeamMemberAllTimeframeForCompleted
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setTeamMemberAllTimeframeForCompleted

      public void setTeamMemberAllTimeframeForCompleted(String s) throws BusinessObjectException
      Sets timeframe for loading completed activities in Team Member application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTeamMemberDisplayTimeFormat

      public String getTeamMemberDisplayTimeFormat() throws BusinessObjectException
      Gets the display hours format setting for Team Member application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field TeamMemberDisplayTimeFormat
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setTeamMemberDisplayTimeFormat

      public void setTeamMemberDisplayTimeFormat(String s) throws BusinessObjectException
      Sets the display hours format setting for Team Member application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTeamMemberWorkUnitType

      public UnitType getTeamMemberWorkUnitType() throws BusinessObjectException
      Gets the work unit type user preference for the Team Member application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field TeamMemberWorkUnitType
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setTeamMemberWorkUnitType

      public void setTeamMemberWorkUnitType(UnitType enm) throws BusinessObjectException
      Sets the work unit type user preference for the Team Member application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTeamMemberProjectFilter

      public String getTeamMemberProjectFilter() throws BusinessObjectException
      Gets the user-specific project filter for the Team Member application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field TeamMemberProjectFilter
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setTeamMemberProjectFilter

      public void setTeamMemberProjectFilter(String s) throws BusinessObjectException
      Sets the user-specific project filter for the Team Member application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTeamMemberWBSFilter

      public String getTeamMemberWBSFilter() throws BusinessObjectException
      Gets the user-specific wbs filter for the Team Member application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field TeamMemberWBSFilter
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setTeamMemberWBSFilter

      public void setTeamMemberWBSFilter(String s) throws BusinessObjectException
      Sets the user-specific wbs filter for the Team Member application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTimesheetProjectFilter

      public String getTimesheetProjectFilter() throws BusinessObjectException
      Gets the user-specific project filter for the Timesheet application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field TimesheetProjectFilter
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setTimesheetProjectFilter

      public void setTimesheetProjectFilter(String s) throws BusinessObjectException
      Sets the user-specific project filter for the Timesheet application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTimesheetWBSFilter

      public String getTimesheetWBSFilter() throws BusinessObjectException
      Gets the user-specific wbs filter for the Timesheet application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field TimesheetWBSFilter
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setTimesheetWBSFilter

      public void setTimesheetWBSFilter(String s) throws BusinessObjectException
      Sets the user-specific wbs filter for the Timesheet application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTeamMemberResourceFilter

      public String getTeamMemberResourceFilter() throws BusinessObjectException
      Gets the user-specific Resource filter for the Team Member application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field TeamMemberResourceFilter
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setTeamMemberResourceFilter

      public void setTeamMemberResourceFilter(String s) throws BusinessObjectException
      Sets the user-specific Resource filter for the Team Member application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTeamMemberDisplayQRQuickAccess

      public String getTeamMemberDisplayQRQuickAccess() throws BusinessObjectException
      Gets the flag to decide if the user has seen the QR Code quick access link in the Team Member application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field TeamMemberDisplayQRQuickAccess
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setTeamMemberDisplayQRQuickAccess

      public void setTeamMemberDisplayQRQuickAccess(String s) throws BusinessObjectException
      Sets the flag to decide if the user has seen the QR Code quick access link in the Team Member application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTeamMemberTaskStatusFilter

      public String getTeamMemberTaskStatusFilter() throws BusinessObjectException
      Gets the user-specific task status filter for the Team Member application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field TeamMemberTaskStatusFilter
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setTeamMemberTaskStatusFilter

      public void setTeamMemberTaskStatusFilter(String s) throws BusinessObjectException
      Sets the user-specific task status filter for the Team Member application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTeamMemberTimeframeFilter

      public String getTeamMemberTimeframeFilter() throws BusinessObjectException
      Gets the user-specific timeframe filter for the Team Member application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field TeamMemberTimeframeFilter
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setTeamMemberTimeframeFilter

      public void setTeamMemberTimeframeFilter(String s) throws BusinessObjectException
      Sets the user-specific timeframe filter for the Team Member application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTeamMemberActivitySortField

      public String getTeamMemberActivitySortField() throws BusinessObjectException
      Gets the user-specific sorting field for the Team Member application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field TeamMemberActivitySortField
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setTeamMemberActivitySortField

      public void setTeamMemberActivitySortField(String s) throws BusinessObjectException
      Sets the user-specific sorting field for the Team Member application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTeamMemberActivitySortOrder

      public String getTeamMemberActivitySortOrder() throws BusinessObjectException
      Gets the user-specific sorting order for the Team Member application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field TeamMemberActivitySortOrder
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setTeamMemberActivitySortOrder

      public void setTeamMemberActivitySortOrder(String s) throws BusinessObjectException
      Sets the user-specific sorting order for the Team Member application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTeamMemberActivityFilters

      public String getTeamMemberActivityFilters() throws BusinessObjectException
      Gets the Statuser activity filters for the Team Member application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field TeamMemberActivityFilters
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setTeamMemberActivityFilters

      public void setTeamMemberActivityFilters(String s) throws BusinessObjectException
      Sets the Statuser activity filters for the Team Member application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTeamMemberActivityFiltersJoin

      public String getTeamMemberActivityFiltersJoin() throws BusinessObjectException
      Gets the Statuser activity filters for the Team Member application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field TeamMemberActivityFiltersJoin
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setTeamMemberActivityFiltersJoin

      public void setTeamMemberActivityFiltersJoin(String s) throws BusinessObjectException
      Sets the Statuser activity filters for the Team Member application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTMSelectedActivityFilters

      public String getTMSelectedActivityFilters() throws BusinessObjectException
      Gets the selected activity filters for the Team Member application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field TMSelectedActivityFilters
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setTMSelectedActivityFilters

      public void setTMSelectedActivityFilters(String s) throws BusinessObjectException
      Sets the selected activity filters for the Team Member application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTMSelectedActivityFiltersJoin

      public String getTMSelectedActivityFiltersJoin() throws BusinessObjectException
      Gets the selected activity filters join for the Team Member application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field TMSelectedActivityFiltersJoin
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setTMSelectedActivityFiltersJoin

      public void setTMSelectedActivityFiltersJoin(String s) throws BusinessObjectException
      Sets the selected activity filters join for the Team Member application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTMSelectedTimesheetFiltersJoin

      public String getTMSelectedTimesheetFiltersJoin() throws BusinessObjectException
      Gets the selected timesheet filters join for the Team Member application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field TMSelectedTimesheetFiltersJoin
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setTMSelectedTimesheetFiltersJoin

      public void setTMSelectedTimesheetFiltersJoin(String s) throws BusinessObjectException
      Sets the selected timesheet filters join for the Team Member application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getTMSelectedTimesheetFilters

      public String getTMSelectedTimesheetFilters() throws BusinessObjectException
      Gets the selected activity filters for the Team Member application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Returns:
      the value in the field TMSelectedTimesheetFilters
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • setTMSelectedTimesheetFilters

      public void setTMSelectedTimesheetFilters(String s) throws BusinessObjectException
      Sets the selected activity filters for the Team Member application. This field may not be included in the where clause or order by clause specified when loading business objects.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects
    • getRequiredCreateFields

      public static String[] getRequiredCreateFields()
      Gets all fields that must be set before calling create() on this business object. Generally the array will contain one field in each position, but if this business object requires either one field or another field to be set, both of those fields will appear in an element of the returned array separated by '|'. For example, if this business object requires field A to always be set, and field B or field C to be set, one element in the returned array will contain A, and one element will contain B|C.
      Returns:
      String[] an array of required create fields
    • getFilterableFields

      public static String[] getFilterableFields()
      Gets all fields that can be filtered.
      Returns:
      String[] an array of filterable fields
    • getInternalDefaultLoadFields

      public static String[] getInternalDefaultLoadFields()
      An internal method that should not be called directly by client code.
      Returns:
      String[] an internal array
    • getAllFields

      public static String[] getAllFields()
      Gets all fields for this business object.
      Returns:
      String[] an array of all fields
    • getInternalAllFields

      public static String[] getInternalAllFields()
      An internal method that should not be called directly by client code.
      Returns:
      String[] an internal array
    • getInternalAllFieldsSet

      public static Set<String> getInternalAllFieldsSet()
      An internal method that should not be called directly by client code.
      Returns:
      String[] an internal array
    • getWritableFields

      public static String[] getWritableFields()
      Gets all writable fields for this business object.
      Returns:
      String[] an array of writable fields
    • getDefaultXMLExportFields

      @Deprecated public static String[] getDefaultXMLExportFields()
      Deprecated.
      Gets the fields that are exported by the hierarchical XML exporter when no fields are specified. This method is no longer relevant since the hierarchical XML exporter has been replaced by the flat XML exporter.
      Returns:
      String[] an array of field names
    • getMinimumXMLExportFields

      public static String[] getMinimumXMLExportFields()
      Gets all fields that are always exported at a minimum by the new flat XML exporter
      Returns:
      String[] an array of exported fields
    • toString

      public String toString()
      Returns a string representation of the object. The output is in XML.
      Overrides:
      toString in class Object
      Returns:
      String a string representation of the object.
    • create

      Creates this User object in the database.
      Returns:
      ObjectId the unique ID of the newly created User object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • create

      public static ObjectId[] create(Session session, User[] users) throws ServerException, NetworkException, BusinessObjectException
      Creates multiple User objects in the database.
      Parameters:
      session - the Session object
      users - array of User objects to create
      Returns:
      ObjectId[] the array of unique IDs of newly created User objects
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • load

      public static User load(Session session, String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
      Loads a single User object from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objId - unique ID of the User object
      Returns:
      User the User object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • load

      public static BOIterator<User> load(Session session, String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple User objects from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objIds - object ids of the User objects
      Returns:
      BOIterator a business object iterator used to get the results of the load request
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • update

      Updates this User object in the database.
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • update

      public static void update(Session session, User[] users) throws ServerException, NetworkException, BusinessObjectException
      Updates multiple User objects in the database.
      Parameters:
      session - the Session object
      users - array of User objects to update
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • delete

      Deletes this User object from the database.
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects
    • delete

      public static void delete(Session session, User[] users) throws ServerException, NetworkException, BusinessObjectException
      Deletes multiple User objects from the database.
      Parameters:
      session - the Session object
      users - array of User objects to delete
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects