Class User
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 Summary
ConstructorsConstructorDescriptionClass constructor specifying the Session.Class constructor specifying the Session and ObjectId of the object.Class constructor called internally after objects are retrieved from the server. -
Method Summary
Modifier and TypeMethodDescriptioncreate()Creates this User object in the database.static ObjectId[]Creates multiple User objects in the database.createProjectPortfolio(ProjectPortfolio projectportfolio) Creates an associated ProjectPortfolio object in the database.ObjectId[]createProjectPortfolios(ProjectPortfolio[] projectportfolios) Creates multiple associated ProjectPortfolio objects in the database.createResourceTeam(ResourceTeam resourceteam) Creates an associated ResourceTeam object in the database.ObjectId[]createResourceTeams(ResourceTeam[] resourceteams) Creates multiple associated ResourceTeam objects in the database.createRoleTeam(RoleTeam roleteam) Creates an associated RoleTeam object in the database.ObjectId[]createRoleTeams(RoleTeam[] roleteams) Creates multiple associated RoleTeam objects in the database.createUserLicense(UserLicense userlicense) Creates an associated UserLicense object in the database.ObjectId[]createUserLicenses(UserLicense[] userlicenses) Creates multiple associated UserLicense objects in the database.createUserOBS(UserOBS userobs) Creates an associated UserOBS object in the database.ObjectId[]createUserOBS(UserOBS[] userobs) Creates multiple associated UserOBS objects in the database.voiddelete()Deletes this User object from the database.static voidDeletes multiple User objects from the database.voiddeleteProjectPortfolios(ProjectPortfolio[] projectportfolios) Deletes multiple associated ProjectPortfolio objects from the database.voiddeleteResourceTeams(ResourceTeam[] resourceteams) Deletes multiple associated ResourceTeam objects from the database.voiddeleteRoleTeams(RoleTeam[] roleteams) Deletes multiple associated RoleTeam objects from the database.voiddeleteUserLicenses(UserLicense[] userlicenses) Deletes multiple associated UserLicense objects from the database.voiddeleteUserOBS(UserOBS[] userobs) Deletes multiple associated UserOBS objects from the database.static String[]Gets all fields for this business object.booleanGets the flag that determines whether the user has all resource access (TRUE) or restricted resource access (FALSE).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.Gets the date this user was created.Gets the name of the user that created this user.Gets the unique currency abbreviation for the currency associated with this user.Gets the name of the currency associated with this user.Gets the unique ID of the associated currency.booleanGets the flag which when set to true will show decimal places for the currency, and when set to false will not Display decimal places.booleanGets the flag which when set to true will show Currency Symbol for the currency, and when set to false will not Display Currency Symbol.Gets the date format type for the user: 'Month, Day, Year' , 'Day, Month, Year' or 'Year, Month, Day'.Gets the date Separator for the user: '/' , '-' or '.'.booleanGets 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.booleanGets 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.Gets the date format type for the user: '12 hour (1:30 PM)' , '24 hour (13:30)' or 'Do not show time'.booleanGets 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.booleanGets 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.static String[]Deprecated.booleanGets do not show again option in new features dialog.Gets the Duration Decimal count for the user is the number of decimal places to be displayed for the Duration.Gets the Duration Unit Type for the user is the Display Time units In: 'Hour','Day','Week','Month' or 'Year'.booleanGets the flag which when set to true will show units for the Duration, and when set to false will not show units.booleanGets the flag that when set to true allows the user to change his or her Global Settings under My Preferences.Gets the current user's return email address.Gets the email type for the user: 'Internet Mail' or 'MAPI Mail'.booleanGets the flag that when set to true allows the user to change his or her personal view settings in P6 Web Access.static String[]Gets all fields that can be filtered.Gets the unique ID generated by the system of the last financial period viewable in columns in Project Management.Gets the unique ID generated by the system of the first financial period viewable in columns in Project Management.Gets the unique ID of the global security profile assigned to the user.getGUID()Gets the globally unique ID generated by the system.static String[]An internal method that should not be called directly by client code.An internal method that should not be called directly by client code.static String[]An internal method that should not be called directly by client code.Gets the date this user was last updated.Gets the name of the user that last updated this user.Gets the mail login name (profile name) for the current user to send outgoing email.static String[]Gets all fields that are always exported at a minimum by the new flat XML exportergetName()Gets the user's login name.Gets the default duration type assigned to new activities.Gets the unique ID generated by the system.Gets the work phone number of the user.Gets the outgoing mail server (SMTP) address used to send outgoing email for this user.Gets the user's personal or actual name.getPrimaryBaselineProject(ObjectId projectId) Gets the user's primary BaselineProject for the specified project.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.booleanGets the flag that determines whether the user can access ODS database as a database user.static String[]Gets all fields that must be set before calling create() on this business object.Gets the resource requests used as search templates to search for qualified resources.booleanGets 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.Gets the option for how RoleLimit is displayed.getSecondaryBaselineProject(ObjectId projectId) Gets the user's secondary BaselineProject for the specified project.booleanGets the flag which when set to true will show units for the Duration, and when set to false will not show units.booleanGets the flag which when set to true will show units for the Time, and when set to false will not show units.Gets the Small Scale Decimal count for the user is the number of decimal places to be displayed for the Time.Gets the Small Scale Unit Type for the user is the Display Time units In: 'Hour','Day','Week','Month' or 'Year'.booleanGets 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.Gets the Statuser activity filters for the Team Member application.Gets the Statuser activity filters for the Team Member application.Gets the user-specific sorting field for the Team Member application.Gets the user-specific sorting order for the Team Member application.Gets timeframe for loading completed activities in Team Member application.Gets the user interface theme setting for the Team Member application.Gets the date format setting for the Team Member application.Gets the flag to decide if the user has seen the QR Code quick access link in the Team Member application.booleanGets the display hours setting for Team Member application.Gets the display hours format setting for Team Member application.Gets the user-specific locale for the Team Member application.Gets the user-specific project filter for the Team Member application.Gets the user-specific Resource filter for the Team Member application.Gets the user-specific task status filter for the Team Member application.Gets the user-specific timeframe filter for the Team Member application.Gets the user-specific wbs filter for the Team Member application.Gets the work unit type user preference for the Team Member application.getTertiaryBaselineProject(ObjectId projectId) Gets the user's tertiary BaselineProject for the specified project.Gets the user-specific project filter for the Timesheet application.Gets the user-specific wbs filter for the Timesheet application.Gets the selected activity filters for the Team Member application.Gets the selected activity filters join for the Team Member application.Gets the selected activity filters for the Team Member application.Gets the selected timesheet filters join for the Team Member application.booleanGets the flag which when set to true will show Units/Time as Percentage, and when set to false will display as Units/Duration.Gets the unique ID of the associated user interface view.static String[]Gets all writable fields for this business object.static UserLoads a single User object from the database.static BOIterator<User>Loads multiple User objects from the database.loadActivityOwners(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ActivityOwner objects from the database.loadCurrency(String[] fields) Loads an associated Currency object from the database.loadGlobalProfile(String[] fields) Loads an associated GlobalProfile object from the database.loadProjectPortfolios(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ProjectPortfolio objects from the database.loadResource(String[] fields) Loads an associated Resource object from the database.loadResourceAccess(String[] fields) Loads an associated ResourceAccess object from the database.loadResourceTeams(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated ResourceTeam objects from the database.loadRoleTeams(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated RoleTeam objects from the database.loadUserFilteredActivities(String[] fields, String sWhereClause, String sOrderBy) Loads Non-Milestone activities matching filters set on User.loadUserFilteredMilestoneActivities(String[] fields, String sWhereClause, String sOrderBy) Loads Milestone activities matching filters set on User.loadUserLicenses(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated UserLicense objects from the database.loadUserOBS(String[] fields, String sWhereClause, String sOrderBy) Loads multiple associated UserOBS objects from the database.voidsetAllResourceAccessFlag(boolean b) Sets the flag that determines whether the user has all resource access (TRUE) or restricted resource access (FALSE).voidSets 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.voidSets the unique ID of the associated currency.voidsetCurrencyShowDecimals(boolean b) 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.voidsetCurrencyShowSymbol(boolean b) 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.voidSets the date format type for the user: 'Month, Day, Year' , 'Day, Month, Year' or 'Year, Month, Day'.voidSets the date Separator for the user: '/' , '-' or '.'.voidsetDateShowFourDigitYear(boolean b) 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.voidsetDateShowMinutes(boolean b) 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.voidSets the date format type for the user: '12 hour (1:30 PM)' , '24 hour (13:30)' or 'Do not show time'.voidsetDateUseLeadingZero(boolean b) 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.voidsetDateUseMonthName(boolean b) 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.voidsetDoNotShowNewFeaturesAgain(boolean b) Sets do not show again option in new features dialog.voidSets the Duration Decimal count for the user is the number of decimal places to be displayed for the Duration.voidSets the Duration Unit Type for the user is the Display Time units In: 'Hour','Day','Week','Month' or 'Year'.voidsetDurationUseFraction(boolean b) Sets the flag which when set to true will show units for the Duration, and when set to false will not show units.voidsetEditGlobalUserPreferences(boolean b) Sets the flag that when set to true allows the user to change his or her Global Settings under My Preferences.voidSets the current user's return email address.voidSets the email type for the user: 'Internet Mail' or 'MAPI Mail'.voidsetEnableUserToModifyViewSettingsFlag(boolean b) Sets the flag that when set to true allows the user to change his or her personal view settings in P6 Web Access.voidSets the unique ID generated by the system of the last financial period viewable in columns in Project Management.voidSets the unique ID generated by the system of the first financial period viewable in columns in Project Management.voidSets the unique ID of the global security profile assigned to the user.voidSets the globally unique ID generated by the system.voidSets the mail login name (profile name) for the current user to send outgoing email.voidsetMailServerPassword(String sNewPassword) Sets e-mail server password.voidSets the user's login name.voidSets the default duration type assigned to new activities.voidSets the unique ID generated by the system.voidSets the work phone number of the user.voidSets the outgoing mail server (SMTP) address used to send outgoing email for this user.voidsetPassword(String sOldPassword, String sNewPassword) Sets user password for the non-admin user; must specify old password.voidSets the user's personal or actual name.voidsetPrimaryBaselineProject(ObjectId projectId, ObjectId baselineProjectId) Sets the value of the user's primary BaselineProject for a specific project.voidSets 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.voidsetReportingFlag(boolean b) Sets the flag that determines whether the user can access ODS database as a database user.voidSets the resource requests used as search templates to search for qualified resources.voidsetRespectActivityDurationType(boolean b) 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.voidSets the option for how RoleLimit is displayed.voidsetSecondaryBaselineProject(ObjectId projectId, ObjectId baselineProjectId) Sets the value of the user's secondary BaselineProject for a specific project.voidsetShowDurationTimeUnit(boolean b) Sets the flag which when set to true will show units for the Duration, and when set to false will not show units.voidsetShowTimeUnit(boolean b) Sets the flag which when set to true will show units for the Time, and when set to false will not show units.voidSets the Small Scale Decimal count for the user is the number of decimal places to be displayed for the Time.voidSets the Small Scale Unit Type for the user is the Display Time units In: 'Hour','Day','Week','Month' or 'Year'.voidsetSmallScaleUseFraction(boolean b) 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.voidSets the Statuser activity filters for the Team Member application.voidSets the Statuser activity filters for the Team Member application.voidSets the user-specific sorting field for the Team Member application.voidSets the user-specific sorting order for the Team Member application.voidSets timeframe for loading completed activities in Team Member application.voidSets the user interface theme setting for the Team Member application.voidSets the date format setting for the Team Member application.voidSets the flag to decide if the user has seen the QR Code quick access link in the Team Member application.voidsetTeamMemberDisplayTimeFlag(boolean b) Sets the display hours setting for Team Member application.voidSets the display hours format setting for Team Member application.voidSets the user-specific locale for the Team Member application.voidSets the user-specific project filter for the Team Member application.voidSets the user-specific Resource filter for the Team Member application.voidSets the user-specific task status filter for the Team Member application.voidSets the user-specific timeframe filter for the Team Member application.voidSets the user-specific wbs filter for the Team Member application.voidSets the work unit type user preference for the Team Member application.voidsetTertiaryBaselineProject(ObjectId projectId, ObjectId baselineProjectId) Sets the value of the user's primary baseline for a specific project.voidSets the user-specific project filter for the Timesheet application.voidSets the user-specific wbs filter for the Timesheet application.voidSets the selected activity filters for the Team Member application.voidSets the selected activity filters join for the Team Member application.voidSets the selected activity filters for the Team Member application.voidSets the selected timesheet filters join for the Team Member application.voidsetUnitsPerTimeShowAsPercentage(boolean b) Sets the flag which when set to true will show Units/Time as Percentage, and when set to false will display as Units/Duration.voidSets the unique ID of the associated user interface view.toString()Returns a string representation of the object.voidupdate()Updates this User object in the database.static voidUpdates multiple User objects in the database.static voidUpdates multiple User objects in the database with the option to reset User Data.voidupdateProjectPortfolios(ProjectPortfolio[] projectportfolios) Updates multiple associated ProjectPortfolio objects in the database.voidupdateResourceTeams(ResourceTeam[] resourceteams) Updates multiple associated ResourceTeam objects in the database.voidupdateRoleTeams(RoleTeam[] roleteams) Updates multiple associated RoleTeam objects in the database.voidupdateUserLicenses(UserLicense[] userlicenses) Updates multiple associated UserLicense objects in the database.voidupdateUserOBS(UserOBS[] userobs) Updates multiple associated UserOBS objects in the database.Methods inherited from class com.primavera.integration.client.bo.BusinessObject
equals, getMaxFieldLength, getValue, getValue, hashCode, isNull, setEarlyDate, setNullMethods inherited from class com.primavera.integration.client.BOBase
combineFields
-
Constructor Details
-
User
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
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 SessionobjId- 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 SessionrowSet- the PrmRowSet retrieved from the serveriIndex- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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 loadsWhereClause- where clausesOrderBy- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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 loadsWhereClause- where clausesOrderBy- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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 loadsWhereClause- where clausesOrderBy- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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 loadsWhereClause- where clausesOrderBy- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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 loadsWhereClause- where clausesOrderBy- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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 loadsWhereClause- where clausesOrderBy- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- if a problem occurred in the client-side business objects
-
setPassword
Sets user password for the non-admin user; must specify old password.- Parameters:
sOldPassword- the old password. sOldPassword may be null for admin superusersNewPassword- the new password- Throws:
BusinessObjectException- if the password change failed
-
setMailServerPassword
Sets e-mail server password.- Parameters:
sNewPassword- the new password for email server- Throws:
BusinessObjectException- if the password change failed
-
getPrimaryBaselineProject
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 projectbaselineProjectId- the unique identifier for the BaselineProject- Throws:
BusinessObjectException- if the value cannot be set
-
getSecondaryBaselineProject
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 projectbaselineProjectId- the unique identifier for the BaselineProject- Throws:
BusinessObjectException- if the value cannot be set
-
getTertiaryBaselineProject
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 projectbaselineProjectId- 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:
loadUserFilteredActivitiesin classcom.primavera.integration.client.bo.base.UserBase- Returns:
- BOIterator that contains Non-Milestone Activities
- Throws:
BusinessObjectException- if problem occurs in processing user filtersServerException- if a problem occurred on the server-sideNetworkException- 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:
loadUserFilteredMilestoneActivitiesin classcom.primavera.integration.client.bo.base.UserBase- Returns:
- BOIterator that contains Milestone Activities
- Throws:
BusinessObjectException- if problem occurs in processing user filtersServerException- if a problem occurred on the server-sideNetworkException- 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 objectusers- array of User objects to updateresetUserData- whether to reset user data- Throws:
ServerException- if a problem occurred on the server-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- if a problem occurred in the client-side business objects
-
getEnableUserToModifyViewSettingsFlag
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
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
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:
getObjectIdin classBusinessObject- Returns:
- the value in the field ObjectId
- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
setObjectId
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:
setObjectIdin classBusinessObject- Parameters:
o- the value to set this field to- Throws:
BusinessObjectException- if a problem occurred in the client-side business objects
-
getEditGlobalUserPreferences
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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 BusinessObjectExceptionGets 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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
Gets all fields that can be filtered.- Returns:
- String[] an array of filterable fields
-
getInternalDefaultLoadFields
An internal method that should not be called directly by client code.- Returns:
- String[] an internal array
-
getAllFields
Gets all fields for this business object.- Returns:
- String[] an array of all fields
-
getInternalAllFields
An internal method that should not be called directly by client code.- Returns:
- String[] an internal array
-
getInternalAllFieldsSet
An internal method that should not be called directly by client code.- Returns:
- String[] an internal array
-
getWritableFields
Gets all writable fields for this business object.- Returns:
- String[] an array of writable fields
-
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
Gets all fields that are always exported at a minimum by the new flat XML exporter- Returns:
- String[] an array of exported fields
-
toString
Returns a string representation of the object. The output is in XML. -
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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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 objectusers- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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 objectfields- fields to loadobjId- unique ID of the User object- Returns:
- User the User object
- Throws:
ServerException- if a problem occurred on the server-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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 objectfields- fields to loadobjIds- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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 objectusers- array of User objects to update- Throws:
ServerException- if a problem occurred on the server-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- 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 objectusers- array of User objects to delete- Throws:
ServerException- if a problem occurred on the server-sideNetworkException- if a problem occurred in the network layerBusinessObjectException- if a problem occurred in the client-side business objects
-