Primavera Integration API 7.0

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

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.object.ScheduleOptions

public class ScheduleOptions
extends BusinessObject

Use this class to specify how the associated project is to be scheduled.

Note that this business object has a multi-part object ID; its object ID is a combination of its user object ID and its project object ID. The method createObjectId() can be used to create the multi-part object ID from the individual IDs. When loading schedule options from a project, the current user is always used. To access schedule options for other users, first create a multi-part object ID and then load the schedule options object directly.

You may not create or delete schedule options; they may only be loaded and updated.

See Also:   Quick reference of ScheduleOptions fields


Constructor Summary
ScheduleOptions(Session session)
          Class constructor specifying the Session.
ScheduleOptions(Session session, ObjectId objId)
          Class constructor specifying the Session and ObjectId of the object.
ScheduleOptions(Session session, ObjectId userObjectId, ObjectId projectObjectId)
          Class constructor specifying the Session and the individual components of the multi-part key: UserObjectId and ProjectObjectId.
ScheduleOptions(Session session, com.primavera.infr.db.PrmRowSet rowSet, int iIndex)
          Class constructor called internally after objects are retrieved from the server.
 
Method Summary
static ObjectId createObjectId(ObjectId userObjectId, ObjectId projectObjectId)
          Creates a multi-part ObjectId from two individual ObjectIds.
static java.lang.String[] getAllFields()
          Gets all fields for this business object.
 boolean getCalculateFloatBasedOnFinishDate()
          Gets the flag that indicates how each activity's float will be calculated with respect to other projects in the scheduling batch.
 ScheduleFloatType getComputeTotalFloatType()
          Gets the method for calculating total float for all activities.
 java.util.Date getCreateDate()
          Gets the date this schedule option was created.
 java.lang.String getCreateUser()
          Gets the name of the user that created this schedule option.
 Duration getCriticalActivityFloatThreshold()
          Gets the maximum float time for activities before they are marked critical.
 CriticalActivityPathType getCriticalActivityPathType()
          Gets the critical path type, which indicates how critical path activities are identified for the project, based on either 'Critical Float' or 'Longest Path'.
static java.lang.String[] getDefaultXMLExportFields()
          Gets the fields that are exported by the XML exporter when no fields are specified.
static java.lang.String[] getFilterableFields()
          Gets all fields that can be filtered.
 boolean getIgnoreOtherProjectRelationships()
          Gets the option used by the scheduler for treating activity relationships between projects when scheduling.
static java.lang.String[] getInternalAllFields()
          An internal method that should not be called directly by client code.
static java.util.Set<java.lang.String> getInternalAllFieldsSet()
          An internal method that should not be called directly by client code.
static java.lang.String[] getInternalDefaultLoadFields()
          An internal method that should not be called directly by client code.
 java.util.Date getLastUpdateDate()
          Gets the date this schedule option was last updated.
 java.lang.String getLastUpdateUser()
          Gets the name of the user that last updated this schedule option.
 boolean getLevelResourcesDuringScheduling()
          Gets the option used by the scheduler for automatically leveling resources when scheduling projects.
 boolean getMakeOpenEndedActivitiesCritical()
          Gets the option used by the scheduler for automatically leveling resources when scheduling projects.
 int getMaximumMultipleFloatPaths()
          Gets the number of critical float paths to calculate.
static java.lang.String[] getMinimumXMLExportFields()
          Gets all fields that are always exported at a minimum by the new flat XML exporter
 boolean getMultipleFloatPathsEnabled()
          Gets the Boolean value that indicates whether multiple critical float paths (sequences of activities) should be calculated in the project schedule.
 ObjectId getMultipleFloatPathsEndingActivityObjectId()
          Gets the activity in the WBS that you want to represent the end of the float paths.
 boolean getMultipleFloatPathsUseTotalFloat()
          Gets the Boolean value that decides whether or not to use total float in multiple float path calculations.
 ObjectId getObjectId()
          Gets the ObjectId for this object.
 OutOfSequenceScheduleType getOutOfSequenceScheduleType()
          Gets the type of logic used to schedule the progressed activities: 'Retained Logic', 'Progress Override', or 'Actual Dates'.
 java.lang.String getProjectId()
          Gets the short code that uniquely identifies the project.
 ObjectId getProjectObjectId()
          Gets the unique ID of the associated project.
 boolean getRecalculateResourceCosts()
          Gets the option used by the scheduler for recalculating the resource costs after scheduling the open projects.
 ScheduleRelationshipLagCalendar getRelationshipLagCalendar()
          Gets the calendar used to calculate the lag between predecessors and successors for all activities.
 boolean getStartToStartLagCalculationType()
          Gets the method used to calculate lag when a start-to-start relationship exists and the predecessor starts out of sequence.
 boolean getUseExpectedFinishDates()
          Gets the option used for setting activity finish dates as the expected finish dates when scheduling projects.
 java.lang.String getUserName()
          Gets the user's login name.
 ObjectId getUserObjectId()
          Gets the unique ID of the associated user.
static java.lang.String[] getWritableFields()
          Gets all writable fields for this business object.
static ScheduleOptions load(Session session, java.lang.String[] fields, ObjectId objId)
          Loads a single ScheduleOptions object from the database.
static BOIterator<ScheduleOptions> load(Session session, java.lang.String[] fields, ObjectId[] objIds)
          Loads multiple ScheduleOptions objects from the database.
 void setCalculateFloatBasedOnFinishDate(boolean b)
          Sets the flag that indicates how each activity's float will be calculated with respect to other projects in the scheduling batch.
 void setComputeTotalFloatType(ScheduleFloatType enm)
          Sets the method for calculating total float for all activities.
 void setCriticalActivityFloatThreshold(Duration d)
          Sets the maximum float time for activities before they are marked critical.
 void setCriticalActivityPathType(CriticalActivityPathType enm)
          Sets the critical path type, which indicates how critical path activities are identified for the project, based on either 'Critical Float' or 'Longest Path'.
 void setIgnoreOtherProjectRelationships(boolean b)
          Sets the option used by the scheduler for treating activity relationships between projects when scheduling.
 void setLevelResourcesDuringScheduling(boolean b)
          Sets the option used by the scheduler for automatically leveling resources when scheduling projects.
 void setMakeOpenEndedActivitiesCritical(boolean b)
          Sets the option used by the scheduler for automatically leveling resources when scheduling projects.
 void setMaximumMultipleFloatPaths(int i)
          Sets the number of critical float paths to calculate.
 void setMultipleFloatPathsEnabled(boolean b)
          Sets the Boolean value that indicates whether multiple critical float paths (sequences of activities) should be calculated in the project schedule.
 void setMultipleFloatPathsEndingActivityObjectId(ObjectId o)
          Sets the activity in the WBS that you want to represent the end of the float paths.
 void setMultipleFloatPathsUseTotalFloat(boolean b)
          Sets the Boolean value that decides whether or not to use total float in multiple float path calculations.
 void setOutOfSequenceScheduleType(OutOfSequenceScheduleType enm)
          Sets the type of logic used to schedule the progressed activities: 'Retained Logic', 'Progress Override', or 'Actual Dates'.
 void setRecalculateResourceCosts(boolean b)
          Sets the option used by the scheduler for recalculating the resource costs after scheduling the open projects.
 void setRelationshipLagCalendar(ScheduleRelationshipLagCalendar enm)
          Sets the calendar used to calculate the lag between predecessors and successors for all activities.
 void setStartToStartLagCalculationType(boolean b)
          Sets the method used to calculate lag when a start-to-start relationship exists and the predecessor starts out of sequence.
 void setUseExpectedFinishDates(boolean b)
          Sets the option used for setting activity finish dates as the expected finish dates when scheduling projects.
 java.lang.String toString()
          Returns a string representation of the object.
 void update()
          Updates this ScheduleOptions object in the database.
static void update(Session session, ScheduleOptions[] scheduleoptions)
          Updates multiple ScheduleOptions objects in the database.
 
Methods inherited from class com.primavera.integration.client.bo.BusinessObject
equals, hashCode, isNull, setNull, setObjectId
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ScheduleOptions

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

ScheduleOptions

public ScheduleOptions(Session session,
                       ObjectId objId)
                throws BusinessObjectException
Class constructor specifying the Session and ObjectId of the object. This constructor is most commonly used when update() is intended to be called on this object. For this particular object, the ObjectId is multi-part, created from the UserObjectId and ProjectObjectId field values. If you do not have the multi-part ObjectId already, it would be simpler to instead use the constructor that has multiple key parameters.

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

ScheduleOptions

public ScheduleOptions(Session session,
                       ObjectId userObjectId,
                       ObjectId projectObjectId)
                throws BusinessObjectException
Class constructor specifying the Session and the individual components of the multi-part key: UserObjectId and ProjectObjectId. This constructor is most commonly used when update() is intended to be called on this object.

Parameters:
session - the Session
userObjectId - the first ObjectId in the key
projectObjectId - the second ObjectId in the key
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

ScheduleOptions

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

createObjectId

public static ObjectId createObjectId(ObjectId userObjectId,
                                      ObjectId projectObjectId)
                               throws InvalidValueException
Creates a multi-part ObjectId from two individual ObjectIds.

Parameters:
userObjectId - the ObjectId of the associated user object.
projectObjectId - the ObjectId of the associated project object.
Returns:
ObjectId the multi-part ObjectId
Throws:
InvalidValueException - if one of the input parameters was invalid.
java.lang.IllegalArgumentException - if one of the input parameters was null.

getObjectId

public ObjectId getObjectId()
                     throws BusinessObjectException
Gets the ObjectId for this object. The ObjectId field serves as the primary key for the associated table in the database. For this object, the ObjectId is multi-part, consisting internally of the UserObjectId and ProjectObjectId fields.

Overrides:
getObjectId in class BusinessObject
Returns:
ObjectId the multi-part ObjectId of this object
Throws:
BusinessObjectException - if the ObjectId fields were not loaded.

load

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

Parameters:
session - the Session object
fields - fields to load
objId - unique ID of the ScheduleOptions object
Returns:
ScheduleOptions the ScheduleOptions 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<ScheduleOptions> load(Session session,
                                               java.lang.String[] fields,
                                               ObjectId[] objIds)
                                        throws ServerException,
                                               NetworkException,
                                               BusinessObjectException
Loads multiple ScheduleOptions objects from the database.

Parameters:
session - the Session object
fields - fields to load
objIds - object ids of the ScheduleOptions 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 ScheduleOptions 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,
                          ScheduleOptions[] scheduleoptions)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Updates multiple ScheduleOptions objects in the database.

Parameters:
session - the Session object
scheduleoptions - array of ScheduleOptions 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

getUserObjectId

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

Returns:
the value in the field UserObjectId
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

getUserName

public java.lang.String getUserName()
                             throws BusinessObjectException
Gets the user's login name. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getProjectId

public java.lang.String getProjectId()
                              throws BusinessObjectException
Gets the short code that uniquely identifies the project. This field is automatically loaded by default whenever this type of business object is loaded from the database. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getLevelResourcesDuringScheduling

public boolean getLevelResourcesDuringScheduling()
                                          throws BusinessObjectException
Gets the option used by the scheduler for automatically leveling resources when scheduling projects. This field may not be included in the where clause or order by clause specified when loading business objects.

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

setLevelResourcesDuringScheduling

public void setLevelResourcesDuringScheduling(boolean b)
                                       throws BusinessObjectException
Sets the option used by the scheduler for automatically leveling resources when scheduling projects. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getRecalculateResourceCosts

public boolean getRecalculateResourceCosts()
                                    throws BusinessObjectException
Gets the option used by the scheduler for recalculating the resource costs after scheduling the open projects. Enabling this option will calculate the costs of resource assignments that are assigned multiple resource rates. This field may not be included in the where clause or order by clause specified when loading business objects.

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

setRecalculateResourceCosts

public void setRecalculateResourceCosts(boolean b)
                                 throws BusinessObjectException
Sets the option used by the scheduler for recalculating the resource costs after scheduling the open projects. Enabling this option will calculate the costs of resource assignments that are assigned multiple resource rates. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getIgnoreOtherProjectRelationships

public boolean getIgnoreOtherProjectRelationships()
                                           throws BusinessObjectException
Gets the option used by the scheduler for treating activity relationships between projects when scheduling. This field may not be included in the where clause or order by clause specified when loading business objects.

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

setIgnoreOtherProjectRelationships

public void setIgnoreOtherProjectRelationships(boolean b)
                                        throws BusinessObjectException
Sets the option used by the scheduler for treating activity relationships between projects when scheduling. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getOutOfSequenceScheduleType

public OutOfSequenceScheduleType getOutOfSequenceScheduleType()
                                                       throws BusinessObjectException
Gets the type of logic used to schedule the progressed activities: 'Retained Logic', 'Progress Override', or 'Actual Dates'. This field may not be included in the where clause or order by clause specified when loading business objects.

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

setOutOfSequenceScheduleType

public void setOutOfSequenceScheduleType(OutOfSequenceScheduleType enm)
                                  throws BusinessObjectException
Sets the type of logic used to schedule the progressed activities: 'Retained Logic', 'Progress Override', or 'Actual Dates'. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getMakeOpenEndedActivitiesCritical

public boolean getMakeOpenEndedActivitiesCritical()
                                           throws BusinessObjectException
Gets the option used by the scheduler for automatically leveling resources when scheduling projects. This field may not be included in the where clause or order by clause specified when loading business objects.

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

setMakeOpenEndedActivitiesCritical

public void setMakeOpenEndedActivitiesCritical(boolean b)
                                        throws BusinessObjectException
Sets the option used by the scheduler for automatically leveling resources when scheduling projects. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getUseExpectedFinishDates

public boolean getUseExpectedFinishDates()
                                  throws BusinessObjectException
Gets the option used for setting activity finish dates as the expected finish dates when scheduling projects. This field may not be included in the where clause or order by clause specified when loading business objects.

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

setUseExpectedFinishDates

public void setUseExpectedFinishDates(boolean b)
                               throws BusinessObjectException
Sets the option used for setting activity finish dates as the expected finish dates when scheduling projects. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getStartToStartLagCalculationType

public boolean getStartToStartLagCalculationType()
                                          throws BusinessObjectException
Gets the method used to calculate lag when a start-to-start relationship exists and the predecessor starts out of sequence. Actual Start sets the successor's start according to the time elapsed from the predecessor's actual start (the successor's start date is the data date plus any remaining lag). Early Start sets the successor's start according to the amount of work that the predecessor activity accomplishes (the expired lag is calculated as the number of work periods between the actual start and the data date, and the successor's start date is the predecessor's internal early start plus any remaining lag). This field may not be included in the where clause or order by clause specified when loading business objects.

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

setStartToStartLagCalculationType

public void setStartToStartLagCalculationType(boolean b)
                                       throws BusinessObjectException
Sets the method used to calculate lag when a start-to-start relationship exists and the predecessor starts out of sequence. Actual Start sets the successor's start according to the time elapsed from the predecessor's actual start (the successor's start date is the data date plus any remaining lag). Early Start sets the successor's start according to the amount of work that the predecessor activity accomplishes (the expired lag is calculated as the number of work periods between the actual start and the data date, and the successor's start date is the predecessor's internal early start plus any remaining lag). This field may not be included in the where clause or order by clause specified when loading business objects.

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

getCriticalActivityFloatThreshold

public Duration getCriticalActivityFloatThreshold()
                                           throws BusinessObjectException
Gets the maximum float time for activities before they are marked critical. This field may not be included in the where clause or order by clause specified when loading business objects.

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

setCriticalActivityFloatThreshold

public void setCriticalActivityFloatThreshold(Duration d)
                                       throws BusinessObjectException
Sets the maximum float time for activities before they are marked critical. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getComputeTotalFloatType

public ScheduleFloatType getComputeTotalFloatType()
                                           throws BusinessObjectException
Gets the method for calculating total float for all activities. Start Float is the difference between the early and late start dates (Start Float = Late Start - Early Start); Finish Float is the difference between the early and late finish dates (Finish Float = Late Finish - Early Finish); and Smallest of Start Float and Finish Float is the most critical float value. This field may not be included in the where clause or order by clause specified when loading business objects.

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

setComputeTotalFloatType

public void setComputeTotalFloatType(ScheduleFloatType enm)
                              throws BusinessObjectException
Sets the method for calculating total float for all activities. Start Float is the difference between the early and late start dates (Start Float = Late Start - Early Start); Finish Float is the difference between the early and late finish dates (Finish Float = Late Finish - Early Finish); and Smallest of Start Float and Finish Float is the most critical float value. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getRelationshipLagCalendar

public ScheduleRelationshipLagCalendar getRelationshipLagCalendar()
                                                           throws BusinessObjectException
Gets the calendar used to calculate the lag between predecessors and successors for all activities. Valid values are 'Predecessor Activity Calendar', 'Successor Activity Calendar', '24 Hour Calendar', and 'Project Default Calendar'. If you do not select a calendar, the successor activity calendar is used. This field may not be included in the where clause or order by clause specified when loading business objects.

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

setRelationshipLagCalendar

public void setRelationshipLagCalendar(ScheduleRelationshipLagCalendar enm)
                                throws BusinessObjectException
Sets the calendar used to calculate the lag between predecessors and successors for all activities. Valid values are 'Predecessor Activity Calendar', 'Successor Activity Calendar', '24 Hour Calendar', and 'Project Default Calendar'. If you do not select a calendar, the successor activity calendar is used. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getCriticalActivityPathType

public CriticalActivityPathType getCriticalActivityPathType()
                                                     throws BusinessObjectException
Gets the critical path type, which indicates how critical path activities are identified for the project, based on either 'Critical Float' or 'Longest Path'. This field may not be included in the where clause or order by clause specified when loading business objects.

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

setCriticalActivityPathType

public void setCriticalActivityPathType(CriticalActivityPathType enm)
                                 throws BusinessObjectException
Sets the critical path type, which indicates how critical path activities are identified for the project, based on either 'Critical Float' or 'Longest Path'. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getMultipleFloatPathsEnabled

public boolean getMultipleFloatPathsEnabled()
                                     throws BusinessObjectException
Gets the Boolean value that indicates whether multiple critical float paths (sequences of activities) should be calculated in the project schedule. This field may not be included in the where clause or order by clause specified when loading business objects.

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

setMultipleFloatPathsEnabled

public void setMultipleFloatPathsEnabled(boolean b)
                                  throws BusinessObjectException
Sets the Boolean value that indicates whether multiple critical float paths (sequences of activities) should be calculated in the project schedule. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getMultipleFloatPathsUseTotalFloat

public boolean getMultipleFloatPathsUseTotalFloat()
                                           throws BusinessObjectException
Gets the Boolean value that decides whether or not to use total float in multiple float path calculations.

If True, then based on the activity you want the paths to end on, the module determines which predecessor activity has the most critical Relationship Total Float on the backward pass. The module repeats this process until an activity is reached that has no relationship. The module begins the forward pass from this activity and determines which successor activity has the most critical Relationship Successor Total Float. The module repeats this process until an activity is reached that has no relationship. These activities represent the most critical float path. The process begins again until the remaining sub-critical paths are calculated.

If False, then critical float paths are defined based on longest path. The most critical path will be identical to the critical path that is derived when you choose to define critical activities as Longest Path in the General tab. In a multicalendar project, the longest path is calculated by identifying the activities that have an early finish equal to the latest calculated early finish for the project and tracing all driving relationships for those activities back to the project start date. After the most critical path is identified, the module will calculate the remaining sub-critical paths.

This field may not be included in the where clause or order by clause specified when loading business objects.

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

setMultipleFloatPathsUseTotalFloat

public void setMultipleFloatPathsUseTotalFloat(boolean b)
                                        throws BusinessObjectException
Sets the Boolean value that decides whether or not to use total float in multiple float path calculations.

If True, then based on the activity you want the paths to end on, the module determines which predecessor activity has the most critical Relationship Total Float on the backward pass. The module repeats this process until an activity is reached that has no relationship. The module begins the forward pass from this activity and determines which successor activity has the most critical Relationship Successor Total Float. The module repeats this process until an activity is reached that has no relationship. These activities represent the most critical float path. The process begins again until the remaining sub-critical paths are calculated.

If False, then critical float paths are defined based on longest path. The most critical path will be identical to the critical path that is derived when you choose to define critical activities as Longest Path in the General tab. In a multicalendar project, the longest path is calculated by identifying the activities that have an early finish equal to the latest calculated early finish for the project and tracing all driving relationships for those activities back to the project start date. After the most critical path is identified, the module will calculate the remaining sub-critical paths.

This field may not be included in the where clause or order by clause specified when loading business objects.

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

getMultipleFloatPathsEndingActivityObjectId

public ObjectId getMultipleFloatPathsEndingActivityObjectId()
                                                     throws BusinessObjectException
Gets the activity in the WBS that you want to represent the end of the float paths. Typically, this will be a milestone activity or some other significant activity that has a start date or end date that cannot change. Note: if a value is not assigned, the module will choose an activity based on MultipleFloatPathsUseTotalFloat. If you are calculating multiple paths using Free Float, the module will choose the open-ended activity with the most critical Free Float. If you are calculating multiple paths using Total Float, the module will calculate the Total Float for all activity relationships, then choose the activity with the most critical Relationship Total Float. This field may not be included in the where clause or order by clause specified when loading business objects.

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

setMultipleFloatPathsEndingActivityObjectId

public void setMultipleFloatPathsEndingActivityObjectId(ObjectId o)
                                                 throws BusinessObjectException
Sets the activity in the WBS that you want to represent the end of the float paths. Typically, this will be a milestone activity or some other significant activity that has a start date or end date that cannot change. Note: if a value is not assigned, the module will choose an activity based on MultipleFloatPathsUseTotalFloat. If you are calculating multiple paths using Free Float, the module will choose the open-ended activity with the most critical Free Float. If you are calculating multiple paths using Total Float, the module will calculate the Total Float for all activity relationships, then choose the activity with the most critical Relationship Total Float. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getMaximumMultipleFloatPaths

public int getMaximumMultipleFloatPaths()
                                 throws BusinessObjectException
Gets the number of critical float paths to calculate. For example, if you set the field to five, the module calculates the five most critical float paths ending with the activity you selected. The module ranks each float path from most critical to least critical, and stores the value for each activity in the Float Path field. For example, if you calculate five float paths, the module will store a value of one in the Float Path field for each activity in the most critical float path; the module will store a value of five for each activity in the least critical float path. Note: To view the critical float paths after you schedule the project, group activities in the Activity Table by Float Path and sort by Float Path Order. A Float Path value of one indicates that those activities are part of the most critical float path. The Float Path Order value indicates the order in which the activities were processed. This field may not be included in the where clause or order by clause specified when loading business objects.

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

setMaximumMultipleFloatPaths

public void setMaximumMultipleFloatPaths(int i)
                                  throws BusinessObjectException
Sets the number of critical float paths to calculate. For example, if you set the field to five, the module calculates the five most critical float paths ending with the activity you selected. The module ranks each float path from most critical to least critical, and stores the value for each activity in the Float Path field. For example, if you calculate five float paths, the module will store a value of one in the Float Path field for each activity in the most critical float path; the module will store a value of five for each activity in the least critical float path. Note: To view the critical float paths after you schedule the project, group activities in the Activity Table by Float Path and sort by Float Path Order. A Float Path value of one indicates that those activities are part of the most critical float path. The Float Path Order value indicates the order in which the activities were processed. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getCalculateFloatBasedOnFinishDate

public boolean getCalculateFloatBasedOnFinishDate()
                                           throws BusinessObjectException
Gets the flag that indicates how each activity's float will be calculated with respect to other projects in the scheduling batch. This setting only has an effect when scheduling multiple projects at the same time. If true, each activity's float is calculated based on its project's ScheduledFinishDate. If false, then each activity's float is calculated based on the latest ScheduledFinishDate of all of the projects in the scheduling batch. This field may not be included in the where clause or order by clause specified when loading business objects.

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

setCalculateFloatBasedOnFinishDate

public void setCalculateFloatBasedOnFinishDate(boolean b)
                                        throws BusinessObjectException
Sets the flag that indicates how each activity's float will be calculated with respect to other projects in the scheduling batch. This setting only has an effect when scheduling multiple projects at the same time. If true, each activity's float is calculated based on its project's ScheduledFinishDate. If false, then each activity's float is calculated based on the latest ScheduledFinishDate of all of the projects in the scheduling batch. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getCreateDate

public java.util.Date getCreateDate()
                             throws BusinessObjectException
Gets the date this schedule option 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 schedule option 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 schedule option.

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 schedule option.

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

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.