Package com.primavera.integration.client.bo.object

Class GlobalPreferences

java.lang.Object

com.primavera.integration.client.BOBase

com.primavera.integration.client.bo.BusinessObject

com.primavera.integration.client.bo.object.GlobalPreferences

public class GlobalPreferences
extends BusinessObject

Global preferences are generally established by an administrator. There is only one global preferences object in the database and it cannot be deleted.

See Also: Quick reference of GlobalPreferences fields

Constructor Summary

Constructors

Constructor	Description
GlobalPreferences(Session session)	Class constructor specifying the Session.
GlobalPreferences(Session session, ObjectId objId)	Class constructor specifying the Session and ObjectId of the object.
GlobalPreferences(Session session, com.primavera.infr.db.PrmRowSet rowSet, int iIndex)	Class constructor called internally after objects are retrieved from the server.

Method Summary

Modifier and Type	Method	Description
static String[]	getAllFields()	Gets all fields for this business object.
boolean	getAllowApprovedTSRejection()	Gets the flag indicating whether to reject Approved timesheet or not.
boolean	getAlwaysLaunchOnlineHelp()	Gets the flag that indicates whether the online help should be launched with F1 key.
ObjectId	getBaseCurrencyObjectId()	Gets the unique ID of the currency.
String	getContractManagementURL()	Gets this is the URL of the Contract Management application.
Date	getCreateDate()	Gets the date this global preferences was created.
String	getCreateUser()	Gets the name of the user that created this global preferences.
String	getCustomLabel1()	Gets the custom (user-defined) text that will be inserted into any report containing the Custom Label 1 global variable text cell, when printed.
String	getCustomLabel2()	Gets the custom (user-defined) text that will be inserted into any report containing the Custom Label 2 global variable text cell, when printed.
String	getCustomLabel3()	Gets the custom (user-defined) text that will be inserted into any report containing the Custom Label 3 global variable text cell, when printed.
String	getDayAbbreviation()	Gets the abbreviation character for time periods of days.
Duration	getDefaultDuration()	Gets the planned duration assigned to new activities by default.
ObjectId	getDefaultTimesheetApprovalManager()	Gets the unique ID of the resource manager assigned to approve timesheets for new resources by default.
static String[]	getDefaultXMLExportFields()	Deprecated.
EarnedValueCalculationType	getEarnedValueCalculation()	Gets the flag indicating which values to use when calculating earned value when using a primary baseline.
boolean	getEmailNotifyTSRejection()	Gets the flag indicating whether to send notification through e-mail for PM/RM users and their delegates when a timesheet which they has to take an action gets rejected by other RM/PM manager or their delegate.
boolean	getEnablePasswordPolicy()	Gets the flag that indicates whether the password policy is enforced.
boolean	getEnableTSAudit()	Gets the flag indicating whether to track timesheet submission, approval, and rejection.
boolean	getEnableWebServicesIPCheck()	Gets the flag that indicates whether IP address has to be checked in order to access WebServices.
boolean	getEnableWhatsNewDialog()	Gets the flag that indicates whether the new features dialog is to be shown.
String	getEPPMConsentMessage()	Gets ePPM Consent Message.
String	getEPPMEnableConsent()	Gets ePPM Enable Consent.
double	getEVEstimateToCompleteFactor()	Gets the user-defined performance factor, PF, for computing earned-value estimate-to-complete.
EarnedValueETCComputeType	getEVEstimateToCompleteTechnique()	Gets the technique for computing earned-value estimate-to-complete.
Percent	getEVPerformancePctCompleteCustomPct()	Gets the user-defined percent complete for computing earned value for activities within the WBS.
EarnedValueComputeType	getEVPerformancePctCompleteTechnique()	Gets the technique used for computing earned-value percent complete.
String	getExceptionSiteList()	Gets this is the list of sites that will be allowed to be accessed directly.
static String[]	getFilterableFields()	Gets all fields that can be filtered.
String	getFooterLabel1()	Gets the first footer for reports.
String	getFooterLabel2()	Gets the second footer for reports.
String	getFooterLabel3()	Gets the third footer for reports.
String	getGatewayApiUrl()	Gets this is the URL for Gateway.
String	getGatewayExportERPSyncName()	Gets this is the ERP export Synchronization name for Gateway.
String	getGatewayExportUnifierSyncName()	Gets this is the unifier export Synchronization name for Gateway.
String	getGatewayImportERPSyncName()	Gets this is the ERP import Synchronization name for Gateway.
String	getGatewayImportUnifierSyncName()	Gets this is the unifier import Synchronization name for Gateway.
String	getGatewayP6DeploymentName()	Gets this is the P6 Deployment name in Gateway.
String	getGatewayPassword()	Gets this is the password for Gateway.
boolean	getGatewayUnifierEnabled()	Gets this is the flag to enable Unifier through Gateway.
String	getGatewayUsername()	Gets this is the user name for Gateway.
String	getHeaderLabel1()	Gets the first header for reports.
String	getHeaderLabel2()	Gets the second header for reports.
String	getHeaderLabel3()	Gets the third header for reports.
String	getHourAbbreviation()	Gets the abbreviation character for time periods of hours.
double	getHoursPerDay()	Gets the number of work hours per day.
double	getHoursPerMonth()	Gets the number of work hours per month.
double	getHoursPerWeek()	Gets the number of work hours per week.
double	getHoursPerYear()	Gets the number of work hours per year.
static String[]	getInternalAllFields()	An internal method that should not be called directly by client code.
static Set<String>	getInternalAllFieldsSet()	An internal method that should not be called directly by client code.
static String[]	getInternalDefaultLoadFields()	An internal method that should not be called directly by client code.
String	getIPSiteList()	Gets this is the list of IP Address that will NOT be restricted to access WebServcices.
Date	getLastUpdateDate()	Gets the date this global preferences was last updated.
String	getLastUpdateUser()	Gets the name of the user that last updated this global preferences.
boolean	getLogHoursAfterActualFinish()	Gets the flag that indicates whether timesheet application users are allowed to log timesheet hours on activities for dates after the activities' actual finish dates.
boolean	getLogHoursBeforeActualStart()	Gets the flag that indicates whether timesheet application users are allowed to log timesheet hours on activities for dates prior to the activities' actual start dates.
boolean	getLogHoursCompletedActivities()	Gets the flag that indicates whether timesheet application users are allowed to log timesheet hours on activities that are already marked as completed.
boolean	getLogHoursInFuture()	Gets the flag that indicates whether the user can log hours in the future.
boolean	getLogHoursNotStartedActivities()	Gets the flag that indicates whether timesheet application users are allowed to log timesheet hours on activities that are still marked as Not started.
int	getMaxActivityCodesPerProject()	Gets the maximum number of project-level activity user codes that can be created per project.
int	getMaxActivityCodeTreeLevels()	Gets the maximum number of levels that can be created in activity code hierarchies in the Project Management application.
int	getMaxActivityIdLength()	Gets the maximum number of characters allowed for activity IDs.
int	getMaxAssignmentCodeTreeLevelCnt()	Gets the maximum number of levels in the assignment code hierarchy in the Project Management application.
int	getMaxBaselinesPerProject()	Gets the maximum number of baselines that can be created per project.
int	getMaxCostAccountLength()	Gets the maximum number of characters allowed for cost account IDs (at each level in the cost account tree).
int	getMaxCostAccountTreeLevels()	Gets the maximum number of levels that can be created in the cost account hierarchy in the Project Management application.
int	getMaxFPCalendarCount()	Gets this is the maximum count of Financial Period Calendars that can be created.
int	getMaximumBaselinesCopiedWithProject()	Gets the number of baseline projects that can be copied with a project.
int	getMaxOBSTreeLevels()	Gets the maximum number of levels that can be created in OBS hierarchies in the Project Management application.
int	getMaxProjectCodeTreeLevels()	Gets the maximum number of levels in the project category hierarchy in the Project Management application.
int	getMaxProjectIdLength()	Gets the maximum number characters allowed for project IDs.
int	getMaxResourceCodeTreeLevels()	Gets the maximum number of levels in the resource code hierarchy in the Project Management application.
int	getMaxResourceIdLength()	Gets the maximum number of characters allowed for resource IDs (at each level in the resource tree).
int	getMaxResourceTreeLevels()	Gets the maximum number of levels that can be created in the resource hierarchy.
int	getMaxRoleCodeTreeLevelCnt()	Gets the maximum number of levels in the role code hierarchy in the Project Management application.
int	getMaxRoleIdLength()	Gets the maximum number characters allowed for role IDs.
int	getMaxRoleTreeLevels()	Gets the maximum number of levels in the role hierarchy in the Project Management application.
double	getMaxTimesheetResourceHours()	Gets the maximum hours a resource can enter per day for all of their assigned activities.
int	getMaxWBSCodeLength()	Gets the maximum number of characters allowed for WBS codes (at each level in the WBS tree).
int	getMaxWBSTreeLevels()	Gets the maximum number of levels that can be created in WBS hierarchies.
static String[]	getMinimumXMLExportFields()	Gets all fields that are always exported at a minimum by the new flat XML exporter
String	getMinuteAbbreviation()	Gets the abbreviation character for time periods of minutes.
String	getMonthAbbreviation()	Gets the abbreviation character for time periods of months.
int	getNumberOfAccessibleFutureTimesheets()	Gets the number of future timesheets that timesheet application users are allowed to access.
int	getNumberOfAccessiblePastTimesheets()	Gets the number of past timesheets that can be accessed.
String	getPrivateIPAllowList()	Gets this is the Fixed list of Regional IP Address saved during DB Install that will NOT be restricted to access WebServcices.
boolean	getReportEnableLazyLoad()	Gets the flag that indicates whether the report tab initial should be lazy load or eager load.
boolean	getResourcesCanAssignThemselvesToActivities()	Gets the flag that indicates whether timesheet application users are allowed to assign themselves to activities in this project.
boolean	getResourcesCanAssignThemselvesToActivitiesOutsideTheirOBSAccess()	Gets the flag that indicates whether timesheet application users are allowed to assign themselves to activities outside their OBS Access in this project.
int	getStartDayOfWeek()	Gets the starting day of the week as displayed in all calendars.
boolean	getSummarizeByCalendar()	Gets the flag indicating whether to summarize by calendar .
boolean	getSummarizeByFinancialPeriods()	Gets the flag indicating whether to summarize the EPS, project or WBS by financial periods.
SummarySpreadInterval	getSummaryResourceSpreadInterval()	Gets the interval in which resource and role level spreads are summarized and stored.
SummarySpreadInterval	getSummaryWBSSpreadInterval()	Gets the interval in which WBS level spreads are summarized and stored.
String	getTeamMemberConsentMessage()	Gets teamMember Consent Message.
String	getTeamMemberEnableConsent()	Gets teamMember Enable Consent.
int	getTimesheetApprovalLevel()	Gets the number of approval levels required for timesheets (0, 1, or 2) before timesheets hours are applied to activities as actuals.
int	getTimesheetDecimalDigits()	Gets the number of decimal digits for recording hours in timesheets.
boolean	getTimesheetInterval()	Gets the flag that indicates whether timesheet application users enter timesheet hours daily or by entire timesheet reporting period.
DayOfWeekType	getTimesheetPeriodEndsOnDay()	Gets the end day of time sheet period used in time sheet application.
TimesheetPeriodType	getTimesheetPeriodType()	Gets the time period used in time sheet application.
int	getTimeWindowCompletedActivities()	Gets the time window (days) to access completed activities in the timesheet application, assigned to new resources by default.
int	getTimeWindowNotStartedActivities()	Gets the time window (days) to access not started activities in the timesheet application, assigned to new resources by default.
String	getUnifierAuthCode()	Gets this is the Unifier authentication code.
String	getUnifierCompanyShortName()	Gets this is the Unifier company short name.
String	getUnifierIntegrationPassword()	Gets this is the Unifier Integration user password.
String	getUnifierIntegrationUserName()	Gets this is the Unifier Integration user name.
String	getUnifierWebServiceURL()	Gets this is the URL of Unifier Web Services.
boolean	getUseCalendarTimePeriodsFlag()	Gets the flag that indicates whether the system uses the hours per time period defined in the calendar.If this flag is true, the system uses the hours per time period settings that are defined in the calendar.If this flag is false, the system uses the hours per time period from the global preferences.
boolean	getUseMaxTimesheetResourceHours()	Gets the flag indicating whether to restrict the number of hours a user can enter to the limit specified in MaxTimesheetResourceHours.
String	getUseProjectManagerApproval()	Gets the flag that indicates the approval sequence, if any, required for level 2 timesheet approvals.
boolean	getUseTimesheets()	Gets the flag that indicates whether new resources use timesheets by default.
String	getVersionForWhatsNew()	Gets this field is used in testing to change version for what's new dialog.
String	getWBSCategoryLabel()	Gets the dynamic label used for the WBS category.
String	getWBSCodeSeparator()	Gets the character used for separating code fields for the cost account tree.
String	getWeekAbbreviation()	Gets the abbreviation character for time periods of weeks.
static String[]	getWritableFields()	Gets all writable fields for this business object.
String	getYearAbbreviation()	Gets the abbreviation character for time periods of years.
static GlobalPreferences	load(Session session, String[] fields)	Loads the GlobalPreferences object from the database.
void	setAllowApprovedTSRejection(boolean b)	Sets the flag indicating whether to reject Approved timesheet or not.
void	setAlwaysLaunchOnlineHelp(boolean b)	Sets the flag that indicates whether the online help should be launched with F1 key.
void	setBaseCurrencyObjectId(ObjectId o)	Sets the unique ID of the currency.
void	setContractManagementURL(String s)	Sets this is the URL of the Contract Management application.
void	setCustomLabel1(String s)	Sets the custom (user-defined) text that will be inserted into any report containing the Custom Label 1 global variable text cell, when printed.
void	setCustomLabel2(String s)	Sets the custom (user-defined) text that will be inserted into any report containing the Custom Label 2 global variable text cell, when printed.
void	setCustomLabel3(String s)	Sets the custom (user-defined) text that will be inserted into any report containing the Custom Label 3 global variable text cell, when printed.
void	setDayAbbreviation(String s)	Sets the abbreviation character for time periods of days.
void	setDefaultDuration(Duration d)	Sets the planned duration assigned to new activities by default.
void	setDefaultTimesheetApprovalManager(ObjectId o)	Sets the unique ID of the resource manager assigned to approve timesheets for new resources by default.
void	setEarnedValueCalculation(EarnedValueCalculationType enm)	Sets the flag indicating which values to use when calculating earned value when using a primary baseline.
void	setEmailNotifyTSRejection(boolean b)	Sets the flag indicating whether to send notification through e-mail for PM/RM users and their delegates when a timesheet which they has to take an action gets rejected by other RM/PM manager or their delegate.
void	setEnablePasswordPolicy(boolean b)	Sets the flag that indicates whether the password policy is enforced.
void	setEnableTSAudit(boolean b)	Sets the flag indicating whether to track timesheet submission, approval, and rejection.
void	setEnableWebServicesIPCheck(boolean b)	Sets the flag that indicates whether IP address has to be checked in order to access WebServices.
void	setEnableWhatsNewDialog(boolean b)	Sets the flag that indicates whether the new features dialog is to be shown.
void	setEPPMConsentMessage(String s)	Sets ePPM Consent Message.
void	setEPPMEnableConsent(String s)	Sets ePPM Enable Consent.
void	setEVEstimateToCompleteFactor(double d)	Sets the user-defined performance factor, PF, for computing earned-value estimate-to-complete.
void	setEVEstimateToCompleteTechnique(EarnedValueETCComputeType enm)	Sets the technique for computing earned-value estimate-to-complete.
void	setEVPerformancePctCompleteCustomPct(Percent p)	Sets the user-defined percent complete for computing earned value for activities within the WBS.
void	setEVPerformancePctCompleteTechnique(EarnedValueComputeType enm)	Sets the technique used for computing earned-value percent complete.
void	setExceptionSiteList(String s)	Sets this is the list of sites that will be allowed to be accessed directly.
void	setFooterLabel1(String s)	Sets the first footer for reports.
void	setFooterLabel2(String s)	Sets the second footer for reports.
void	setFooterLabel3(String s)	Sets the third footer for reports.
void	setGatewayApiUrl(String s)	Sets this is the URL for Gateway.
void	setGatewayExportERPSyncName(String s)	Sets this is the ERP export Synchronization name for Gateway.
void	setGatewayExportUnifierSyncName(String s)	Sets this is the unifier export Synchronization name for Gateway.
void	setGatewayImportERPSyncName(String s)	Sets this is the ERP import Synchronization name for Gateway.
void	setGatewayImportUnifierSyncName(String s)	Sets this is the unifier import Synchronization name for Gateway.
void	setGatewayP6DeploymentName(String s)	Sets this is the P6 Deployment name in Gateway.
void	setGatewayPassword(String s)	Sets this is the password for Gateway.
void	setGatewayUnifierEnabled(boolean b)	Sets this is the flag to enable Unifier through Gateway.
void	setGatewayUsername(String s)	Sets this is the user name for Gateway.
void	setHeaderLabel1(String s)	Sets the first header for reports.
void	setHeaderLabel2(String s)	Sets the second header for reports.
void	setHeaderLabel3(String s)	Sets the third header for reports.
void	setHourAbbreviation(String s)	Sets the abbreviation character for time periods of hours.
void	setHoursPerDay(double d)	Sets the number of work hours per day.
void	setHoursPerMonth(double d)	Sets the number of work hours per month.
void	setHoursPerWeek(double d)	Sets the number of work hours per week.
void	setHoursPerYear(double d)	Sets the number of work hours per year.
void	setIPSiteList(String s)	Sets this is the list of IP Address that will NOT be restricted to access WebServcices.
void	setLogHoursAfterActualFinish(boolean b)	Sets the flag that indicates whether timesheet application users are allowed to log timesheet hours on activities for dates after the activities' actual finish dates.
void	setLogHoursBeforeActualStart(boolean b)	Sets the flag that indicates whether timesheet application users are allowed to log timesheet hours on activities for dates prior to the activities' actual start dates.
void	setLogHoursCompletedActivities(boolean b)	Sets the flag that indicates whether timesheet application users are allowed to log timesheet hours on activities that are already marked as completed.
void	setLogHoursInFuture(boolean b)	Sets the flag that indicates whether the user can log hours in the future.
void	setLogHoursNotStartedActivities(boolean b)	Sets the flag that indicates whether timesheet application users are allowed to log timesheet hours on activities that are still marked as Not started.
void	setMaxActivityCodesPerProject(int i)	Sets the maximum number of project-level activity user codes that can be created per project.
void	setMaxActivityCodeTreeLevels(int i)	Sets the maximum number of levels that can be created in activity code hierarchies in the Project Management application.
void	setMaxActivityIdLength(int i)	Sets the maximum number of characters allowed for activity IDs.
void	setMaxAssignmentCodeTreeLevelCnt(int i)	Sets the maximum number of levels in the assignment code hierarchy in the Project Management application.
void	setMaxBaselinesPerProject(int i)	Sets the maximum number of baselines that can be created per project.
void	setMaxCostAccountLength(int i)	Sets the maximum number of characters allowed for cost account IDs (at each level in the cost account tree).
void	setMaxCostAccountTreeLevels(int i)	Sets the maximum number of levels that can be created in the cost account hierarchy in the Project Management application.
void	setMaxFPCalendarCount(int i)	Sets this is the maximum count of Financial Period Calendars that can be created.
void	setMaximumBaselinesCopiedWithProject(int i)	Sets the number of baseline projects that can be copied with a project.
void	setMaxOBSTreeLevels(int i)	Sets the maximum number of levels that can be created in OBS hierarchies in the Project Management application.
void	setMaxProjectCodeTreeLevels(int i)	Sets the maximum number of levels in the project category hierarchy in the Project Management application.
void	setMaxProjectIdLength(int i)	Sets the maximum number characters allowed for project IDs.
void	setMaxResourceCodeTreeLevels(int i)	Sets the maximum number of levels in the resource code hierarchy in the Project Management application.
void	setMaxResourceIdLength(int i)	Sets the maximum number of characters allowed for resource IDs (at each level in the resource tree).
void	setMaxResourceTreeLevels(int i)	Sets the maximum number of levels that can be created in the resource hierarchy.
void	setMaxRoleCodeTreeLevelCnt(int i)	Sets the maximum number of levels in the role code hierarchy in the Project Management application.
void	setMaxRoleIdLength(int i)	Sets the maximum number characters allowed for role IDs.
void	setMaxRoleTreeLevels(int i)	Sets the maximum number of levels in the role hierarchy in the Project Management application.
void	setMaxTimesheetResourceHours(double d)	Sets the maximum hours a resource can enter per day for all of their assigned activities.
void	setMaxWBSCodeLength(int i)	Sets the maximum number of characters allowed for WBS codes (at each level in the WBS tree).
void	setMaxWBSTreeLevels(int i)	Sets the maximum number of levels that can be created in WBS hierarchies.
void	setMinuteAbbreviation(String s)	Sets the abbreviation character for time periods of minutes.
void	setMonthAbbreviation(String s)	Sets the abbreviation character for time periods of months.
void	setNumberOfAccessibleFutureTimesheets(int i)	Sets the number of future timesheets that timesheet application users are allowed to access.
void	setNumberOfAccessiblePastTimesheets(int i)	Sets the number of past timesheets that can be accessed.
void	setPrivateIPAllowList(String s)	Sets this is the Fixed list of Regional IP Address saved during DB Install that will NOT be restricted to access WebServcices.
void	setReportEnableLazyLoad(boolean b)	Sets the flag that indicates whether the report tab initial should be lazy load or eager load.
void	setResourcesCanAssignThemselvesToActivities(boolean b)	Sets the flag that indicates whether timesheet application users are allowed to assign themselves to activities in this project.
void	setResourcesCanAssignThemselvesToActivitiesOutsideTheirOBSAccess(boolean b)	Sets the flag that indicates whether timesheet application users are allowed to assign themselves to activities outside their OBS Access in this project.
void	setStartDayOfWeek(int i)	Sets the starting day of the week as displayed in all calendars.
void	setSummarizeByCalendar(boolean b)	Sets the flag indicating whether to summarize by calendar .
void	setSummarizeByFinancialPeriods(boolean b)	Sets the flag indicating whether to summarize the EPS, project or WBS by financial periods.
void	setSummaryResourceSpreadInterval(SummarySpreadInterval enm)	Sets the interval in which resource and role level spreads are summarized and stored.
void	setSummaryWBSSpreadInterval(SummarySpreadInterval enm)	Sets the interval in which WBS level spreads are summarized and stored.
void	setTeamMemberConsentMessage(String s)	Sets teamMember Consent Message.
void	setTeamMemberEnableConsent(String s)	Sets teamMember Enable Consent.
void	setTimesheetApprovalLevel(int i)	Sets the number of approval levels required for timesheets (0, 1, or 2) before timesheets hours are applied to activities as actuals.
void	setTimesheetDecimalDigits(int i)	Sets the number of decimal digits for recording hours in timesheets.
void	setTimesheetInterval(boolean b)	Sets the flag that indicates whether timesheet application users enter timesheet hours daily or by entire timesheet reporting period.
void	setTimesheetPeriodEndsOnDay(DayOfWeekType enm)	Sets the end day of time sheet period used in time sheet application.
void	setTimesheetPeriodType(TimesheetPeriodType enm)	Sets the time period used in time sheet application.
void	setTimeWindowCompletedActivities(int i)	Sets the time window (days) to access completed activities in the timesheet application, assigned to new resources by default.
void	setTimeWindowNotStartedActivities(int i)	Sets the time window (days) to access not started activities in the timesheet application, assigned to new resources by default.
void	setUnifierAuthCode(String s)	Sets this is the Unifier authentication code.
void	setUnifierCompanyShortName(String s)	Sets this is the Unifier company short name.
void	setUnifierIntegrationPassword(String s)	Sets this is the Unifier Integration user password.
void	setUnifierIntegrationUserName(String s)	Sets this is the Unifier Integration user name.
void	setUnifierWebServiceURL(String s)	Sets this is the URL of Unifier Web Services.
void	setUseCalendarTimePeriodsFlag(boolean b)	Sets the flag that indicates whether the system uses the hours per time period defined in the calendar.If this flag is true, the system uses the hours per time period settings that are defined in the calendar.If this flag is false, the system uses the hours per time period from the global preferences.
void	setUseMaxTimesheetResourceHours(boolean b)	Sets the flag indicating whether to restrict the number of hours a user can enter to the limit specified in MaxTimesheetResourceHours.
void	setUseProjectManagerApproval(String s)	Sets the flag that indicates the approval sequence, if any, required for level 2 timesheet approvals.
void	setUseTimesheets(boolean b)	Sets the flag that indicates whether new resources use timesheets by default.
void	setVersionForWhatsNew(String s)	Sets this field is used in testing to change version for what's new dialog.
void	setWBSCategoryLabel(String s)	Sets the dynamic label used for the WBS category.
void	setWBSCodeSeparator(String s)	Sets the character used for separating code fields for the cost account tree.
void	setWeekAbbreviation(String s)	Sets the abbreviation character for time periods of weeks.
void	setYearAbbreviation(String s)	Sets the abbreviation character for time periods of years.
String	toString()	Returns a string representation of the object.
void	update()	Updates this GlobalPreferences object in the database.

Methods inherited from class com.primavera.integration.client.bo.BusinessObject

equals, getMaxFieldLength, getObjectId, getValue, getValue, hashCode, isNull, setEarlyDate, setNull, setObjectId

Methods inherited from class com.primavera.integration.client.BOBase

combineFields

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

GlobalPreferences

public GlobalPreferences(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

GlobalPreferences

public GlobalPreferences(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

GlobalPreferences

public GlobalPreferences(Session session,
 com.primavera.infr.db.PrmRowSet rowSet,
 int iIndex)
                  throws BusinessObjectException

Class constructor called internally after objects are retrieved from the server. Client code should use one of the other constructors for this class.

Parameters:

session - the Session

rowSet - the PrmRowSet retrieved from the server

iIndex - the row index in the PrmRowSet associated with this business object

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

Method Details

getReportEnableLazyLoad

public boolean getReportEnableLazyLoad()
                                throws BusinessObjectException

Gets the flag that indicates whether the report tab initial should be lazy load or eager load.

Returns:

the value in the field ReportEnableLazyLoad

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setReportEnableLazyLoad

public void setReportEnableLazyLoad(boolean b)
                             throws BusinessObjectException

Sets the flag that indicates whether the report tab initial should be lazy load or eager load.

Parameters:

b - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getSummarizeByCalendar

public boolean getSummarizeByCalendar()
                               throws BusinessObjectException

Gets the flag indicating whether to summarize by calendar .

Returns:

the value in the field SummarizeByCalendar

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setSummarizeByCalendar

public void setSummarizeByCalendar(boolean b)
                            throws BusinessObjectException

Sets the flag indicating whether to summarize by calendar .

Parameters:

b - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getSummarizeByFinancialPeriods

public boolean getSummarizeByFinancialPeriods()
                                       throws BusinessObjectException

Gets the flag indicating whether to summarize the EPS, project or WBS by financial periods.

Returns:

the value in the field SummarizeByFinancialPeriods

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setSummarizeByFinancialPeriods

public void setSummarizeByFinancialPeriods(boolean b)
                                    throws BusinessObjectException

Sets the flag indicating whether to summarize the EPS, project or WBS by financial periods.

Parameters:

b - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getUseMaxTimesheetResourceHours

public boolean getUseMaxTimesheetResourceHours()
                                        throws BusinessObjectException

Gets the flag indicating whether to restrict the number of hours a user can enter to the limit specified in MaxTimesheetResourceHours.

Returns:

the value in the field UseMaxTimesheetResourceHours

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setUseMaxTimesheetResourceHours

public void setUseMaxTimesheetResourceHours(boolean b)
                                     throws BusinessObjectException

Sets the flag indicating whether to restrict the number of hours a user can enter to the limit specified in MaxTimesheetResourceHours.

Parameters:

b - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getMaxTimesheetResourceHours

public double getMaxTimesheetResourceHours()
                                    throws BusinessObjectException

Gets the maximum hours a resource can enter per day for all of their assigned activities.

Returns:

the value in the field MaxTimesheetResourceHours

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setMaxTimesheetResourceHours

public void setMaxTimesheetResourceHours(double d)
                                  throws BusinessObjectException

Sets the maximum hours a resource can enter per day for all of their assigned activities.

Parameters:

d - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getEnableTSAudit

public boolean getEnableTSAudit()
                         throws BusinessObjectException

Gets the flag indicating whether to track timesheet submission, approval, and rejection. When you set this option, the application saves each user who reviews a timesheet, and when the timesheet was reviewed. This information can be viewed by loading TimesheetAudit business objects.

Returns:

the value in the field EnableTSAudit

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setEnableTSAudit

public void setEnableTSAudit(boolean b)
                      throws BusinessObjectException

Sets the flag indicating whether to track timesheet submission, approval, and rejection. When you set this option, the application saves each user who reviews a timesheet, and when the timesheet was reviewed. This information can be viewed by loading TimesheetAudit business objects.

Parameters:

b - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getEmailNotifyTSRejection

public boolean getEmailNotifyTSRejection()
                                  throws BusinessObjectException

Gets the flag indicating whether to send notification through e-mail for PM/RM users and their delegates when a timesheet which they has to take an action gets rejected by other RM/PM manager or their delegate.

Returns:

the value in the field EmailNotifyTSRejection

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setEmailNotifyTSRejection

public void setEmailNotifyTSRejection(boolean b)
                               throws BusinessObjectException

Sets the flag indicating whether to send notification through e-mail for PM/RM users and their delegates when a timesheet which they has to take an action gets rejected by other RM/PM manager or their delegate.

Parameters:

b - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getAllowApprovedTSRejection

public boolean getAllowApprovedTSRejection()
                                    throws BusinessObjectException

Gets the flag indicating whether to reject Approved timesheet or not.

Returns:

the value in the field AllowApprovedTSRejection

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setAllowApprovedTSRejection

public void setAllowApprovedTSRejection(boolean b)
                                 throws BusinessObjectException

Sets the flag indicating whether to reject Approved timesheet or not.

Parameters:

b - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getAlwaysLaunchOnlineHelp

public boolean getAlwaysLaunchOnlineHelp()
                                  throws BusinessObjectException

Gets the flag that indicates whether the online help should be launched with F1 key.

Returns:

the value in the field AlwaysLaunchOnlineHelp

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setAlwaysLaunchOnlineHelp

public void setAlwaysLaunchOnlineHelp(boolean b)
                               throws BusinessObjectException

Sets the flag that indicates whether the online help should be launched with F1 key.

Parameters:

b - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getEnableWhatsNewDialog

public boolean getEnableWhatsNewDialog()
                                throws BusinessObjectException

Gets the flag that indicates whether the new features dialog is to be shown.

Returns:

the value in the field EnableWhatsNewDialog

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setEnableWhatsNewDialog

public void setEnableWhatsNewDialog(boolean b)
                             throws BusinessObjectException

Sets the flag that indicates whether the new features dialog is to be shown.

Parameters:

b - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getVersionForWhatsNew

public String getVersionForWhatsNew()
                             throws BusinessObjectException

Gets this field is used in testing to change version for what's new dialog.

Returns:

the value in the field VersionForWhatsNew

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setVersionForWhatsNew

public void setVersionForWhatsNew(String s)
                           throws BusinessObjectException

Sets this field is used in testing to change version for what's new dialog.

Parameters:

s - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getEnablePasswordPolicy

public boolean getEnablePasswordPolicy()
                                throws BusinessObjectException

Gets the flag that indicates whether the password policy is enforced.

Returns:

the value in the field EnablePasswordPolicy

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setEnablePasswordPolicy

public void setEnablePasswordPolicy(boolean b)
                             throws BusinessObjectException

Sets the flag that indicates whether the password policy is enforced.

Parameters:

b - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getEarnedValueCalculation

public EarnedValueCalculationType getEarnedValueCalculation()
                                                     throws BusinessObjectException

Gets the flag indicating which values to use when calculating earned value when using a primary baseline. Valid values are 'At Completion Values with Current Dates', 'Planned Values with Planned Dates', and 'Planned Values with Current Dates'.

Returns:

the value in the field EarnedValueCalculation

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setEarnedValueCalculation

public void setEarnedValueCalculation(EarnedValueCalculationType enm)
                               throws BusinessObjectException

Sets the flag indicating which values to use when calculating earned value when using a primary baseline. Valid values are 'At Completion Values with Current Dates', 'Planned Values with Planned Dates', and 'Planned Values with Current Dates'.

Parameters:

enm - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getTimesheetPeriodType

public TimesheetPeriodType getTimesheetPeriodType()
                                           throws BusinessObjectException

Gets the time period used in time sheet application. Valid values are: 'Every Week', 'Every Two Weeks', 'Every Four Weeks' and 'Every Month'.

Returns:

the value in the field TimesheetPeriodType

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setTimesheetPeriodType

public void setTimesheetPeriodType(TimesheetPeriodType enm)
                            throws BusinessObjectException

Sets the time period used in time sheet application. Valid values are: 'Every Week', 'Every Two Weeks', 'Every Four Weeks' and 'Every Month'.

Parameters:

enm - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getTimesheetPeriodEndsOnDay

public DayOfWeekType getTimesheetPeriodEndsOnDay()
                                          throws BusinessObjectException

Gets the end day of time sheet period used in time sheet application. Valid values are: 'Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday' and 'Saturday'.

Returns:

the value in the field TimesheetPeriodEndsOnDay

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setTimesheetPeriodEndsOnDay

public void setTimesheetPeriodEndsOnDay(DayOfWeekType enm)
                                 throws BusinessObjectException

Sets the end day of time sheet period used in time sheet application. Valid values are: 'Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday' and 'Saturday'.

Parameters:

enm - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getMaximumBaselinesCopiedWithProject

public int getMaximumBaselinesCopiedWithProject()
                                         throws BusinessObjectException

Gets the number of baseline projects that can be copied with a project.

Returns:

the value in the field MaximumBaselinesCopiedWithProject

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setMaximumBaselinesCopiedWithProject

public void setMaximumBaselinesCopiedWithProject(int i)
                                          throws BusinessObjectException

Sets the number of baseline projects that can be copied with a project.

Parameters:

i - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getUnifierWebServiceURL

public String getUnifierWebServiceURL()
                               throws BusinessObjectException

Gets this is the URL of Unifier Web Services.

Returns:

the value in the field UnifierWebServiceURL

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setUnifierWebServiceURL

public void setUnifierWebServiceURL(String s)
                             throws BusinessObjectException

Sets this is the URL of Unifier Web Services.

Parameters:

s - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getGatewayApiUrl

public String getGatewayApiUrl()
                        throws BusinessObjectException

Gets this is the URL for Gateway.

Returns:

the value in the field GatewayApiUrl

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setGatewayApiUrl

public void setGatewayApiUrl(String s)
                      throws BusinessObjectException

Sets this is the URL for Gateway.

Parameters:

s - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getGatewayUsername

public String getGatewayUsername()
                          throws BusinessObjectException

Gets this is the user name for Gateway.

Returns:

the value in the field GatewayUsername

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setGatewayUsername

public void setGatewayUsername(String s)
                        throws BusinessObjectException

Sets this is the user name for Gateway.

Parameters:

s - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getGatewayPassword

public String getGatewayPassword()
                          throws BusinessObjectException

Gets this is the password for Gateway.

Returns:

the value in the field GatewayPassword

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setGatewayPassword

public void setGatewayPassword(String s)
                        throws BusinessObjectException

Sets this is the password for Gateway.

Parameters:

s - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getGatewayP6DeploymentName

public String getGatewayP6DeploymentName()
                                  throws BusinessObjectException

Gets this is the P6 Deployment name in Gateway.

Returns:

the value in the field GatewayP6DeploymentName

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setGatewayP6DeploymentName

public void setGatewayP6DeploymentName(String s)
                                throws BusinessObjectException

Sets this is the P6 Deployment name in Gateway.

Parameters:

s - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getGatewayImportUnifierSyncName

public String getGatewayImportUnifierSyncName()
                                       throws BusinessObjectException

Gets this is the unifier import Synchronization name for Gateway.

Returns:

the value in the field GatewayImportUnifierSyncName

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setGatewayImportUnifierSyncName

public void setGatewayImportUnifierSyncName(String s)
                                     throws BusinessObjectException

Sets this is the unifier import Synchronization name for Gateway.

Parameters:

s - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getGatewayExportUnifierSyncName

public String getGatewayExportUnifierSyncName()
                                       throws BusinessObjectException

Gets this is the unifier export Synchronization name for Gateway.

Returns:

the value in the field GatewayExportUnifierSyncName

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setGatewayExportUnifierSyncName

public void setGatewayExportUnifierSyncName(String s)
                                     throws BusinessObjectException

Sets this is the unifier export Synchronization name for Gateway.

Parameters:

s - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getGatewayUnifierEnabled

public boolean getGatewayUnifierEnabled()
                                 throws BusinessObjectException

Gets this is the flag to enable Unifier through Gateway.

Returns:

the value in the field GatewayUnifierEnabled

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setGatewayUnifierEnabled

public void setGatewayUnifierEnabled(boolean b)
                              throws BusinessObjectException

Sets this is the flag to enable Unifier through Gateway.

Parameters:

b - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getGatewayImportERPSyncName

public String getGatewayImportERPSyncName()
                                   throws BusinessObjectException

Gets this is the ERP import Synchronization name for Gateway.

Returns:

the value in the field GatewayImportERPSyncName

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setGatewayImportERPSyncName

public void setGatewayImportERPSyncName(String s)
                                 throws BusinessObjectException

Sets this is the ERP import Synchronization name for Gateway.

Parameters:

s - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getGatewayExportERPSyncName

public String getGatewayExportERPSyncName()
                                   throws BusinessObjectException

Gets this is the ERP export Synchronization name for Gateway.

Returns:

the value in the field GatewayExportERPSyncName

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setGatewayExportERPSyncName

public void setGatewayExportERPSyncName(String s)
                                 throws BusinessObjectException

Sets this is the ERP export Synchronization name for Gateway.

Parameters:

s - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getUnifierCompanyShortName

public String getUnifierCompanyShortName()
                                  throws BusinessObjectException

Gets this is the Unifier company short name.

Returns:

the value in the field UnifierCompanyShortName

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setUnifierCompanyShortName

public void setUnifierCompanyShortName(String s)
                                throws BusinessObjectException

Sets this is the Unifier company short name.

Parameters:

s - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getUnifierIntegrationUserName

public String getUnifierIntegrationUserName()
                                     throws BusinessObjectException

Gets this is the Unifier Integration user name.

Returns:

the value in the field UnifierIntegrationUserName

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setUnifierIntegrationUserName

public void setUnifierIntegrationUserName(String s)
                                   throws BusinessObjectException

Sets this is the Unifier Integration user name.

Parameters:

s - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getUnifierAuthCode

public String getUnifierAuthCode()
                          throws BusinessObjectException

Gets this is the Unifier authentication code.

Returns:

the value in the field UnifierAuthCode

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setUnifierAuthCode

public void setUnifierAuthCode(String s)
                        throws BusinessObjectException

Sets this is the Unifier authentication code.

Parameters:

s - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getUnifierIntegrationPassword

public String getUnifierIntegrationPassword()
                                     throws BusinessObjectException

Gets this is the Unifier Integration user password.

Returns:

the value in the field UnifierIntegrationPassword

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setUnifierIntegrationPassword

public void setUnifierIntegrationPassword(String s)
                                   throws BusinessObjectException

Sets this is the Unifier Integration user password.

Parameters:

s - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getExceptionSiteList

public String getExceptionSiteList()
                            throws BusinessObjectException

Gets this is the list of sites that will be allowed to be accessed directly.

Returns:

the value in the field ExceptionSiteList

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setExceptionSiteList

public void setExceptionSiteList(String s)
                          throws BusinessObjectException

Sets this is the list of sites that will be allowed to be accessed directly.

Parameters:

s - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getEnableWebServicesIPCheck

public boolean getEnableWebServicesIPCheck()
                                    throws BusinessObjectException

Gets the flag that indicates whether IP address has to be checked in order to access WebServices.

Returns:

the value in the field EnableWebServicesIPCheck

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setEnableWebServicesIPCheck

public void setEnableWebServicesIPCheck(boolean b)
                                 throws BusinessObjectException

Sets the flag that indicates whether IP address has to be checked in order to access WebServices.

Parameters:

b - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getIPSiteList

public String getIPSiteList()
                     throws BusinessObjectException

Gets this is the list of IP Address that will NOT be restricted to access WebServcices.

Returns:

the value in the field IPSiteList

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setIPSiteList

public void setIPSiteList(String s)
                   throws BusinessObjectException

Sets this is the list of IP Address that will NOT be restricted to access WebServcices.

Parameters:

s - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getPrivateIPAllowList

public String getPrivateIPAllowList()
                             throws BusinessObjectException

Gets this is the Fixed list of Regional IP Address saved during DB Install that will NOT be restricted to access WebServcices.

Returns:

the value in the field PrivateIPAllowList

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setPrivateIPAllowList

public void setPrivateIPAllowList(String s)
                           throws BusinessObjectException

Sets this is the Fixed list of Regional IP Address saved during DB Install that will NOT be restricted to access WebServcices.

Parameters:

s - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getTimesheetDecimalDigits

public int getTimesheetDecimalDigits()
                              throws BusinessObjectException

Gets the number of decimal digits for recording hours in timesheets.

Returns:

the value in the field TimesheetDecimalDigits

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setTimesheetDecimalDigits

public void setTimesheetDecimalDigits(int i)
                               throws BusinessObjectException

Sets the number of decimal digits for recording hours in timesheets.

Parameters:

i - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getTimeWindowNotStartedActivities

public int getTimeWindowNotStartedActivities()
                                      throws BusinessObjectException

Gets the time window (days) to access not started activities in the timesheet application, assigned to new resources by default.

Returns:

the value in the field TimeWindowNotStartedActivities

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setTimeWindowNotStartedActivities

public void setTimeWindowNotStartedActivities(int i)
                                       throws BusinessObjectException

Sets the time window (days) to access not started activities in the timesheet application, assigned to new resources by default.

Parameters:

i - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getTimeWindowCompletedActivities

public int getTimeWindowCompletedActivities()
                                     throws BusinessObjectException

Gets the time window (days) to access completed activities in the timesheet application, assigned to new resources by default.

Returns:

the value in the field TimeWindowCompletedActivities

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setTimeWindowCompletedActivities

public void setTimeWindowCompletedActivities(int i)
                                      throws BusinessObjectException

Sets the time window (days) to access completed activities in the timesheet application, assigned to new resources by default.

Parameters:

i - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getMaxWBSTreeLevels

public int getMaxWBSTreeLevels()
                        throws BusinessObjectException

Gets the maximum number of levels that can be created in WBS hierarchies.

Returns:

the value in the field MaxWBSTreeLevels

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setMaxWBSTreeLevels

public void setMaxWBSTreeLevels(int i)
                         throws BusinessObjectException

Sets the maximum number of levels that can be created in WBS hierarchies.

Parameters:

i - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getMaxCostAccountTreeLevels

public int getMaxCostAccountTreeLevels()
                                throws BusinessObjectException

Gets the maximum number of levels that can be created in the cost account hierarchy in the Project Management application. The API ignores this setting when creating cost accounts.

Returns:

the value in the field MaxCostAccountTreeLevels

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setMaxCostAccountTreeLevels

public void setMaxCostAccountTreeLevels(int i)
                                 throws BusinessObjectException

Sets the maximum number of levels that can be created in the cost account hierarchy in the Project Management application. The API ignores this setting when creating cost accounts.

Parameters:

i - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getMaxActivityCodesPerProject

public int getMaxActivityCodesPerProject()
                                  throws BusinessObjectException

Gets the maximum number of project-level activity user codes that can be created per project.

Returns:

the value in the field MaxActivityCodesPerProject

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setMaxActivityCodesPerProject

public void setMaxActivityCodesPerProject(int i)
                                   throws BusinessObjectException

Sets the maximum number of project-level activity user codes that can be created per project.

Parameters:

i - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getNumberOfAccessibleFutureTimesheets

public int getNumberOfAccessibleFutureTimesheets()
                                          throws BusinessObjectException

Gets the number of future timesheets that timesheet application users are allowed to access.

Returns:

the value in the field NumberOfAccessibleFutureTimesheets

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setNumberOfAccessibleFutureTimesheets

public void setNumberOfAccessibleFutureTimesheets(int i)
                                           throws BusinessObjectException

Sets the number of future timesheets that timesheet application users are allowed to access.

Parameters:

i - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getMaxOBSTreeLevels

public int getMaxOBSTreeLevels()
                        throws BusinessObjectException

Gets the maximum number of levels that can be created in OBS hierarchies in the Project Management application. The API ignores this setting when creating OBS objects.

Returns:

the value in the field MaxOBSTreeLevels

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setMaxOBSTreeLevels

public void setMaxOBSTreeLevels(int i)
                         throws BusinessObjectException

Sets the maximum number of levels that can be created in OBS hierarchies in the Project Management application. The API ignores this setting when creating OBS objects.

Parameters:

i - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getStartDayOfWeek

public int getStartDayOfWeek()
                      throws BusinessObjectException

Gets the starting day of the week as displayed in all calendars.

Returns:

the value in the field StartDayOfWeek

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setStartDayOfWeek

public void setStartDayOfWeek(int i)
                       throws BusinessObjectException

Sets the starting day of the week as displayed in all calendars.

Parameters:

i - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getTimesheetApprovalLevel

public int getTimesheetApprovalLevel()
                              throws BusinessObjectException

Gets the number of approval levels required for timesheets (0, 1, or 2) before timesheets hours are applied to activities as actuals.

Returns:

the value in the field TimesheetApprovalLevel

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setTimesheetApprovalLevel

public void setTimesheetApprovalLevel(int i)
                               throws BusinessObjectException

Sets the number of approval levels required for timesheets (0, 1, or 2) before timesheets hours are applied to activities as actuals.

Parameters:

i - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getMaxActivityIdLength

public int getMaxActivityIdLength()
                           throws BusinessObjectException

Gets the maximum number of characters allowed for activity IDs.

Returns:

the value in the field MaxActivityIdLength

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setMaxActivityIdLength

public void setMaxActivityIdLength(int i)
                            throws BusinessObjectException

Sets the maximum number of characters allowed for activity IDs.

Parameters:

i - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getMaxProjectIdLength

public int getMaxProjectIdLength()
                          throws BusinessObjectException

Gets the maximum number characters allowed for project IDs.

Returns:

the value in the field MaxProjectIdLength

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setMaxProjectIdLength

public void setMaxProjectIdLength(int i)
                           throws BusinessObjectException

Sets the maximum number characters allowed for project IDs.

Parameters:

i - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getMaxWBSCodeLength

public int getMaxWBSCodeLength()
                        throws BusinessObjectException

Gets the maximum number of characters allowed for WBS codes (at each level in the WBS tree).

Returns:

the value in the field MaxWBSCodeLength

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setMaxWBSCodeLength

public void setMaxWBSCodeLength(int i)
                         throws BusinessObjectException

Sets the maximum number of characters allowed for WBS codes (at each level in the WBS tree).

Parameters:

i - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getMaxResourceIdLength

public int getMaxResourceIdLength()
                           throws BusinessObjectException

Gets the maximum number of characters allowed for resource IDs (at each level in the resource tree).

Returns:

the value in the field MaxResourceIdLength

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setMaxResourceIdLength

public void setMaxResourceIdLength(int i)
                            throws BusinessObjectException

Sets the maximum number of characters allowed for resource IDs (at each level in the resource tree).

Parameters:

i - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getMaxCostAccountLength

public int getMaxCostAccountLength()
                            throws BusinessObjectException

Gets the maximum number of characters allowed for cost account IDs (at each level in the cost account tree).

Returns:

the value in the field MaxCostAccountLength

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setMaxCostAccountLength

public void setMaxCostAccountLength(int i)
                             throws BusinessObjectException

Sets the maximum number of characters allowed for cost account IDs (at each level in the cost account tree).

Parameters:

i - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getMaxRoleIdLength

public int getMaxRoleIdLength()
                       throws BusinessObjectException

Gets the maximum number characters allowed for role IDs.

Returns:

the value in the field MaxRoleIdLength

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setMaxRoleIdLength

public void setMaxRoleIdLength(int i)
                        throws BusinessObjectException

Sets the maximum number characters allowed for role IDs.

Parameters:

i - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getMaxBaselinesPerProject

public int getMaxBaselinesPerProject()
                              throws BusinessObjectException

Gets the maximum number of baselines that can be created per project.

Returns:

the value in the field MaxBaselinesPerProject

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setMaxBaselinesPerProject

public void setMaxBaselinesPerProject(int i)
                               throws BusinessObjectException

Sets the maximum number of baselines that can be created per project.

Parameters:

i - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getDefaultDuration

public Duration getDefaultDuration()
                            throws BusinessObjectException

Gets the planned duration assigned to new activities by default.

Returns:

the value in the field DefaultDuration

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setDefaultDuration

public void setDefaultDuration(Duration d)
                        throws BusinessObjectException

Sets the planned duration assigned to new activities by default.

Parameters:

d - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getHoursPerDay

public double getHoursPerDay()
                      throws BusinessObjectException

Gets the number of work hours per day. This conversion factor is used for displaying time units and durations in the user's selected display formats.

Returns:

the value in the field HoursPerDay

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setHoursPerDay

public void setHoursPerDay(double d)
                    throws BusinessObjectException

Sets the number of work hours per day. This conversion factor is used for displaying time units and durations in the user's selected display formats.

Parameters:

d - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getHoursPerWeek

public double getHoursPerWeek()
                       throws BusinessObjectException

Gets the number of work hours per week. This conversion factor is used for displaying time units and durations in the user's selected display formats.

Returns:

the value in the field HoursPerWeek

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setHoursPerWeek

public void setHoursPerWeek(double d)
                     throws BusinessObjectException

Sets the number of work hours per week. This conversion factor is used for displaying time units and durations in the user's selected display formats.

Parameters:

d - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getHoursPerYear

public double getHoursPerYear()
                       throws BusinessObjectException

Gets the number of work hours per year. This conversion factor is used for displaying time units and durations in the user's selected display formats.

Returns:

the value in the field HoursPerYear

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setHoursPerYear

public void setHoursPerYear(double d)
                     throws BusinessObjectException

Sets the number of work hours per year. This conversion factor is used for displaying time units and durations in the user's selected display formats.

Parameters:

d - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getHoursPerMonth

public double getHoursPerMonth()
                        throws BusinessObjectException

Gets the number of work hours per month. This conversion factor is used for displaying time units and durations in the user's selected display formats.

Returns:

the value in the field HoursPerMonth

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setHoursPerMonth

public void setHoursPerMonth(double d)
                      throws BusinessObjectException

Sets the number of work hours per month. This conversion factor is used for displaying time units and durations in the user's selected display formats.

Parameters:

d - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getMaxActivityCodeTreeLevels

public int getMaxActivityCodeTreeLevels()
                                 throws BusinessObjectException

Gets the maximum number of levels that can be created in activity code hierarchies in the Project Management application. The API ignores this setting when creating activity codes.

Returns:

the value in the field MaxActivityCodeTreeLevels

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setMaxActivityCodeTreeLevels

public void setMaxActivityCodeTreeLevels(int i)
                                  throws BusinessObjectException

Sets the maximum number of levels that can be created in activity code hierarchies in the Project Management application. The API ignores this setting when creating activity codes.

Parameters:

i - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getMaxProjectCodeTreeLevels

public int getMaxProjectCodeTreeLevels()
                                throws BusinessObjectException

Gets the maximum number of levels in the project category hierarchy in the Project Management application. The API ignores this setting when creating project codes.

Returns:

the value in the field MaxProjectCodeTreeLevels

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setMaxProjectCodeTreeLevels

public void setMaxProjectCodeTreeLevels(int i)
                                 throws BusinessObjectException

Sets the maximum number of levels in the project category hierarchy in the Project Management application. The API ignores this setting when creating project codes.

Parameters:

i - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getMaxResourceCodeTreeLevels

public int getMaxResourceCodeTreeLevels()
                                 throws BusinessObjectException

Gets the maximum number of levels in the resource code hierarchy in the Project Management application. The API ignores this setting when creating resource codes.

Returns:

the value in the field MaxResourceCodeTreeLevels

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setMaxResourceCodeTreeLevels

public void setMaxResourceCodeTreeLevels(int i)
                                  throws BusinessObjectException

Sets the maximum number of levels in the resource code hierarchy in the Project Management application. The API ignores this setting when creating resource codes.

Parameters:

i - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getMaxRoleCodeTreeLevelCnt

public int getMaxRoleCodeTreeLevelCnt()
                               throws BusinessObjectException

Gets the maximum number of levels in the role code hierarchy in the Project Management application. The API ignores this setting when creating role codes.

Returns:

the value in the field MaxRoleCodeTreeLevelCnt

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setMaxRoleCodeTreeLevelCnt

public void setMaxRoleCodeTreeLevelCnt(int i)
                                throws BusinessObjectException

Sets the maximum number of levels in the role code hierarchy in the Project Management application. The API ignores this setting when creating role codes.

Parameters:

i - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getMaxAssignmentCodeTreeLevelCnt

public int getMaxAssignmentCodeTreeLevelCnt()
                                     throws BusinessObjectException

Gets the maximum number of levels in the assignment code hierarchy in the Project Management application. The API ignores this setting when creating assignment codes.

Returns:

the value in the field MaxAssignmentCodeTreeLevelCnt

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setMaxAssignmentCodeTreeLevelCnt

public void setMaxAssignmentCodeTreeLevelCnt(int i)
                                      throws BusinessObjectException

Sets the maximum number of levels in the assignment code hierarchy in the Project Management application. The API ignores this setting when creating assignment codes.

Parameters:

i - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getMaxResourceTreeLevels

public int getMaxResourceTreeLevels()
                             throws BusinessObjectException

Gets the maximum number of levels that can be created in the resource hierarchy.

Returns:

the value in the field MaxResourceTreeLevels

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setMaxResourceTreeLevels

public void setMaxResourceTreeLevels(int i)
                              throws BusinessObjectException

Sets the maximum number of levels that can be created in the resource hierarchy.

Parameters:

i - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getLogHoursCompletedActivities

public boolean getLogHoursCompletedActivities()
                                       throws BusinessObjectException

Gets the flag that indicates whether timesheet application users are allowed to log timesheet hours on activities that are already marked as completed.

Returns:

the value in the field LogHoursCompletedActivities

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setLogHoursCompletedActivities

public void setLogHoursCompletedActivities(boolean b)
                                    throws BusinessObjectException

Sets the flag that indicates whether timesheet application users are allowed to log timesheet hours on activities that are already marked as completed.

Parameters:

b - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getUseTimesheets

public boolean getUseTimesheets()
                         throws BusinessObjectException

Gets the flag that indicates whether new resources use timesheets by default.

Returns:

the value in the field UseTimesheets

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setUseTimesheets

public void setUseTimesheets(boolean b)
                      throws BusinessObjectException

Sets the flag that indicates whether new resources use timesheets by default.

Parameters:

b - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getResourcesCanAssignThemselvesToActivities

public boolean getResourcesCanAssignThemselvesToActivities()
                                                    throws BusinessObjectException

Gets the flag that indicates whether timesheet application users are allowed to assign themselves to activities in this project.

Returns:

the value in the field ResourcesCanAssignThemselvesToActivities

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setResourcesCanAssignThemselvesToActivities

public void setResourcesCanAssignThemselvesToActivities(boolean b)
                                                 throws BusinessObjectException

Sets the flag that indicates whether timesheet application users are allowed to assign themselves to activities in this project.

Parameters:

b - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getResourcesCanAssignThemselvesToActivitiesOutsideTheirOBSAccess

public boolean getResourcesCanAssignThemselvesToActivitiesOutsideTheirOBSAccess()
                                                                         throws BusinessObjectException

Gets the flag that indicates whether timesheet application users are allowed to assign themselves to activities outside their OBS Access in this project.

Returns:

the value in the field ResourcesCanAssignThemselvesToActivitiesOutsideTheirOBSAccess

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setResourcesCanAssignThemselvesToActivitiesOutsideTheirOBSAccess

public void setResourcesCanAssignThemselvesToActivitiesOutsideTheirOBSAccess(boolean b)
                                                                      throws BusinessObjectException

Sets the flag that indicates whether timesheet application users are allowed to assign themselves to activities outside their OBS Access in this project.

Parameters:

b - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getLogHoursInFuture

public boolean getLogHoursInFuture()
                            throws BusinessObjectException

Gets the flag that indicates whether the user can log hours in the future.

Returns:

the value in the field LogHoursInFuture

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setLogHoursInFuture

public void setLogHoursInFuture(boolean b)
                         throws BusinessObjectException

Sets the flag that indicates whether the user can log hours in the future.

Parameters:

b - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getTimesheetInterval

public boolean getTimesheetInterval()
                             throws BusinessObjectException

Gets the flag that indicates whether timesheet application users enter timesheet hours daily or by entire timesheet reporting period.

Returns:

the value in the field TimesheetInterval

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setTimesheetInterval

public void setTimesheetInterval(boolean b)
                          throws BusinessObjectException

Sets the flag that indicates whether timesheet application users enter timesheet hours daily or by entire timesheet reporting period.

Parameters:

b - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getLogHoursNotStartedActivities

public boolean getLogHoursNotStartedActivities()
                                        throws BusinessObjectException

Gets the flag that indicates whether timesheet application users are allowed to log timesheet hours on activities that are still marked as Not started.

Returns:

the value in the field LogHoursNotStartedActivities

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setLogHoursNotStartedActivities

public void setLogHoursNotStartedActivities(boolean b)
                                     throws BusinessObjectException

Sets the flag that indicates whether timesheet application users are allowed to log timesheet hours on activities that are still marked as Not started.

Parameters:

b - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getLogHoursBeforeActualStart

public boolean getLogHoursBeforeActualStart()
                                     throws BusinessObjectException

Gets the flag that indicates whether timesheet application users are allowed to log timesheet hours on activities for dates prior to the activities' actual start dates.

Returns:

the value in the field LogHoursBeforeActualStart

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setLogHoursBeforeActualStart

public void setLogHoursBeforeActualStart(boolean b)
                                  throws BusinessObjectException

Sets the flag that indicates whether timesheet application users are allowed to log timesheet hours on activities for dates prior to the activities' actual start dates.

Parameters:

b - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getLogHoursAfterActualFinish

public boolean getLogHoursAfterActualFinish()
                                     throws BusinessObjectException

Gets the flag that indicates whether timesheet application users are allowed to log timesheet hours on activities for dates after the activities' actual finish dates.

Returns:

the value in the field LogHoursAfterActualFinish

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setLogHoursAfterActualFinish

public void setLogHoursAfterActualFinish(boolean b)
                                  throws BusinessObjectException

Sets the flag that indicates whether timesheet application users are allowed to log timesheet hours on activities for dates after the activities' actual finish dates.

Parameters:

b - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getWBSCodeSeparator

public String getWBSCodeSeparator()
                           throws BusinessObjectException

Gets the character used for separating code fields for the cost account tree. This is also the WBS code separator for new projects by default.

Returns:

the value in the field WBSCodeSeparator

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setWBSCodeSeparator

public void setWBSCodeSeparator(String s)
                         throws BusinessObjectException

Sets the character used for separating code fields for the cost account tree. This is also the WBS code separator for new projects by default.

Parameters:

s - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getYearAbbreviation

public String getYearAbbreviation()
                           throws BusinessObjectException

Gets the abbreviation character for time periods of years. This abbreviation is used for displaying time units and durations in the user's selected display formats.

Returns:

the value in the field YearAbbreviation

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setYearAbbreviation

public void setYearAbbreviation(String s)
                         throws BusinessObjectException

Sets the abbreviation character for time periods of years. This abbreviation is used for displaying time units and durations in the user's selected display formats.

Parameters:

s - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getMonthAbbreviation

public String getMonthAbbreviation()
                            throws BusinessObjectException

Gets the abbreviation character for time periods of months. This abbreviation is used for displaying time units and durations in the user's selected display formats.

Returns:

the value in the field MonthAbbreviation

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setMonthAbbreviation

public void setMonthAbbreviation(String s)
                          throws BusinessObjectException

Sets the abbreviation character for time periods of months. This abbreviation is used for displaying time units and durations in the user's selected display formats.

Parameters:

s - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getWeekAbbreviation

public String getWeekAbbreviation()
                           throws BusinessObjectException

Gets the abbreviation character for time periods of weeks. This abbreviation is used for displaying time units and durations in the user's selected display formats.

Returns:

the value in the field WeekAbbreviation

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setWeekAbbreviation

public void setWeekAbbreviation(String s)
                         throws BusinessObjectException

Sets the abbreviation character for time periods of weeks. This abbreviation is used for displaying time units and durations in the user's selected display formats.

Parameters:

s - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getDayAbbreviation

public String getDayAbbreviation()
                          throws BusinessObjectException

Gets the abbreviation character for time periods of days. This abbreviation is used for displaying time units and durations in the user's selected display formats.

Returns:

the value in the field DayAbbreviation

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setDayAbbreviation

public void setDayAbbreviation(String s)
                        throws BusinessObjectException

Sets the abbreviation character for time periods of days. This abbreviation is used for displaying time units and durations in the user's selected display formats.

Parameters:

s - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getHourAbbreviation

public String getHourAbbreviation()
                           throws BusinessObjectException

Gets the abbreviation character for time periods of hours. This abbreviation is used for displaying time units and durations in the user's selected display formats.

Returns:

the value in the field HourAbbreviation

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setHourAbbreviation

public void setHourAbbreviation(String s)
                         throws BusinessObjectException

Sets the abbreviation character for time periods of hours. This abbreviation is used for displaying time units and durations in the user's selected display formats.

Parameters:

s - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getMinuteAbbreviation

public String getMinuteAbbreviation()
                             throws BusinessObjectException

Gets the abbreviation character for time periods of minutes. This abbreviation is used for displaying time units and durations in the user's selected display formats.

Returns:

the value in the field MinuteAbbreviation

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setMinuteAbbreviation

public void setMinuteAbbreviation(String s)
                           throws BusinessObjectException

Sets the abbreviation character for time periods of minutes. This abbreviation is used for displaying time units and durations in the user's selected display formats.

Parameters:

s - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getUseProjectManagerApproval

public String getUseProjectManagerApproval()
                                    throws BusinessObjectException

Gets the flag that indicates the approval sequence, if any, required for level 2 timesheet approvals. For example, project managers must approve before resource manager do, or vice versa.

Returns:

the value in the field UseProjectManagerApproval

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setUseProjectManagerApproval

public void setUseProjectManagerApproval(String s)
                                  throws BusinessObjectException

Sets the flag that indicates the approval sequence, if any, required for level 2 timesheet approvals. For example, project managers must approve before resource manager do, or vice versa.

Parameters:

s - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getSummaryWBSSpreadInterval

public SummarySpreadInterval getSummaryWBSSpreadInterval()
                                                  throws BusinessObjectException

Gets the interval in which WBS level spreads are summarized and stored. Valid values are 'Month' and 'Week'. This setting is used by the Summarizer job service.

Returns:

the value in the field SummaryWBSSpreadInterval

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setSummaryWBSSpreadInterval

public void setSummaryWBSSpreadInterval(SummarySpreadInterval enm)
                                 throws BusinessObjectException

Sets the interval in which WBS level spreads are summarized and stored. Valid values are 'Month' and 'Week'. This setting is used by the Summarizer job service.

Parameters:

enm - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getSummaryResourceSpreadInterval

public SummarySpreadInterval getSummaryResourceSpreadInterval()
                                                       throws BusinessObjectException

Gets the interval in which resource and role level spreads are summarized and stored. Valid values are 'Month' and 'Week'. This setting is used by the Summarizer job service.

Returns:

the value in the field SummaryResourceSpreadInterval

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setSummaryResourceSpreadInterval

public void setSummaryResourceSpreadInterval(SummarySpreadInterval enm)
                                      throws BusinessObjectException

Sets the interval in which resource and role level spreads are summarized and stored. Valid values are 'Month' and 'Week'. This setting is used by the Summarizer job service.

Parameters:

enm - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getWBSCategoryLabel

public String getWBSCategoryLabel()
                           throws BusinessObjectException

Gets the dynamic label used for the WBS category. Project Planner allows the system administrator to dynamically label the WBS category.

Returns:

the value in the field WBSCategoryLabel

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setWBSCategoryLabel

public void setWBSCategoryLabel(String s)
                         throws BusinessObjectException

Sets the dynamic label used for the WBS category. Project Planner allows the system administrator to dynamically label the WBS category.

Parameters:

s - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getDefaultTimesheetApprovalManager

public ObjectId getDefaultTimesheetApprovalManager()
                                            throws BusinessObjectException

Gets the unique ID of the resource manager assigned to approve timesheets for new resources by default.

Returns:

the value in the field DefaultTimesheetApprovalManager

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setDefaultTimesheetApprovalManager

public void setDefaultTimesheetApprovalManager(ObjectId o)
                                        throws BusinessObjectException

Sets the unique ID of the resource manager assigned to approve timesheets for new resources by default.

Parameters:

o - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getEVPerformancePctCompleteCustomPct

public Percent getEVPerformancePctCompleteCustomPct()
                                             throws BusinessObjectException

Gets the user-defined percent complete for computing earned value for activities within the WBS. A value of, say, 25 means that 25% of the planned amount is earned when the activity is started and the remainder is earned when the activity is completed. This value is assigned to new projects by default. It can be modified for each project WBS element.

Returns:

the value in the field EVPerformancePctCompleteCustomPct

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setEVPerformancePctCompleteCustomPct

public void setEVPerformancePctCompleteCustomPct(Percent p)
                                          throws BusinessObjectException

Sets the user-defined percent complete for computing earned value for activities within the WBS. A value of, say, 25 means that 25% of the planned amount is earned when the activity is started and the remainder is earned when the activity is completed. This value is assigned to new projects by default. It can be modified for each project WBS element.

Parameters:

p - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getEVEstimateToCompleteFactor

public double getEVEstimateToCompleteFactor()
                                     throws BusinessObjectException

Gets the user-defined performance factor, PF, for computing earned-value estimate-to-complete. ETC is computed as PF * ( BAC - earned value). This value is assigned to new projects by default. It can be modified for each project WBS element.

Returns:

the value in the field EVEstimateToCompleteFactor

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setEVEstimateToCompleteFactor

public void setEVEstimateToCompleteFactor(double d)
                                   throws BusinessObjectException

Sets the user-defined performance factor, PF, for computing earned-value estimate-to-complete. ETC is computed as PF * ( BAC - earned value). This value is assigned to new projects by default. It can be modified for each project WBS element.

Parameters:

d - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getEVPerformancePctCompleteTechnique

public EarnedValueComputeType getEVPerformancePctCompleteTechnique()
                                                            throws BusinessObjectException

Gets the technique used for computing earned-value percent complete. This setting is assigned to new projects by default. It can be modified for each project WBS element.

Returns:

the value in the field EVPerformancePctCompleteTechnique

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setEVPerformancePctCompleteTechnique

public void setEVPerformancePctCompleteTechnique(EarnedValueComputeType enm)
                                          throws BusinessObjectException

Sets the technique used for computing earned-value percent complete. This setting is assigned to new projects by default. It can be modified for each project WBS element.

Parameters:

enm - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getEVEstimateToCompleteTechnique

public EarnedValueETCComputeType getEVEstimateToCompleteTechnique()
                                                           throws BusinessObjectException

Gets the technique for computing earned-value estimate-to-complete. This setting is assigned to new projects by default. It can be modified for each project WBS element.

Returns:

the value in the field EVEstimateToCompleteTechnique

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setEVEstimateToCompleteTechnique

public void setEVEstimateToCompleteTechnique(EarnedValueETCComputeType enm)
                                      throws BusinessObjectException

Sets the technique for computing earned-value estimate-to-complete. This setting is assigned to new projects by default. It can be modified for each project WBS element.

Parameters:

enm - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getHeaderLabel1

public String getHeaderLabel1()
                       throws BusinessObjectException

Gets the first header for reports. The Project Management application allows up to three different header text strings that can be optionally placed at the top of all reports using the report writer.

Returns:

the value in the field HeaderLabel1

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setHeaderLabel1

public void setHeaderLabel1(String s)
                     throws BusinessObjectException

Sets the first header for reports. The Project Management application allows up to three different header text strings that can be optionally placed at the top of all reports using the report writer.

Parameters:

s - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getHeaderLabel2

public String getHeaderLabel2()
                       throws BusinessObjectException

Gets the second header for reports. The Project Management application allows up to three different header text strings that can be optionally placed at the top of all reports using the report writer.

Returns:

the value in the field HeaderLabel2

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setHeaderLabel2

public void setHeaderLabel2(String s)
                     throws BusinessObjectException

Sets the second header for reports. The Project Management application allows up to three different header text strings that can be optionally placed at the top of all reports using the report writer.

Parameters:

s - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getHeaderLabel3

public String getHeaderLabel3()
                       throws BusinessObjectException

Gets the third header for reports. The Project Management application allows up to three different header text strings that can be optionally placed at the top of all reports using the report writer.

Returns:

the value in the field HeaderLabel3

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setHeaderLabel3

public void setHeaderLabel3(String s)
                     throws BusinessObjectException

Sets the third header for reports. The Project Management application allows up to three different header text strings that can be optionally placed at the top of all reports using the report writer.

Parameters:

s - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getFooterLabel1

public String getFooterLabel1()
                       throws BusinessObjectException

Gets the first footer for reports. The Project Management application allows up to three different footer text strings that can be optionally placed at the bottom of all reports using the report writer.

Returns:

the value in the field FooterLabel1

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setFooterLabel1

public void setFooterLabel1(String s)
                     throws BusinessObjectException

Sets the first footer for reports. The Project Management application allows up to three different footer text strings that can be optionally placed at the bottom of all reports using the report writer.

Parameters:

s - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getFooterLabel2

public String getFooterLabel2()
                       throws BusinessObjectException

Gets the second footer for reports. The Project Management application allows up to three different footer text strings that can be optionally placed at the bottom of all reports using the report writer.

Returns:

the value in the field FooterLabel2

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setFooterLabel2

public void setFooterLabel2(String s)
                     throws BusinessObjectException

Sets the second footer for reports. The Project Management application allows up to three different footer text strings that can be optionally placed at the bottom of all reports using the report writer.

Parameters:

s - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getFooterLabel3

public String getFooterLabel3()
                       throws BusinessObjectException

Gets the third footer for reports. The Project Management application allows up to three different footer text strings that can be optionally placed at the bottom of all reports using the report writer.

Returns:

the value in the field FooterLabel3

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setFooterLabel3

public void setFooterLabel3(String s)
                     throws BusinessObjectException

Sets the third footer for reports. The Project Management application allows up to three different footer text strings that can be optionally placed at the bottom of all reports using the report writer.

Parameters:

s - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getCustomLabel1

public String getCustomLabel1()
                       throws BusinessObjectException

Gets the custom (user-defined) text that will be inserted into any report containing the Custom Label 1 global variable text cell, when printed.

Returns:

the value in the field CustomLabel1

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setCustomLabel1

public void setCustomLabel1(String s)
                     throws BusinessObjectException

Sets the custom (user-defined) text that will be inserted into any report containing the Custom Label 1 global variable text cell, when printed.

Parameters:

s - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getCustomLabel2

public String getCustomLabel2()
                       throws BusinessObjectException

Gets the custom (user-defined) text that will be inserted into any report containing the Custom Label 2 global variable text cell, when printed.

Returns:

the value in the field CustomLabel2

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setCustomLabel2

public void setCustomLabel2(String s)
                     throws BusinessObjectException

Sets the custom (user-defined) text that will be inserted into any report containing the Custom Label 2 global variable text cell, when printed.

Parameters:

s - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getCustomLabel3

public String getCustomLabel3()
                       throws BusinessObjectException

Gets the custom (user-defined) text that will be inserted into any report containing the Custom Label 3 global variable text cell, when printed.

Returns:

the value in the field CustomLabel3

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setCustomLabel3

public void setCustomLabel3(String s)
                     throws BusinessObjectException

Sets the custom (user-defined) text that will be inserted into any report containing the Custom Label 3 global variable text cell, when printed.

Parameters:

s - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getMaxRoleTreeLevels

public int getMaxRoleTreeLevels()
                         throws BusinessObjectException

Gets the maximum number of levels in the role hierarchy in the Project Management application. The API ignores this setting when creating roles.

Returns:

the value in the field MaxRoleTreeLevels

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setMaxRoleTreeLevels

public void setMaxRoleTreeLevels(int i)
                          throws BusinessObjectException

Sets the maximum number of levels in the role hierarchy in the Project Management application. The API ignores this setting when creating roles.

Parameters:

i - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getBaseCurrencyObjectId

public ObjectId getBaseCurrencyObjectId()
                                 throws BusinessObjectException

Gets the unique ID of the currency.

Returns:

the value in the field BaseCurrencyObjectId

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setBaseCurrencyObjectId

public void setBaseCurrencyObjectId(ObjectId o)
                             throws BusinessObjectException

Sets the unique ID of the currency.

Parameters:

o - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getNumberOfAccessiblePastTimesheets

public int getNumberOfAccessiblePastTimesheets()
                                        throws BusinessObjectException

Gets the number of past timesheets that can be accessed.

Returns:

the value in the field NumberOfAccessiblePastTimesheets

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setNumberOfAccessiblePastTimesheets

public void setNumberOfAccessiblePastTimesheets(int i)
                                         throws BusinessObjectException

Sets the number of past timesheets that can be accessed.

Parameters:

i - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getCreateDate

public Date getCreateDate()
                   throws BusinessObjectException

Gets the date this global preferences was created.

Returns:

the value in the field CreateDate

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getUseCalendarTimePeriodsFlag

public boolean getUseCalendarTimePeriodsFlag()
                                      throws BusinessObjectException

Gets the flag that indicates whether the system uses the hours per time period defined in the calendar.If this flag is true, the system uses the hours per time period settings that are defined in the calendar.If this flag is false, the system uses the hours per time period from the global preferences.

Returns:

the value in the field UseCalendarTimePeriodsFlag

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setUseCalendarTimePeriodsFlag

public void setUseCalendarTimePeriodsFlag(boolean b)
                                   throws BusinessObjectException

Sets the flag that indicates whether the system uses the hours per time period defined in the calendar.If this flag is true, the system uses the hours per time period settings that are defined in the calendar.If this flag is false, the system uses the hours per time period from the global preferences.

Parameters:

b - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getLastUpdateDate

public Date getLastUpdateDate()
                       throws BusinessObjectException

Gets the date this global preferences was last updated.

Returns:

the value in the field LastUpdateDate

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getCreateUser

public String getCreateUser()
                     throws BusinessObjectException

Gets the name of the user that created this global preferences.

Returns:

the value in the field CreateUser

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getLastUpdateUser

public String getLastUpdateUser()
                         throws BusinessObjectException

Gets the name of the user that last updated this global preferences.

Returns:

the value in the field LastUpdateUser

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getContractManagementURL

public String getContractManagementURL()
                                throws BusinessObjectException

Gets this is the URL of the Contract Management application.

Returns:

the value in the field ContractManagementURL

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setContractManagementURL

public void setContractManagementURL(String s)
                              throws BusinessObjectException

Sets this is the URL of the Contract Management application.

Parameters:

s - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getEPPMEnableConsent

public String getEPPMEnableConsent()
                            throws BusinessObjectException

Gets ePPM Enable Consent.

Returns:

the value in the field EPPMEnableConsent

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setEPPMEnableConsent

public void setEPPMEnableConsent(String s)
                          throws BusinessObjectException

Sets ePPM Enable Consent.

Parameters:

s - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getTeamMemberEnableConsent

public String getTeamMemberEnableConsent()
                                  throws BusinessObjectException

Gets teamMember Enable Consent.

Returns:

the value in the field TeamMemberEnableConsent

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setTeamMemberEnableConsent

public void setTeamMemberEnableConsent(String s)
                                throws BusinessObjectException

Sets teamMember Enable Consent.

Parameters:

s - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getEPPMConsentMessage

public String getEPPMConsentMessage()
                             throws BusinessObjectException

Gets ePPM Consent Message.

Returns:

the value in the field EPPMConsentMessage

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setEPPMConsentMessage

public void setEPPMConsentMessage(String s)
                           throws BusinessObjectException

Sets ePPM Consent Message.

Parameters:

s - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getTeamMemberConsentMessage

public String getTeamMemberConsentMessage()
                                   throws BusinessObjectException

Gets teamMember Consent Message.

Returns:

the value in the field TeamMemberConsentMessage

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setTeamMemberConsentMessage

public void setTeamMemberConsentMessage(String s)
                                 throws BusinessObjectException

Sets teamMember Consent Message.

Parameters:

s - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getMaxFPCalendarCount

public int getMaxFPCalendarCount()
                          throws BusinessObjectException

Gets this is the maximum count of Financial Period Calendars that can be created.

Returns:

the value in the field MaxFPCalendarCount

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

setMaxFPCalendarCount

public void setMaxFPCalendarCount(int i)
                           throws BusinessObjectException

Sets this is the maximum count of Financial Period Calendars that can be created.

Parameters:

i - the value to set this field to

Throws:

BusinessObjectException - if a problem occurred in the client-side business objects

getFilterableFields

public static String[] getFilterableFields()

Gets all fields that can be filtered.

Returns:

String[] an array of filterable fields

getInternalDefaultLoadFields

public static String[] getInternalDefaultLoadFields()

An internal method that should not be called directly by client code.

Returns:

String[] an internal array

getAllFields

public static String[] getAllFields()

Gets all fields for this business object.

Returns:

String[] an array of all fields

getInternalAllFields

public static String[] getInternalAllFields()

An internal method that should not be called directly by client code.

Returns:

String[] an internal array

getInternalAllFieldsSet

public static Set<String> getInternalAllFieldsSet()

An internal method that should not be called directly by client code.

Returns:

String[] an internal array

getWritableFields

public static String[] getWritableFields()

Gets all writable fields for this business object.

Returns:

String[] an array of writable fields

getDefaultXMLExportFields

@Deprecated
public static String[] getDefaultXMLExportFields()

Deprecated.

Gets the fields that are exported by the hierarchical XML exporter when no fields are specified. This method is no longer relevant since the hierarchical XML exporter has been replaced by the flat XML exporter.

Returns:

String[] an array of field names

getMinimumXMLExportFields

public static String[] getMinimumXMLExportFields()

Gets all fields that are always exported at a minimum by the new flat XML exporter

Returns:

String[] an array of exported fields

toString

public String toString()

Returns a string representation of the object. The output is in XML.

Overrides:

toString in class Object

Returns:

String a string representation of the object.

load

public static GlobalPreferences load(Session session,
 String[] fields)
                              throws ServerException,
NetworkException,
BusinessObjectException

Loads the GlobalPreferences object from the database.

Parameters:

session - the Session object

fields - fields to load

Returns:

GlobalPreferences the GlobalPreferences 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

update

public void update()
            throws ServerException,
NetworkException,
BusinessObjectException

Updates this GlobalPreferences object in the database.

Throws:

ServerException - if a problem occurred on the server-side

NetworkException - if a problem occurred in the network layer

BusinessObjectException - if a problem occurred in the client-side business objects