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

Class ScheduleOptions

java.lang.Object
com.primavera.integration.client.BOBase
com.primavera.integration.client.bo.BusinessObject
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 Details

    • 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 Details

    • 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 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 String getProjectId() throws BusinessObjectException
      Gets the short code that uniquely identifies the project. 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

    • getPriorityList

      public String[] getPriorityList() 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 PriorityList
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setPriorityList

      public void setPriorityList(String[] s) 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:
      s - 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

    • getMultipleFloatPathsEndingActivityShortName

      public String getMultipleFloatPathsEndingActivityShortName() 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 MultipleFloatPathsEndingActivityShortName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setMultipleFloatPathsEndingActivityShortName

      public void setMultipleFloatPathsEndingActivityShortName(String s) 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:
      s - 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

    • getResourceList

      public String[] getResourceList() 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 ResourceList
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setResourceList

      public void setResourceList(String[] s) 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:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getPreserveScheduledEarlyAndLateDates

      public boolean getPreserveScheduledEarlyAndLateDates() 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 PreserveScheduledEarlyAndLateDates
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setPreserveScheduledEarlyAndLateDates

      public void setPreserveScheduledEarlyAndLateDates(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

    • getLevelWithinFloat

      public boolean getLevelWithinFloat() 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 LevelWithinFloat
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setLevelWithinFloat

      public void setLevelWithinFloat(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

    • getMinFloatToPreserve

      public int getMinFloatToPreserve() 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 MinFloatToPreserve
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setMinFloatToPreserve

      public void setMinFloatToPreserve(int i) 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:
      i - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getOverAllocationPercentage

      public double getOverAllocationPercentage() 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 OverAllocationPercentage
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setOverAllocationPercentage

      public void setOverAllocationPercentage(double d) 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:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getLevelAllResources

      public boolean getLevelAllResources() 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 LevelAllResources
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setLevelAllResources

      public void setLevelAllResources(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

    • getIncludeExternalResAss

      public boolean getIncludeExternalResAss() 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 IncludeExternalResAss
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setIncludeExternalResAss

      public void setIncludeExternalResAss(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

    • getExternalProjectPriorityLimit

      public int getExternalProjectPriorityLimit() 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 ExternalProjectPriorityLimit
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setExternalProjectPriorityLimit

      public void setExternalProjectPriorityLimit(int i) 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:
      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 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 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 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 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 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.

    • 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.
      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, 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, 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.
      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