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

Class LeanTask

java.lang.Object
com.primavera.integration.client.BOBase
com.primavera.integration.client.bo.BusinessObject
com.primavera.integration.client.bo.object.LeanTask
public class LeanTask extends BusinessObject
Lean tasks is associated with Prime projects and are displayed in P6 as a result of synchronization of projects from Prime to P6 .

See Also:   Quick reference of LeanTask fields

  • Constructor Details

    • LeanTask

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

    • LeanTask

      public LeanTask(Session session, ObjectId objId) throws BusinessObjectException
      Class constructor specifying the Session and ObjectId of the object. This constructor is most commonly used when update() will be called on this object.
      Parameters:
      session - the Session
      objId - the ObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • LeanTask

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

    • loadActivity

      public Activity loadActivity(String[] fields) throws ServerException, NetworkException, BusinessObjectException
      Loads an associated Activity object from the database.
      Parameters:
      fields - fields to load
      Returns:
      Activity the Activity 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

    • loadProject

      public Project loadProject(String[] fields) throws ServerException, NetworkException, BusinessObjectException
      Loads an associated Project object from the database.
      Parameters:
      fields - fields to load
      Returns:
      Project the Project object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • loadUDFValues

      public BOIterator<UDFValue> loadUDFValues(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple associated UDFValue objects from the database.
      Parameters:
      fields - fields to load
      sWhereClause - where clause
      sOrderBy - order-by clause
      Returns:
      BOIterator a business object iterator used to get the results of the load request
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getObjectId

      public ObjectId getObjectId() throws BusinessObjectException
      Gets the unique ID generated by the system. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Overrides:
      getObjectId in class BusinessObject
      Returns:
      the value in the field ObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setObjectId

      public void setObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID generated by the system. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Overrides:
      setObjectId in class BusinessObject
      Parameters:
      o - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getActivityObjectId

      public ObjectId getActivityObjectId() throws BusinessObjectException
      Gets the unique ID of the activity to which the lean tasks are assigned. This field is automatically loaded by default whenever this type of business object is loaded from the database. This field must contain a valid value in order to create this type of business object in the database.
      Returns:
      the value in the field ActivityObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setActivityObjectId

      public void setActivityObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the activity to which the lean tasks are assigned. This field is automatically loaded by default whenever this type of business object is loaded from the database. This field must contain a valid value in order to create this type of business object in the database.
      Parameters:
      o - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getActivityId

      public String getActivityId() throws BusinessObjectException
      Gets the short ID that uniquely identifies the activity within the project.
      Returns:
      the value in the field ActivityId
      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

    • getProjectId

      public String getProjectId() throws BusinessObjectException
      Gets the short code that uniquely identifies the project.
      Returns:
      the value in the field ProjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getName

      public String getName() throws BusinessObjectException
      Gets the name of the lean task.
      Returns:
      the value in the field Name
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setName

      public void setName(String s) throws BusinessObjectException
      Sets the name of the lean task.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getLeanTaskId

      public String getLeanTaskId() throws BusinessObjectException
      Gets the short name of the lean task. This field must contain a valid value in order to create this type of business object in the database.
      Returns:
      the value in the field LeanTaskId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setLeanTaskId

      public void setLeanTaskId(String s) throws BusinessObjectException
      Sets the short name of the lean task. This field must contain a valid value in order to create this type of business object in the database.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getSequenceNumber

      public int getSequenceNumber() throws BusinessObjectException
      Gets the sequence number for sorting.
      Returns:
      the value in the field SequenceNumber
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setSequenceNumber

      public void setSequenceNumber(int i) throws BusinessObjectException
      Sets the sequence number for sorting.
      Parameters:
      i - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getActivityName

      public String getActivityName() throws BusinessObjectException
      Gets the name of the activity. The activity name does not have to be unique.
      Returns:
      the value in the field ActivityName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getWBSObjectId

      public ObjectId getWBSObjectId() throws BusinessObjectException
      Gets the unique ID of the WBS for the activity. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Returns:
      the value in the field WBSObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getStartDate

      public Date getStartDate() throws BusinessObjectException
      Gets the date this lean task was started.
      Returns:
      the value in the field StartDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setStartDate

      public void setStartDate(Date d) throws BusinessObjectException
      Sets the date this lean task was started.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getIsUseOnlyWorkDays

      public boolean getIsUseOnlyWorkDays() throws BusinessObjectException
      Gets the flag that indicates whether to use only working days.
      Returns:
      the value in the field IsUseOnlyWorkDays
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setIsUseOnlyWorkDays

      public void setIsUseOnlyWorkDays(boolean b) throws BusinessObjectException
      Sets the flag that indicates whether to use only working days.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCompletedDate

      public Date getCompletedDate() throws BusinessObjectException
      Gets the date this lean task was completed.
      Returns:
      the value in the field CompletedDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setCompletedDate

      public void setCompletedDate(Date d) throws BusinessObjectException
      Sets the date this lean task was completed.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getDueDate

      public Date getDueDate() throws BusinessObjectException
      Gets the date this lean task will be due.
      Returns:
      the value in the field DueDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setDueDate

      public void setDueDate(Date d) throws BusinessObjectException
      Sets the date this lean task will be due.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getDuration

      public double getDuration() throws BusinessObjectException
      Gets number of days required for task to complete.
      Returns:
      the value in the field Duration
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setDuration

      public void setDuration(double d) throws BusinessObjectException
      Sets number of days required for task to complete.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCompany

      public String getCompany() throws BusinessObjectException
      Gets the name of the company working on the task.
      Returns:
      the value in the field Company
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setCompany

      public void setCompany(String s) throws BusinessObjectException
      Sets the name of the company working on the task.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getIsOverdue

      public boolean getIsOverdue() throws BusinessObjectException
      Gets flag set if task's due date is before current date.
      Returns:
      the value in the field IsOverdue
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setIsOverdue

      public void setIsOverdue(boolean b) throws BusinessObjectException
      Sets flag set if task's due date is before current date.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getFlag

      public boolean getFlag() throws BusinessObjectException
      Gets flag set to mark imp task.
      Returns:
      the value in the field Flag
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setFlag

      public void setFlag(boolean b) throws BusinessObjectException
      Sets flag set to mark imp task.
      Parameters:
      b - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getStatus

      public Status getStatus() throws BusinessObjectException
      Gets the status of the lean task.
      Returns:
      the value in the field Status
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setStatus

      public void setStatus(Status enm) throws BusinessObjectException
      Sets the status of the lean task.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getStatusCompletion

      public StatusCompletion getStatusCompletion() throws BusinessObjectException
      Gets the status of the lean task.
      Returns:
      the value in the field StatusCompletion
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setStatusCompletion

      public void setStatusCompletion(StatusCompletion enm) throws BusinessObjectException
      Sets the status of the lean task.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getTaskType

      public TaskType getTaskType() throws BusinessObjectException
      Gets the task type of the lean task.
      Returns:
      the value in the field TaskType
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setTaskType

      public void setTaskType(TaskType enm) throws BusinessObjectException
      Sets the task type of the lean task.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getStatusDates

      public StatusDates getStatusDates() throws BusinessObjectException
      Gets the status of the lean task.
      Returns:
      the value in the field StatusDates
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setStatusDates

      public void setStatusDates(StatusDates enm) throws BusinessObjectException
      Sets the status of the lean task.
      Parameters:
      enm - 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 lean task was created.
      Returns:
      the value in the field CreateDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getProposedDueDate

      public Date getProposedDueDate() throws BusinessObjectException
      Gets the proposed due date for the task.
      Returns:
      the value in the field ProposedDueDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setProposedDueDate

      public void setProposedDueDate(Date d) throws BusinessObjectException
      Sets the proposed due date for the task.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getLastUpdateDate

      public Date getLastUpdateDate() throws BusinessObjectException
      Gets the date this lean task 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 lean task.
      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 lean task.
      Returns:
      the value in the field LastUpdateUser
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getIsBaseline

      public boolean getIsBaseline() throws BusinessObjectException
      Gets the boolean value indicating if this business object is related to a Project or Baseline.
      Returns:
      the value in the field IsBaseline
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getIsTemplate

      public boolean getIsTemplate() throws BusinessObjectException
      Gets the boolean value indicating if this business object is related to a template Project.
      Returns:
      the value in the field IsTemplate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getRequiredCreateFields

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

    • getFilterableFields

      public static 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

    • getMainFields

      public static String[] getMainFields()
      Gets all fields in the main group for this business object.
      Returns:
      String[] an array of fields in this group

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

    • create

      public ObjectId create() throws ServerException, NetworkException, BusinessObjectException
      Creates this LeanTask object in the database.
      Returns:
      ObjectId the unique ID of the newly created LeanTask object
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • create

      public static ObjectId[] create(Session session, LeanTask[] leantasks) throws ServerException, NetworkException, BusinessObjectException
      Creates multiple LeanTask objects in the database.
      Parameters:
      session - the Session object
      leantasks - array of LeanTask objects to create
      Returns:
      ObjectId[] the array of unique IDs of newly created LeanTask objects
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • load

      public static LeanTask load(Session session, String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
      Loads a single LeanTask object from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objId - unique ID of the LeanTask object
      Returns:
      LeanTask the LeanTask 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<LeanTask> load(Session session, String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple LeanTask objects from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objIds - object ids of the LeanTask 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 LeanTask 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, LeanTask[] leantasks) throws ServerException, NetworkException, BusinessObjectException
      Updates multiple LeanTask objects in the database.
      Parameters:
      session - the Session object
      leantasks - array of LeanTask objects to update
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects

    • delete

      public void delete() throws ServerException, NetworkException, BusinessObjectException
      Deletes this LeanTask object from 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

    • delete

      public static void delete(Session session, LeanTask[] leantasks) throws ServerException, NetworkException, BusinessObjectException
      Deletes multiple LeanTask objects from the database.
      Parameters:
      session - the Session object
      leantasks - array of LeanTask objects to delete
      Throws:
      ServerException - if a problem occurred on the server-side
      NetworkException - if a problem occurred in the network layer
      BusinessObjectException - if a problem occurred in the client-side business objects