Primavera Integration API 7.0

com.primavera.integration.client.bo.object
Class User

java.lang.Object
  extended by com.primavera.integration.client.BOBase
      extended by com.primavera.integration.client.bo.BusinessObject
          extended by com.primavera.integration.client.bo.base.UserBase
              extended by 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
User(Session session)
          Class constructor specifying the Session.
User(Session session, ObjectId objId)
          Class constructor specifying the Session and ObjectId of the object.
User(Session session, com.primavera.infr.db.PrmRowSet rowSet, int iIndex)
          Class constructor called internally after objects are retrieved from the server.
 
Method Summary
 ObjectId create()
          Creates this User object in the database.
static ObjectId[] create(Session session, User[] users)
          Creates multiple User objects in the database.
 ObjectId createProjectPortfolio(ProjectPortfolio projectportfolio)
          Creates an associated ProjectPortfolio object in the database.
 ObjectId[] createProjectPortfolios(ProjectPortfolio[] projectportfolios)
          Creates multiple associated ProjectPortfolio objects in the database.
 ObjectId createResourceTeam(ResourceTeam resourceteam)
          Creates an associated ResourceTeam object in the database.
 ObjectId[] createResourceTeams(ResourceTeam[] resourceteams)
          Creates multiple associated ResourceTeam objects in the database.
 ObjectId createRoleTeam(RoleTeam roleteam)
          Creates an associated RoleTeam object in the database.
 ObjectId[] createRoleTeams(RoleTeam[] roleteams)
          Creates multiple associated RoleTeam objects in the database.
 ObjectId createUserLicense(UserLicense userlicense)
          Creates an associated UserLicense object in the database.
 ObjectId[] createUserLicenses(UserLicense[] userlicenses)
          Creates multiple associated UserLicense objects in the database.
 ObjectId createUserOBS(UserOBS userobs)
          Creates an associated UserOBS object in the database.
 ObjectId[] createUserOBS(UserOBS[] userobs)
          Creates multiple associated UserOBS objects in the database.
 void delete()
          Deletes this User object from the database.
static void delete(Session session, User[] users)
          Deletes multiple User objects from the database.
 void deleteProjectPortfolios(ProjectPortfolio[] projectportfolios)
          Deletes multiple associated ProjectPortfolio objects from the database.
 void deleteResourceTeams(ResourceTeam[] resourceteams)
          Deletes multiple associated ResourceTeam objects from the database.
 void deleteRoleTeams(RoleTeam[] roleteams)
          Deletes multiple associated RoleTeam objects from the database.
 void deleteUserLicenses(UserLicense[] userlicenses)
          Deletes multiple associated UserLicense objects from the database.
 void deleteUserOBS(UserOBS[] userobs)
          Deletes multiple associated UserOBS objects from the database.
static java.lang.String[] getAllFields()
          Gets all fields for this business object.
 boolean getAllResourceAccessFlag()
          Gets the flag that determines whether the user has all resource access (TRUE) or restricted resource access (FALSE).
 AssignmentStaffingPreference getAssignmentStaffingPreference()
          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.
 java.util.Date getCreateDate()
          Gets the date this user was created.
 java.lang.String getCreateUser()
          Gets the name of the user that created this user.
 java.lang.String getCurrencyId()
          Gets the unique currency abbreviation for the currency associated with this user.
 java.lang.String getCurrencyName()
          Gets the name of the currency associated with this user.
 ObjectId getCurrencyObjectId()
          Gets the unique ID of the associated currency.
static java.lang.String[] getDefaultXMLExportFields()
          Gets the fields that are exported by the XML exporter when no fields are specified.
 java.lang.String getEmailAddress()
          Gets the current user's return email address.
 EmailType getEmailProtocol()
          Gets the email type for the user: 'Internet Mail' or 'MAPI Mail'.
 boolean getEnableUserToModifyViewSettingsFlag()
          Gets the flag that when set to true allows the user to change his or her personal view settings in P6 Web Access.
static java.lang.String[] getFilterableFields()
          Gets all fields that can be filtered.
 ObjectId getFinancialPeriodEndObjectId()
          Gets the unique ID generated by the system of the last financial period viewable in columns in Project Management.
 ObjectId getFinancialPeriodStartObjectId()
          Gets the unique ID generated by the system of the first financial period viewable in columns in Project Management.
 ObjectId getGlobalProfileObjectId()
          Gets the unique ID of the global security profile assigned to the user.
 java.lang.String getGUID()
          Gets the globally unique ID generated by the system.
static java.lang.String[] getInternalAllFields()
          An internal method that should not be called directly by client code.
static java.util.Set<java.lang.String> getInternalAllFieldsSet()
          An internal method that should not be called directly by client code.
static java.lang.String[] getInternalDefaultLoadFields()
          An internal method that should not be called directly by client code.
 java.util.Date getLastUpdateDate()
          Gets the date this user was last updated.
 java.lang.String getLastUpdateUser()
          Gets the name of the user that last updated this user.
 java.lang.String getMailServerLoginName()
          Gets the mail login name (profile name) for the current user to send outgoing email.
static java.lang.String[] getMinimumXMLExportFields()
          Gets all fields that are always exported at a minimum by the new flat XML exporter
 java.lang.String getName()
          Gets the user's login name.
 DurationType getNewProjectDurationType()
          Gets the default duration type assigned to new activities.
 ObjectId getObjectId()
          Gets the unique ID generated by the system.
 java.lang.String getOfficePhone()
          Gets the work phone number of the user.
 java.lang.String getOutgoingMailServer()
          Gets the outgoing mail server (SMTP) address used to send outgoing email for this user.
 java.lang.String getPersonalName()
          Gets the user's personal or actual name.
 ObjectId getPrimaryBaselineProject(ObjectId projectId)
          Gets the user's primary BaselineProject for the specified project.
 RateSourcePreference 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.
 boolean getReportingFlag()
          Gets the flag that determines whether the user can access the ODS database.
static java.lang.String[] getRequiredCreateFields()
          Gets all fields that must be set before calling create() on this business object.
 com.primavera.integration.common.value.ResourceRequest[] getResourceRequests()
          Gets the resource requests used as search templates to search for qualified resources.
 boolean 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.
 RoleLimitDisplayOption getRoleLimitDisplayOption()
          Gets the option for how RoleLimit is displayed.
 ObjectId getSecondaryBaselineProject(ObjectId projectId)
          Gets the user's secondary BaselineProject for the specified project.
 ObjectId getTertiaryBaselineProject(ObjectId projectId)
          Gets the user's tertiary BaselineProject for the specified project.
 ObjectId getUserInterfaceViewObjectId()
          Gets the unique ID of the associated user interface view.
static java.lang.String[] getWritableFields()
          Gets all writable fields for this business object.
static User load(Session session, java.lang.String[] fields, ObjectId objId)
          Loads a single User object from the database.
static BOIterator<User> load(Session session, java.lang.String[] fields, ObjectId[] objIds)
          Loads multiple User objects from the database.
 Currency loadCurrency(java.lang.String[] fields)
          Loads an associated Currency object from the database.
 GlobalProfile loadGlobalProfile(java.lang.String[] fields)
          Loads an associated GlobalProfile object from the database.
 BOIterator<Initiation> loadInitiations(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated Initiation objects from the database.
 BOIterator<ProjectCodeUser> loadProjectCodeUsers(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ProjectCodeUser objects from the database.
 BOIterator<ProjectPortfolio> loadProjectPortfolios(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ProjectPortfolio objects from the database.
 Resource loadResource(java.lang.String[] fields)
          Loads an associated Resource object from the database.
 ResourceAccess loadResourceAccess(java.lang.String[] fields)
          Loads an associated ResourceAccess object from the database.
 BOIterator<ResourceTeam> loadResourceTeams(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ResourceTeam objects from the database.
 BOIterator<RoleTeam> loadRoleTeams(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated RoleTeam objects from the database.
 BOIterator<UserLicense> loadUserLicenses(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated UserLicense objects from the database.
 BOIterator<UserOBS> loadUserOBS(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated UserOBS objects from the database.
 void setAllResourceAccessFlag(boolean b)
          Sets the flag that determines whether the user has all resource access (TRUE) or restricted resource access (FALSE).
 void setAssignmentStaffingPreference(AssignmentStaffingPreference enm)
          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.
 void setCurrencyObjectId(ObjectId o)
          Sets the unique ID of the associated currency.
 void setEmailAddress(java.lang.String s)
          Sets the current user's return email address.
 void setEmailProtocol(EmailType enm)
          Sets the email type for the user: 'Internet Mail' or 'MAPI Mail'.
 void setEnableUserToModifyViewSettingsFlag(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.
 void setFinancialPeriodEndObjectId(ObjectId o)
          Sets the unique ID generated by the system of the last financial period viewable in columns in Project Management.
 void setFinancialPeriodStartObjectId(ObjectId o)
          Sets the unique ID generated by the system of the first financial period viewable in columns in Project Management.
 void setGlobalProfileObjectId(ObjectId o)
          Sets the unique ID of the global security profile assigned to the user.
 void setGUID(java.lang.String s)
          Sets the globally unique ID generated by the system.
 void setMailServerLoginName(java.lang.String s)
          Sets the mail login name (profile name) for the current user to send outgoing email.
 void setMailServerPassword(java.lang.String sNewPassword)
          Sets e-mail server password.
 void setName(java.lang.String s)
          Sets the user's login name.
 void setNewProjectDurationType(DurationType enm)
          Sets the default duration type assigned to new activities.
 void setObjectId(ObjectId o)
          Sets the unique ID generated by the system.
 void setOfficePhone(java.lang.String s)
          Sets the work phone number of the user.
 void setOutgoingMailServer(java.lang.String s)
          Sets the outgoing mail server (SMTP) address used to send outgoing email for this user.
 void setPassword(java.lang.String sOldPassword, java.lang.String sNewPassword)
          Sets user password for the non-admin user; must specify old password.
 void setPersonalName(java.lang.String s)
          Sets the user's personal or actual name.
 void setPrimaryBaselineProject(ObjectId projectId, ObjectId baselineProjectId)
          Sets the value of the user's primary BaselineProject for a specific project.
 void setRateSourcePreference(RateSourcePreference enm)
          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.
 void setReportingFlag(boolean b)
          Sets the flag that determines whether the user can access the ODS database.
 void setResourceRequests(com.primavera.integration.common.value.ResourceRequest[] r)
          Sets the resource requests used as search templates to search for qualified resources.
 void setRespectActivityDurationType(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.
 void setRoleLimitDisplayOption(RoleLimitDisplayOption enm)
          Sets the option for how RoleLimit is displayed.
 void setSecondaryBaselineProject(ObjectId projectId, ObjectId baselineProjectId)
          Sets the value of the user's secondary BaselineProject for a specific project.
 void setTertiaryBaselineProject(ObjectId projectId, ObjectId baselineProjectId)
          Sets the value of the user's primary baseline for a specific project.
 void setUserInterfaceViewObjectId(ObjectId o)
          Sets the unique ID of the associated user interface view.
 java.lang.String toString()
          Returns a string representation of the object.
 void update()
          Updates this User object in the database.
static void update(Session session, User[] users)
          Updates multiple User objects in the database.
 void updateProjectPortfolios(ProjectPortfolio[] projectportfolios)
          Updates multiple associated ProjectPortfolio objects in the database.
 void updateResourceTeams(ResourceTeam[] resourceteams)
          Updates multiple associated ResourceTeam objects in the database.
 void updateRoleTeams(RoleTeam[] roleteams)
          Updates multiple associated RoleTeam objects in the database.
 void updateUserLicenses(UserLicense[] userlicenses)
          Updates multiple associated UserLicense objects in the database.
 void updateUserOBS(UserOBS[] userobs)
          Updates multiple associated UserOBS objects in the database.
 
Methods inherited from class com.primavera.integration.client.bo.BusinessObject
equals, hashCode, isNull, setNull
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

User

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

Parameters:
session - the Session

User

public User(Session session,
            ObjectId objId)
     throws BusinessObjectException
Class constructor specifying the Session and ObjectId of the object. This constructor is most commonly used when update() will be called on this object.

Parameters:
session - the Session
objId - the ObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

User

public User(Session session,
            com.primavera.infr.db.PrmRowSet rowSet,
            int iIndex)
     throws BusinessObjectException
Class constructor called internally after objects are retrieved from the server. Client code should use one of the other constructors for this class.

Parameters:
session - the Session
rowSet - the PrmRowSet retrieved from the server
iIndex - the row index in the PrmRowSet associated with this business object
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects
Method Detail

create

public ObjectId create()
                throws ServerException,
                       NetworkException,
                       BusinessObjectException
Creates this User object in the database.

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

create

public static ObjectId[] create(Session session,
                                User[] users)
                         throws ServerException,
                                NetworkException,
                                BusinessObjectException
Creates multiple User objects in the database.

Parameters:
session - the Session object
users - array of User objects to create
Returns:
ObjectId[] the array of unique IDs of newly created User objects
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

load

public static User load(Session session,
                        java.lang.String[] fields,
                        ObjectId objId)
                 throws ServerException,
                        NetworkException,
                        BusinessObjectException
Loads a single User object from the database.

Parameters:
session - the Session object
fields - fields to load
objId - unique ID of the User object
Returns:
User the User object
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

load

public static BOIterator<User> load(Session session,
                                    java.lang.String[] fields,
                                    ObjectId[] objIds)
                             throws ServerException,
                                    NetworkException,
                                    BusinessObjectException
Loads multiple User objects from the database.

Parameters:
session - the Session object
fields - fields to load
objIds - object ids of the User objects
Returns:
BOIterator a business object iterator used to get the results of the load request
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

update

public void update()
            throws ServerException,
                   NetworkException,
                   BusinessObjectException
Updates this User object in the database.

Overrides:
update in class BOBase
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

update

public static void update(Session session,
                          User[] users)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Updates multiple User objects in the database.

Parameters:
session - the Session object
users - array of User objects to update
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

delete

public void delete()
            throws ServerException,
                   NetworkException,
                   BusinessObjectException
Deletes this User object from the database.

Overrides:
delete in class BOBase
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

delete

public static void delete(Session session,
                          User[] users)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Deletes multiple User objects from the database.

Parameters:
session - the Session object
users - array of User objects to delete
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

createUserOBS

public ObjectId createUserOBS(UserOBS userobs)
                       throws ServerException,
                              NetworkException,
                              BusinessObjectException
Creates an associated UserOBS object in the database.

Parameters:
userobs - UserOBS object to create
Returns:
ObjectId unique ID of the newly created UserOBS object
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

createUserOBS

public ObjectId[] createUserOBS(UserOBS[] userobs)
                         throws ServerException,
                                NetworkException,
                                BusinessObjectException
Creates multiple associated UserOBS objects in the database.

Parameters:
userobs - array of UserOBS objects to create
Returns:
ObjectId[] array of object ids of newly created UserOBS objects
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

loadUserOBS

public BOIterator<UserOBS> loadUserOBS(java.lang.String[] fields,
                                       java.lang.String sWhereClause,
                                       java.lang.String sOrderBy)
                                throws ServerException,
                                       NetworkException,
                                       BusinessObjectException
Loads multiple associated UserOBS objects from the database.

Parameters:
fields - fields to load
sWhereClause - where clause
sOrderBy - order-by clause
Returns:
BOIterator a business object iterator used to get the results of the load request
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

updateUserOBS

public void updateUserOBS(UserOBS[] userobs)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Updates multiple associated UserOBS objects in the database.

Parameters:
userobs - array of UserOBS objects to update
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

deleteUserOBS

public void deleteUserOBS(UserOBS[] userobs)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Deletes multiple associated UserOBS objects from the database.

Parameters:
userobs - array of UserOBS objects to delete
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

createUserLicense

public ObjectId createUserLicense(UserLicense userlicense)
                           throws ServerException,
                                  NetworkException,
                                  BusinessObjectException
Creates an associated UserLicense object in the database.

Parameters:
userlicense - UserLicense object to create
Returns:
ObjectId unique ID of the newly created UserLicense object
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

createUserLicenses

public ObjectId[] createUserLicenses(UserLicense[] userlicenses)
                              throws ServerException,
                                     NetworkException,
                                     BusinessObjectException
Creates multiple associated UserLicense objects in the database.

Parameters:
userlicenses - array of UserLicense objects to create
Returns:
ObjectId[] array of object ids of newly created UserLicense objects
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

loadUserLicenses

public BOIterator<UserLicense> loadUserLicenses(java.lang.String[] fields,
                                                java.lang.String sWhereClause,
                                                java.lang.String sOrderBy)
                                         throws ServerException,
                                                NetworkException,
                                                BusinessObjectException
Loads multiple associated UserLicense objects from the database.

Parameters:
fields - fields to load
sWhereClause - where clause
sOrderBy - order-by clause
Returns:
BOIterator a business object iterator used to get the results of the load request
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

updateUserLicenses

public void updateUserLicenses(UserLicense[] userlicenses)
                        throws ServerException,
                               NetworkException,
                               BusinessObjectException
Updates multiple associated UserLicense objects in the database.

Parameters:
userlicenses - array of UserLicense objects to update
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

deleteUserLicenses

public void deleteUserLicenses(UserLicense[] userlicenses)
                        throws ServerException,
                               NetworkException,
                               BusinessObjectException
Deletes multiple associated UserLicense objects from the database.

Parameters:
userlicenses - array of UserLicense objects to delete
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

loadCurrency

public Currency loadCurrency(java.lang.String[] fields)
                      throws ServerException,
                             NetworkException,
                             BusinessObjectException
Loads an associated Currency object from the database.

Parameters:
fields - fields to load
Returns:
Currency the Currency object
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

loadResource

public Resource loadResource(java.lang.String[] fields)
                      throws ServerException,
                             NetworkException,
                             BusinessObjectException
Loads an associated Resource object from the database.

Parameters:
fields - fields to load
Returns:
Resource the Resource object
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

loadResourceAccess

public ResourceAccess loadResourceAccess(java.lang.String[] fields)
                                  throws ServerException,
                                         NetworkException,
                                         BusinessObjectException
Loads an associated ResourceAccess object from the database.

Parameters:
fields - fields to load
Returns:
ResourceAccess the ResourceAccess object
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

loadGlobalProfile

public GlobalProfile loadGlobalProfile(java.lang.String[] fields)
                                throws ServerException,
                                       NetworkException,
                                       BusinessObjectException
Loads an associated GlobalProfile object from the database.

Parameters:
fields - fields to load
Returns:
GlobalProfile the GlobalProfile object
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

createProjectPortfolio

public ObjectId createProjectPortfolio(ProjectPortfolio projectportfolio)
                                throws ServerException,
                                       NetworkException,
                                       BusinessObjectException
Creates an associated ProjectPortfolio object in the database.

Parameters:
projectportfolio - ProjectPortfolio object to create
Returns:
ObjectId unique ID of the newly created ProjectPortfolio object
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

createProjectPortfolios

public ObjectId[] createProjectPortfolios(ProjectPortfolio[] projectportfolios)
                                   throws ServerException,
                                          NetworkException,
                                          BusinessObjectException
Creates multiple associated ProjectPortfolio objects in the database.

Parameters:
projectportfolios - array of ProjectPortfolio objects to create
Returns:
ObjectId[] array of object ids of newly created ProjectPortfolio objects
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

loadProjectPortfolios

public BOIterator<ProjectPortfolio> loadProjectPortfolios(java.lang.String[] fields,
                                                          java.lang.String sWhereClause,
                                                          java.lang.String sOrderBy)
                                                   throws ServerException,
                                                          NetworkException,
                                                          BusinessObjectException
Loads multiple associated ProjectPortfolio objects from the database.

Parameters:
fields - fields to load
sWhereClause - where clause
sOrderBy - order-by clause
Returns:
BOIterator a business object iterator used to get the results of the load request
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

updateProjectPortfolios

public void updateProjectPortfolios(ProjectPortfolio[] projectportfolios)
                             throws ServerException,
                                    NetworkException,
                                    BusinessObjectException
Updates multiple associated ProjectPortfolio objects in the database.

Parameters:
projectportfolios - array of ProjectPortfolio objects to update
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

deleteProjectPortfolios

public void deleteProjectPortfolios(ProjectPortfolio[] projectportfolios)
                             throws ServerException,
                                    NetworkException,
                                    BusinessObjectException
Deletes multiple associated ProjectPortfolio objects from the database.

Parameters:
projectportfolios - array of ProjectPortfolio objects to delete
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

createResourceTeam

public ObjectId createResourceTeam(ResourceTeam resourceteam)
                            throws ServerException,
                                   NetworkException,
                                   BusinessObjectException
Creates an associated ResourceTeam object in the database.

Parameters:
resourceteam - ResourceTeam object to create
Returns:
ObjectId unique ID of the newly created ResourceTeam object
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

createResourceTeams

public ObjectId[] createResourceTeams(ResourceTeam[] resourceteams)
                               throws ServerException,
                                      NetworkException,
                                      BusinessObjectException
Creates multiple associated ResourceTeam objects in the database.

Parameters:
resourceteams - array of ResourceTeam objects to create
Returns:
ObjectId[] array of object ids of newly created ResourceTeam objects
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

loadResourceTeams

public BOIterator<ResourceTeam> loadResourceTeams(java.lang.String[] fields,
                                                  java.lang.String sWhereClause,
                                                  java.lang.String sOrderBy)
                                           throws ServerException,
                                                  NetworkException,
                                                  BusinessObjectException
Loads multiple associated ResourceTeam objects from the database.

Parameters:
fields - fields to load
sWhereClause - where clause
sOrderBy - order-by clause
Returns:
BOIterator a business object iterator used to get the results of the load request
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

updateResourceTeams

public void updateResourceTeams(ResourceTeam[] resourceteams)
                         throws ServerException,
                                NetworkException,
                                BusinessObjectException
Updates multiple associated ResourceTeam objects in the database.

Parameters:
resourceteams - array of ResourceTeam objects to update
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

deleteResourceTeams

public void deleteResourceTeams(ResourceTeam[] resourceteams)
                         throws ServerException,
                                NetworkException,
                                BusinessObjectException
Deletes multiple associated ResourceTeam objects from the database.

Parameters:
resourceteams - array of ResourceTeam objects to delete
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

createRoleTeam

public ObjectId createRoleTeam(RoleTeam roleteam)
                        throws ServerException,
                               NetworkException,
                               BusinessObjectException
Creates an associated RoleTeam object in the database.

Parameters:
roleteam - RoleTeam object to create
Returns:
ObjectId unique ID of the newly created RoleTeam object
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

createRoleTeams

public ObjectId[] createRoleTeams(RoleTeam[] roleteams)
                           throws ServerException,
                                  NetworkException,
                                  BusinessObjectException
Creates multiple associated RoleTeam objects in the database.

Parameters:
roleteams - array of RoleTeam objects to create
Returns:
ObjectId[] array of object ids of newly created RoleTeam objects
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

loadRoleTeams

public BOIterator<RoleTeam> loadRoleTeams(java.lang.String[] fields,
                                          java.lang.String sWhereClause,
                                          java.lang.String sOrderBy)
                                   throws ServerException,
                                          NetworkException,
                                          BusinessObjectException
Loads multiple associated RoleTeam objects from the database.

Parameters:
fields - fields to load
sWhereClause - where clause
sOrderBy - order-by clause
Returns:
BOIterator a business object iterator used to get the results of the load request
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

updateRoleTeams

public void updateRoleTeams(RoleTeam[] roleteams)
                     throws ServerException,
                            NetworkException,
                            BusinessObjectException
Updates multiple associated RoleTeam objects in the database.

Parameters:
roleteams - array of RoleTeam objects to update
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

deleteRoleTeams

public void deleteRoleTeams(RoleTeam[] roleteams)
                     throws ServerException,
                            NetworkException,
                            BusinessObjectException
Deletes multiple associated RoleTeam objects from the database.

Parameters:
roleteams - array of RoleTeam objects to delete
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

loadInitiations

public BOIterator<Initiation> loadInitiations(java.lang.String[] fields,
                                              java.lang.String sWhereClause,
                                              java.lang.String sOrderBy)
                                       throws ServerException,
                                              NetworkException,
                                              BusinessObjectException
Loads multiple associated Initiation objects from the database.

Parameters:
fields - fields to load
sWhereClause - where clause
sOrderBy - order-by clause
Returns:
BOIterator a business object iterator used to get the results of the load request
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

loadProjectCodeUsers

public BOIterator<ProjectCodeUser> loadProjectCodeUsers(java.lang.String[] fields,
                                                        java.lang.String sWhereClause,
                                                        java.lang.String sOrderBy)
                                                 throws ServerException,
                                                        NetworkException,
                                                        BusinessObjectException
Loads multiple associated ProjectCodeUser objects from the database.

Parameters:
fields - fields to load
sWhereClause - where clause
sOrderBy - order-by clause
Returns:
BOIterator a business object iterator used to get the results of the load request
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

setPassword

public void setPassword(java.lang.String sOldPassword,
                        java.lang.String sNewPassword)
                 throws BusinessObjectException
Sets user password for the non-admin user; must specify old password.

Overrides:
setPassword in class com.primavera.integration.client.bo.base.UserBase
Parameters:
sOldPassword - the old password. sOldPassword may be null for admin superuser
sNewPassword - the new password
Throws:
BusinessObjectException - if the password change failed

setMailServerPassword

public void setMailServerPassword(java.lang.String sNewPassword)
                           throws BusinessObjectException
Sets e-mail server password.

Overrides:
setMailServerPassword in class com.primavera.integration.client.bo.base.UserBase
Parameters:
sNewPassword - the new password for email server
Throws:
BusinessObjectException - if the password change failed

getPrimaryBaselineProject

public ObjectId getPrimaryBaselineProject(ObjectId projectId)
                                   throws BusinessObjectException
Gets the user's primary BaselineProject for the specified project. Note that the PrimaryBaselines field must be loaded to get the data.

Overrides:
getPrimaryBaselineProject in class com.primavera.integration.client.bo.base.UserBase
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.

Overrides:
setPrimaryBaselineProject in class com.primavera.integration.client.bo.base.UserBase
Parameters:
projectId - the unique identifier for the project
baselineProjectId - the unique identifier for the BaselineProject
Throws:
BusinessObjectException - if the value cannot be set

getSecondaryBaselineProject

public ObjectId getSecondaryBaselineProject(ObjectId projectId)
                                     throws BusinessObjectException
Gets the user's secondary BaselineProject for the specified project. Note that the SecondaryBaselines field must be loaded to get the data.

Overrides:
getSecondaryBaselineProject in class com.primavera.integration.client.bo.base.UserBase
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.

Overrides:
setSecondaryBaselineProject in class com.primavera.integration.client.bo.base.UserBase
Parameters:
projectId - the unique identifier for the project
baselineProjectId - the unique identifier for the BaselineProject
Throws:
BusinessObjectException - if the value cannot be set

getTertiaryBaselineProject

public ObjectId getTertiaryBaselineProject(ObjectId projectId)
                                    throws BusinessObjectException
Gets the user's tertiary BaselineProject for the specified project. Note that the TertiaryBaselines field must be loaded to get the data.

Overrides:
getTertiaryBaselineProject in class com.primavera.integration.client.bo.base.UserBase
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.

Overrides:
setTertiaryBaselineProject in class com.primavera.integration.client.bo.base.UserBase
Parameters:
projectId - the unique identifier for the project
baselineProjectId - the unique identifier for the BaselineProject
Throws:
BusinessObjectException - if the value cannot be set

getEnableUserToModifyViewSettingsFlag

public boolean getEnableUserToModifyViewSettingsFlag()
                                              throws BusinessObjectException
Gets the flag that when set to true allows the user to change his or her personal view settings in P6 Web Access. When a user changes the user interface view settings, the changes do not affect the settings of other users assigned to the same view.

Returns:
the value in the field EnableUserToModifyViewSettingsFlag
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setEnableUserToModifyViewSettingsFlag

public void setEnableUserToModifyViewSettingsFlag(boolean b)
                                           throws BusinessObjectException
Sets the flag that when set to true allows the user to change his or her personal view settings in P6 Web Access. When a user changes the user interface view settings, the changes do not affect the settings of other users assigned to the same view.

Parameters:
b - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getObjectId

public ObjectId getObjectId()
                     throws BusinessObjectException
Gets the unique ID generated by the system.

Overrides:
getObjectId in class BusinessObject
Returns:
the value in the field ObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setObjectId

public void setObjectId(ObjectId o)
                 throws BusinessObjectException
Sets the unique ID generated by the system.

Overrides:
setObjectId in class BusinessObject
Parameters:
o - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getEmailProtocol

public EmailType getEmailProtocol()
                           throws BusinessObjectException
Gets the email type for the user: 'Internet Mail' or 'MAPI Mail'.

Returns:
the value in the field EmailProtocol
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setEmailProtocol

public void setEmailProtocol(EmailType enm)
                      throws BusinessObjectException
Sets the email type for the user: 'Internet Mail' or 'MAPI Mail'.

Parameters:
enm - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getName

public java.lang.String getName()
                         throws BusinessObjectException
Gets the user's login name. This field is automatically loaded by default whenever this type of business object is loaded from the database. This field must contain a valid value in order to create this type of business object in the database.

Returns:
the value in the field Name
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setName

public void setName(java.lang.String s)
             throws BusinessObjectException
Sets the user's login name. This field is automatically loaded by default whenever this type of business object is loaded from the database. This field must contain a valid value in order to create this type of business object in the database.

Parameters:
s - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getGlobalProfileObjectId

public ObjectId getGlobalProfileObjectId()
                                  throws BusinessObjectException
Gets the unique ID of the global security profile assigned to the user. See the GlobalProfile class for constants defining the fixed profiles of Admin Superuser and No Global Privileges. This field is automatically loaded by default whenever this type of business object is loaded from the database.

Returns:
the value in the field GlobalProfileObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setGlobalProfileObjectId

public void setGlobalProfileObjectId(ObjectId o)
                              throws BusinessObjectException
Sets the unique ID of the global security profile assigned to the user. See the GlobalProfile class for constants defining the fixed profiles of Admin Superuser and No Global Privileges. This field is automatically loaded by default whenever this type of business object is loaded from the database.

Parameters:
o - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getMailServerLoginName

public java.lang.String getMailServerLoginName()
                                        throws BusinessObjectException
Gets the mail login name (profile name) for the current user to send outgoing email. If the email protocol is MAPI, this field should contain the MAPI profile name (e.g. "Microsoft Mail Settings"). This field is not required for Internet email users.

Returns:
the value in the field MailServerLoginName
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setMailServerLoginName

public void setMailServerLoginName(java.lang.String s)
                            throws BusinessObjectException
Sets the mail login name (profile name) for the current user to send outgoing email. If the email protocol is MAPI, this field should contain the MAPI profile name (e.g. "Microsoft Mail Settings"). This field is not required for Internet email users.

Parameters:
s - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getOfficePhone

public java.lang.String getOfficePhone()
                                throws BusinessObjectException
Gets the work phone number of the user.

Returns:
the value in the field OfficePhone
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setOfficePhone

public void setOfficePhone(java.lang.String s)
                    throws BusinessObjectException
Sets the work phone number of the user.

Parameters:
s - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getPersonalName

public java.lang.String getPersonalName()
                                 throws BusinessObjectException
Gets the user's personal or actual name.

Returns:
the value in the field PersonalName
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setPersonalName

public void setPersonalName(java.lang.String s)
                     throws BusinessObjectException
Sets the user's personal or actual name.

Parameters:
s - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getOutgoingMailServer

public java.lang.String getOutgoingMailServer()
                                       throws BusinessObjectException
Gets the outgoing mail server (SMTP) address used to send outgoing email for this user. The address may be a host name or an IP address. This field is used only with the Internet email protocol, and is not required for MAPI. Example: "smtp.yourdomain.com".

Returns:
the value in the field OutgoingMailServer
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setOutgoingMailServer

public void setOutgoingMailServer(java.lang.String s)
                           throws BusinessObjectException
Sets the outgoing mail server (SMTP) address used to send outgoing email for this user. The address may be a host name or an IP address. This field is used only with the Internet email protocol, and is not required for MAPI. Example: "smtp.yourdomain.com".

Parameters:
s - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getEmailAddress

public java.lang.String getEmailAddress()
                                 throws BusinessObjectException
Gets the current user's return email address. This will be used in the "FROM" line for any email sent by this user. Example: "yourname@yourdomain.com". For MAPI users, this may just be the MAPI profile name or mailbox name.

Returns:
the value in the field EmailAddress
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setEmailAddress

public void setEmailAddress(java.lang.String s)
                     throws BusinessObjectException
Sets the current user's return email address. This will be used in the "FROM" line for any email sent by this user. Example: "yourname@yourdomain.com". For MAPI users, this may just be the MAPI profile name or mailbox name.

Parameters:
s - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getCurrencyObjectId

public ObjectId getCurrencyObjectId()
                             throws BusinessObjectException
Gets the unique ID of the associated currency. This field is automatically loaded by default whenever this type of business object is loaded from the database.

Returns:
the value in the field CurrencyObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setCurrencyObjectId

public void setCurrencyObjectId(ObjectId o)
                         throws BusinessObjectException
Sets the unique ID of the associated currency. This field is automatically loaded by default whenever this type of business object is loaded from the database.

Parameters:
o - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getUserInterfaceViewObjectId

public ObjectId getUserInterfaceViewObjectId()
                                      throws BusinessObjectException
Gets the unique ID of the associated user interface view.

Returns:
the value in the field UserInterfaceViewObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setUserInterfaceViewObjectId

public void setUserInterfaceViewObjectId(ObjectId o)
                                  throws BusinessObjectException
Sets the unique ID of the associated user interface view.

Parameters:
o - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getGUID

public java.lang.String getGUID()
                         throws BusinessObjectException
Gets the globally unique ID generated by the system.

Returns:
the value in the field GUID
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setGUID

public void setGUID(java.lang.String s)
             throws BusinessObjectException
Sets the globally unique ID generated by the system.

Parameters:
s - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getCurrencyName

public java.lang.String getCurrencyName()
                                 throws BusinessObjectException
Gets the name of the currency associated with this user.

Returns:
the value in the field CurrencyName
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getCurrencyId

public java.lang.String getCurrencyId()
                               throws BusinessObjectException
Gets the unique currency abbreviation for the currency associated with this user.

Returns:
the value in the field CurrencyId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getAllResourceAccessFlag

public boolean getAllResourceAccessFlag()
                                 throws BusinessObjectException
Gets the flag that determines whether the user has all resource access (TRUE) or restricted resource access (FALSE). Admin Superusers always have all resource access.

Returns:
the value in the field AllResourceAccessFlag
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setAllResourceAccessFlag

public void setAllResourceAccessFlag(boolean b)
                              throws BusinessObjectException
Sets the flag that determines whether the user has all resource access (TRUE) or restricted resource access (FALSE). Admin Superusers always have all resource access.

Parameters:
b - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getRespectActivityDurationType

public boolean getRespectActivityDurationType()
                                       throws BusinessObjectException
Gets the setting that indicates whether to recalculate the Duration, Units, or Units/Time for existing assignments based on the activity Duration Type (true) or to preserve the Duration, Units, or Units/Time for existing assignments (false) when adding or removing assignments on activities. This field may not be included in the where clause or order by clause specified when loading business objects.

Returns:
the value in the field RespectActivityDurationType
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setRespectActivityDurationType

public void setRespectActivityDurationType(boolean b)
                                    throws BusinessObjectException
Sets the setting that indicates whether to recalculate the Duration, Units, or Units/Time for existing assignments based on the activity Duration Type (true) or to preserve the Duration, Units, or Units/Time for existing assignments (false) when adding or removing assignments on activities. This field may not be included in the where clause or order by clause specified when loading business objects.

Parameters:
b - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getRateSourcePreference

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

Returns:
the value in the field RateSourcePreference
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setRateSourcePreference

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

Parameters:
enm - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getAssignmentStaffingPreference

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

Returns:
the value in the field AssignmentStaffingPreference
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setAssignmentStaffingPreference

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

Parameters:
enm - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getNewProjectDurationType

public DurationType getNewProjectDurationType()
                                       throws BusinessObjectException
Gets the default duration type assigned to new activities. Valid values are 'Fixed Units/Time', 'Fixed Duration and Units/Time', 'Fixed Units', or 'Fixed Duration and Units'. This field may not be included in the where clause or order by clause specified when loading business objects.

Returns:
the value in the field NewProjectDurationType
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setNewProjectDurationType

public void setNewProjectDurationType(DurationType enm)
                               throws BusinessObjectException
Sets the default duration type assigned to new activities. Valid values are 'Fixed Units/Time', 'Fixed Duration and Units/Time', 'Fixed Units', or 'Fixed Duration and Units'. This field may not be included in the where clause or order by clause specified when loading business objects.

Parameters:
enm - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getFinancialPeriodStartObjectId

public ObjectId getFinancialPeriodStartObjectId()
                                         throws BusinessObjectException
Gets the unique ID generated by the system of the first financial period viewable in columns in Project Management. This field may not be included in the where clause or order by clause specified when loading business objects.

Returns:
the value in the field FinancialPeriodStartObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setFinancialPeriodStartObjectId

public void setFinancialPeriodStartObjectId(ObjectId o)
                                     throws BusinessObjectException
Sets the unique ID generated by the system of the first financial period viewable in columns in Project Management. This field may not be included in the where clause or order by clause specified when loading business objects.

Parameters:
o - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getFinancialPeriodEndObjectId

public ObjectId getFinancialPeriodEndObjectId()
                                       throws BusinessObjectException
Gets the unique ID generated by the system of the last financial period viewable in columns in Project Management. This field may not be included in the where clause or order by clause specified when loading business objects.

Returns:
the value in the field FinancialPeriodEndObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setFinancialPeriodEndObjectId

public void setFinancialPeriodEndObjectId(ObjectId o)
                                   throws BusinessObjectException
Sets the unique ID generated by the system of the last financial period viewable in columns in Project Management. This field may not be included in the where clause or order by clause specified when loading business objects.

Parameters:
o - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getResourceRequests

public com.primavera.integration.common.value.ResourceRequest[] getResourceRequests()
                                                                             throws BusinessObjectException
Gets the resource requests used as search templates to search for qualified resources. This field may not be included in the where clause or order by clause specified when loading business objects.

Returns:
the value in the field ResourceRequests
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setResourceRequests

public void setResourceRequests(com.primavera.integration.common.value.ResourceRequest[] r)
                         throws BusinessObjectException
Sets the resource requests used as search templates to search for qualified resources. This field may not be included in the where clause or order by clause specified when loading business objects.

Parameters:
r - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getRoleLimitDisplayOption

public RoleLimitDisplayOption getRoleLimitDisplayOption()
                                                 throws BusinessObjectException
Gets the option for how RoleLimit is displayed. Valid values are 'Custom', and 'PrimaryRole'. This field may not be included in the where clause or order by clause specified when loading business objects.

Returns:
the value in the field RoleLimitDisplayOption
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setRoleLimitDisplayOption

public void setRoleLimitDisplayOption(RoleLimitDisplayOption enm)
                               throws BusinessObjectException
Sets the option for how RoleLimit is displayed. Valid values are 'Custom', and 'PrimaryRole'. This field may not be included in the where clause or order by clause specified when loading business objects.

Parameters:
enm - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getReportingFlag

public boolean getReportingFlag()
                         throws BusinessObjectException
Gets the flag that determines whether the user can access the ODS database.

Returns:
the value in the field ReportingFlag
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setReportingFlag

public void setReportingFlag(boolean b)
                      throws BusinessObjectException
Sets the flag that determines whether the user can access the ODS database.

Parameters:
b - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getCreateDate

public java.util.Date getCreateDate()
                             throws BusinessObjectException
Gets the date this user was created.

Returns:
the value in the field CreateDate
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getLastUpdateDate

public java.util.Date getLastUpdateDate()
                                 throws BusinessObjectException
Gets the date this user was last updated.

Returns:
the value in the field LastUpdateDate
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getCreateUser

public java.lang.String getCreateUser()
                               throws BusinessObjectException
Gets the name of the user that created this user.

Returns:
the value in the field CreateUser
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getLastUpdateUser

public java.lang.String getLastUpdateUser()
                                   throws BusinessObjectException
Gets the name of the user that last updated this user.

Returns:
the value in the field LastUpdateUser
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getRequiredCreateFields

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

Returns:
String[] an array of required create fields

getFilterableFields

public static java.lang.String[] getFilterableFields()
Gets all fields that can be filtered.

Returns:
String[] an array of filterable fields

getInternalDefaultLoadFields

public static java.lang.String[] getInternalDefaultLoadFields()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getAllFields

public static java.lang.String[] getAllFields()
Gets all fields for this business object.

Returns:
String[] an array of all fields

getInternalAllFields

public static java.lang.String[] getInternalAllFields()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getInternalAllFieldsSet

public static java.util.Set<java.lang.String> getInternalAllFieldsSet()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getWritableFields

public static java.lang.String[] getWritableFields()
Gets all writable fields for this business object.

Returns:
String[] an array of writable fields

getDefaultXMLExportFields

public static java.lang.String[] getDefaultXMLExportFields()
Gets the fields that are exported by the XML exporter when no fields are specified.

Returns:
String[] an array of field names

getMinimumXMLExportFields

public static java.lang.String[] getMinimumXMLExportFields()
Gets all fields that are always exported at a minimum by the new flat XML exporter

Returns:
String[] an array of exported fields

toString

public java.lang.String toString()
Returns a string representation of the object. The output is in XML.

Overrides:
toString in class java.lang.Object
Returns:
String a string representation of the object.

Primavera Integration API 7.0

Copyright © 2003, 2009, Oracle and/or its affiliates. All rights reserved.