Primavera Integration API 7.0

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

java.lang.Object
  extended by com.primavera.integration.client.BOBase
      extended by com.primavera.integration.client.bo.BusinessObject
          extended by com.primavera.integration.client.bo.base.CalendarBase
              extended by com.primavera.integration.client.bo.object.Calendar

public class Calendar
extends com.primavera.integration.client.bo.base.CalendarBase

Calendars defined the available work hours in each calendar day. Three types exist: global, resource, and project. Either resource or global calendars can be assigned to resources, and either global or project calendars can be assigned to activities.

You can specify national holidays, your organization's holidays, project-specific work/nonworkdays, and resource vacation days. Calendar assignments are used for activity scheduling, tracking, and resource leveling. Whether an activity uses its assigned calendar or the calendar of an assigned resource depends on the activity type you specify.

You can link resource and project calendars to global calendars. Then, if you make changes to a global calendar, your changes apply to all resource and project calendars that are linked to the modified global calendar.

You can get the total work hours or detailed work hours for a given date or day of the week using the methods getTotalWorkHours(), getDetailedWorkHours(), getStandardTotalWorkHours(), and getStandardDetailedWorkHours(). Detailed work hours provide information on specific worktime during the day, in half hour increments. To set work time for a particular date or day of the week, use the setDetailedWorkHours() and setStandardDetailedWorkHours() methods. To get a complete list of all dates for which holidays or exceptions are defined, use the method getHolidayExceptionDates().

See Also:   Quick reference of Calendar fields


Constructor Summary
Calendar(Session session)
          Class constructor specifying the Session.
Calendar(Session session, ObjectId objId)
          Class constructor specifying the Session and ObjectId of the object.
Calendar(Session session, com.primavera.infr.db.PrmRowSet rowSet, int iIndex)
          Class constructor called internally after objects are retrieved from the server.
 
Method Summary
 ObjectId create()
          Creates this Calendar object in the database.
static ObjectId[] create(Session session, Calendar[] calendars)
          Creates multiple Calendar objects in the database.
 void delete()
          Deletes this Calendar object from the database.
 void delete(ObjectId replacementId)
          Deletes this Calendar object from the database.
static void delete(Session session, Calendar[] calendars)
          Deletes multiple Calendar objects from the database.
static void delete(Session session, Calendar[] calendars, ObjectId replacementParent)
          Deletes multiple calendar objects in a hierarchy from the database and set the new parent of all child objects.
static java.lang.String[] getAllFields()
          Gets all fields for this business object.
 ObjectId getBaseCalendarObjectId()
          Gets the unique ID of the global calendar to which this calendar is linked.
 java.util.Date getCreateDate()
          Gets the date this calendar was created.
 java.lang.String getCreateUser()
          Gets the name of the user that created this calendar.
static java.lang.String[] getDefaultXMLExportFields()
          Gets the fields that are exported by the XML exporter when no fields are specified.
 DetailedWorkHours getDetailedWorkHours(java.util.Date date)
          Gets the detailed work hours for the given date.
static java.lang.String[] getFilterableFields()
          Gets all fields that can be filtered.
 java.util.List<java.util.Date> getHolidayExceptionDates()
          Gets a List (ordered by date) of all dates with holidays or exceptions in this calendar.
 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 java.lang.String[] getInternalAllFields()
          An internal method that should not be called directly by client code.
static java.util.Set<java.lang.String> getInternalAllFieldsSet()
          An internal method that should not be called directly by client code.
static java.lang.String[] getInternalDefaultLoadFields()
          An internal method that should not be called directly by client code.
 boolean getIsBaseline()
          Gets the boolean value indicating if this business object is related to a Project or Baseline.
 boolean getIsDefault()
          Gets the flag that identifies the default global calendar (applies to global calendars only).
 java.util.Date getLastUpdateDate()
          Gets the date this calendar was last updated.
 java.lang.String getLastUpdateUser()
          Gets the name of the user that last updated this calendar.
static java.lang.String[] getMinimumXMLExportFields()
          Gets all fields that are always exported at a minimum by the new flat XML exporter
 java.lang.String getName()
          Gets the name of the calendar.
 ObjectId getObjectId()
          Gets the unique ID generated by the system.
 ObjectId getProjectObjectId()
          Gets the unique ID of the associated project.
static java.lang.String[] getRequiredCreateFields()
          Gets all fields that must be set before calling create() on this business object.
 DetailedWorkHours getStandardDetailedWorkHours(int iDayOfWeek)
          Gets the standard detailed work hours for the given day of week.
 double getStandardTotalWorkHours(int iDayOfWeek)
          Get the standard total work hours for the given day of week.
 double getTotalWorkHours(java.util.Date date)
          Gets the total work hours and date for this given date.
 CalendarType getType()
          Gets the calendar type - either 'Global', 'Resource', or 'Project'.
static java.lang.String[] getWritableFields()
          Gets all writable fields for this business object.
static Calendar load(Session session, java.lang.String[] fields, ObjectId objId)
          Loads a single Calendar object from the database.
static BOIterator<Calendar> load(Session session, java.lang.String[] fields, ObjectId[] objIds)
          Loads multiple Calendar objects from the database.
 BOIterator<Activity> loadActivities(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated Activity objects from the database.
 Calendar loadBaseCalendar(java.lang.String[] fields)
          Loads an associated Calendar object from the database.
 Project loadProjectOwner(java.lang.String[] fields)
          Loads an associated Project object from the database.
 BOIterator<Project> loadProjects(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated Project objects from the database.
 BOIterator<Resource> loadResources(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated Resource objects from the database.
 void setBaseCalendarObjectId(ObjectId o)
          Sets the unique ID of the global calendar to which this calendar is linked.
 void setDetailedWorkHours(java.util.Date date, DetailedWorkHours hhdm)
          Set the detailed time hours for the given date.
 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 setIsDefault(boolean b)
          Sets the flag that identifies the default global calendar (applies to global calendars only).
 void setName(java.lang.String s)
          Sets the name of the calendar.
 void setObjectId(ObjectId o)
          Sets the unique ID generated by the system.
 void setProjectObjectId(ObjectId o)
          Sets the unique ID of the associated project.
 void setStandardDetailedWorkHours(int iDayOfWeek, DetailedWorkHours hhdm)
          Sets the standard detailed work hours for the given date.
 void setType(CalendarType enm)
          Sets the calendar type - either 'Global', 'Resource', or 'Project'.
 java.lang.String toString()
          Returns a string representation of the object.
 void update()
          Updates this Calendar object in the database.
 void update(boolean replaceHolidayOrExceptions)
          Updates this Calendar object in the database with the option to replace all holidays and exceptions.
static void update(Session session, Calendar[] calendars)
          Updates multiple Calendar objects in the database.
static void update(Session session, Calendar[] calendars, boolean replaceHolidayOrExceptions)
          Updates multiple Calendar objects in the database with the option to replace all holidays and exceptions.
 
Methods inherited from class com.primavera.integration.client.bo.BusinessObject
equals, hashCode, isNull, setNull
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Calendar

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

Calendar

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

Calendar

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

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

create

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

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

create

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

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

load

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

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

load

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

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

update

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

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

update

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

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

update

public void update(boolean replaceHolidayOrExceptions)
            throws ServerException,
                   NetworkException,
                   BusinessObjectException
Updates this Calendar object in the database with the option to replace all holidays and exceptions.

Overrides:
update in class com.primavera.integration.client.bo.base.CalendarBase
Parameters:
replaceHolidayOrExceptions - whether to replace all holidays and exceptions
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

update

public static void update(Session session,
                          Calendar[] calendars,
                          boolean replaceHolidayOrExceptions)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Updates multiple Calendar objects in the database with the option to replace all holidays and exceptions.

Parameters:
session - the Session object
calendars - array of Calendar objects to update
replaceHolidayOrExceptions - whether to replace all holidays and exceptions
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

delete

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

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

delete

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

Overrides:
delete in class BOBase
Parameters:
replacementId - unique ID of the new parent for all current child objects
Throws:
ServerException - if a problem occurred on the server-side
NetworkException - if a problem occurred in the network layer
BusinessObjectException - if a problem occurred in the client-side business objects

delete

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

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

delete

public static void delete(Session session,
                          Calendar[] calendars,
                          ObjectId replacementParent)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Deletes multiple calendar objects in a hierarchy from the database and set the new parent of all child objects.

Parameters:
session - the Session object
calendars - array of Calendar objects to delete
replacementParent - replacement parent 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

loadBaseCalendar

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

Parameters:
fields - fields to load
Returns:
Calendar the Calendar 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

loadProjectOwner

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

Parameters:
fields - fields to load
Returns:
Project the Project 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

loadProjects

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

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

loadResources

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

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

loadActivities

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

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

getTotalWorkHours

public double getTotalWorkHours(java.util.Date date)
                         throws BusinessObjectException
Gets the total work hours and date for this given date.

Overrides:
getTotalWorkHours in class com.primavera.integration.client.bo.base.CalendarBase
Parameters:
date - the date for which to get the total work hours
Returns:
Get the total work hours with the given date
Throws:
BusinessObjectException - if something was wrong in this Business object

getDetailedWorkHours

public DetailedWorkHours getDetailedWorkHours(java.util.Date date)
                                       throws BusinessObjectException
Gets the detailed work hours for the given date.

Overrides:
getDetailedWorkHours in class com.primavera.integration.client.bo.base.CalendarBase
Parameters:
date - the date for which to get work hours
Returns:
the detailed work hours
Throws:
BusinessObjectException - if something was wrong in this Business object

getStandardTotalWorkHours

public double getStandardTotalWorkHours(int iDayOfWeek)
                                 throws BusinessObjectException
Get the standard total work hours for the given day of week.

Overrides:
getStandardTotalWorkHours in class com.primavera.integration.client.bo.base.CalendarBase
Parameters:
iDayOfWeek - the day of week
Returns:
the standard total work hours
Throws:
BusinessObjectException - if something was wrong in this Business object

getStandardDetailedWorkHours

public DetailedWorkHours getStandardDetailedWorkHours(int iDayOfWeek)
                                               throws BusinessObjectException
Gets the standard detailed work hours for the given day of week.

Overrides:
getStandardDetailedWorkHours in class com.primavera.integration.client.bo.base.CalendarBase
Parameters:
iDayOfWeek - the day of week
Returns:
the standard detailed time hours
Throws:
BusinessObjectException - if something was wrong in this Business object

setDetailedWorkHours

public void setDetailedWorkHours(java.util.Date date,
                                 DetailedWorkHours hhdm)
                          throws BusinessObjectException
Set the detailed time hours for the given date.

Overrides:
setDetailedWorkHours in class com.primavera.integration.client.bo.base.CalendarBase
Parameters:
date - the date
hhdm - the detailed time hours
Throws:
BusinessObjectException - if something was wrong in this Business object

setStandardDetailedWorkHours

public void setStandardDetailedWorkHours(int iDayOfWeek,
                                         DetailedWorkHours hhdm)
                                  throws BusinessObjectException
Sets the standard detailed work hours for the given date.

Overrides:
setStandardDetailedWorkHours in class com.primavera.integration.client.bo.base.CalendarBase
Parameters:
iDayOfWeek - the day of week (from 1 to 7)
hhdm - the standard detailed time hours for the day of week
Throws:
BusinessObjectException - if something was wrong in this Business object

getHolidayExceptionDates

public java.util.List<java.util.Date> getHolidayExceptionDates()
                                                        throws BusinessObjectException
Gets a List (ordered by date) of all dates with holidays or exceptions in this calendar.

Overrides:
getHolidayExceptionDates in class com.primavera.integration.client.bo.base.CalendarBase
Returns:
a List (ordered by date) of all dates with holidays or exceptions
Throws:
BusinessObjectException - if something was wrong in this Business object

getObjectId

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

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

setObjectId

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

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

getProjectObjectId

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

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

setProjectObjectId

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

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

getType

public CalendarType getType()
                     throws BusinessObjectException
Gets the calendar type - either 'Global', 'Resource', or 'Project'. 'Global' calendars can be assigned to projects and resources. 'Resource' calendars can be assigned only to resources. 'Project' calendars are specific to projects. This field must contain a valid value in order to create this type of business object in the database.

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

setType

public void setType(CalendarType enm)
             throws BusinessObjectException
Sets the calendar type - either 'Global', 'Resource', or 'Project'. 'Global' calendars can be assigned to projects and resources. 'Resource' calendars can be assigned only to resources. 'Project' calendars are specific to projects. This field must contain a valid value in order to create this type of business object in the database.

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

getIsDefault

public boolean getIsDefault()
                     throws BusinessObjectException
Gets the flag that identifies the default global calendar (applies to global calendars only).

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

setIsDefault

public void setIsDefault(boolean b)
                  throws BusinessObjectException
Sets the flag that identifies the default global calendar (applies to global calendars only).

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

getBaseCalendarObjectId

public ObjectId getBaseCalendarObjectId()
                                 throws BusinessObjectException
Gets the unique ID of the global calendar to which this calendar is linked. Any changes to the global calendar are automatically propagated to this calendar. This field is automatically loaded by default whenever this type of business object is loaded from the database.

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

setBaseCalendarObjectId

public void setBaseCalendarObjectId(ObjectId o)
                             throws BusinessObjectException
Sets the unique ID of the global calendar to which this calendar is linked. Any changes to the global calendar are automatically propagated to this calendar. This field is automatically loaded by default whenever this type of business object is loaded from the database.

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

getName

public java.lang.String getName()
                         throws BusinessObjectException
Gets the name of the calendar. This field must contain a valid value in order to create this type of business object in the database.

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

setName

public void setName(java.lang.String s)
             throws BusinessObjectException
Sets the name of the calendar. This field must contain a valid value in order to create this type of business object in the database.

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

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

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

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

getCreateDate

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

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

getLastUpdateDate

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

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

getCreateUser

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

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

getLastUpdateUser

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

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

getIsBaseline

public boolean getIsBaseline()
                      throws BusinessObjectException
Gets the boolean value indicating if this business object is related to a Project or Baseline.

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

getRequiredCreateFields

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

Returns:
String[] an array of required create fields

getFilterableFields

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

Returns:
String[] an array of filterable fields

getInternalDefaultLoadFields

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

Returns:
String[] an internal array

getAllFields

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

Returns:
String[] an array of all fields

getInternalAllFields

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

Returns:
String[] an internal array

getInternalAllFieldsSet

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

Returns:
String[] an internal array

getWritableFields

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

Returns:
String[] an array of writable fields

getDefaultXMLExportFields

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

Returns:
String[] an array of field names

getMinimumXMLExportFields

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

Returns:
String[] an array of exported fields

toString

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

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

Primavera Integration API 7.0

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