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

Class JobService

java.lang.Object
com.primavera.integration.client.BOBase
com.primavera.integration.client.bo.BusinessObject
com.primavera.integration.client.bo.object.JobService
public class JobService extends BusinessObject
A Job Service.

See Also:   Quick reference of JobService fields

  • Constructor Details

    • JobService

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

    • JobService

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

    • JobService

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

    • 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

    • getName

      public String getName() throws BusinessObjectException
      Gets the name of job service.
      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 job service.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getImportXMLByte

      public String getImportXMLByte() throws BusinessObjectException
      Gets import byte array. 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 ImportXMLByte
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setImportXMLByte

      public void setImportXMLByte(String s) throws BusinessObjectException
      Sets import byte array. 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

    • getExportXMLByte

      public String[] getExportXMLByte() throws BusinessObjectException
      Gets export byte array. 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 ExportXMLByte
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setExportXMLByte

      public void setExportXMLByte(String[] s) throws BusinessObjectException
      Sets export byte array. 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

    • getExportPlfFileNames

      public String[] getExportPlfFileNames() throws BusinessObjectException
      Gets file Names of exported PLF files. 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 ExportPlfFileNames
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setExportPlfFileNames

      public void setExportPlfFileNames(String[] s) throws BusinessObjectException
      Sets file Names of exported PLF files. 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

    • getJobType

      public JobType getJobType() throws BusinessObjectException
      Gets the type of job service. 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 JobType
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setJobType

      public void setJobType(JobType enm) throws BusinessObjectException
      Sets the type of job service. This field must contain a valid value in order to create this type of business object in the database.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getJobTypeKey

      public String getJobTypeKey() throws BusinessObjectException
      Gets project ObjectId to be used by job.
      Returns:
      the value in the field JobTypeKey
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setJobTypeKey

      public void setJobTypeKey(String s) throws BusinessObjectException
      Sets project ObjectId to be used by job.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getJobStatus

      public JobStatus getJobStatus() throws BusinessObjectException
      Gets the status of the job.
      Returns:
      the value in the field JobStatus
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getCopyOptions

      public String getCopyOptions() throws BusinessObjectException
      Gets copyOptions for job service. 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 CopyOptions
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setCopyOptions

      public void setCopyOptions(String s) throws BusinessObjectException
      Sets copyOptions for job service. 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

    • getProjectInfo

      public String getProjectInfo() throws BusinessObjectException
      Gets projectInfo for job service. 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 ProjectInfo
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setProjectInfo

      public void setProjectInfo(String s) throws BusinessObjectException
      Sets projectInfo for job service. 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

    • getAddProjectInfo

      public String getAddProjectInfo() throws BusinessObjectException
      Gets addProjectInfo for job service. 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 AddProjectInfo
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setAddProjectInfo

      public void setAddProjectInfo(String s) throws BusinessObjectException
      Sets addProjectInfo for job service. 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

    • getLastRunDate

      public Date getLastRunDate() throws BusinessObjectException
      Gets lastRunDate for job service.
      Returns:
      the value in the field LastRunDate
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setLastRunDate

      public void setLastRunDate(Date d) throws BusinessObjectException
      Sets lastRunDate for job service.
      Parameters:
      d - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getUserId

      public ObjectId getUserId() throws BusinessObjectException
      Gets the job data for the job service.
      Returns:
      the value in the field UserId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setUserId

      public void setUserId(ObjectId o) throws BusinessObjectException
      Sets the job data for the job service.
      Parameters:
      o - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getJobData

      public String getJobData() throws BusinessObjectException
      Gets the job data for the job service.
      Returns:
      the value in the field JobData
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setJobData

      public void setJobData(String s) throws BusinessObjectException
      Sets the job data for the job service.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getJobDataX

      public String getJobDataX() throws BusinessObjectException
      Gets the job data X for the job service.
      Returns:
      the value in the field JobDataX
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setJobDataX

      public void setJobDataX(String s) throws BusinessObjectException
      Sets the job data X for the job service.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getJobRecurringType

      public JobRecurringType getJobRecurringType() throws BusinessObjectException
      Gets jobRecurringType for job service.
      Returns:
      the value in the field JobRecurringType
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setJobRecurringType

      public void setJobRecurringType(JobRecurringType enm) throws BusinessObjectException
      Sets jobRecurringType for job service.
      Parameters:
      enm - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getFileName

      public String getFileName() throws BusinessObjectException
      Gets exported File 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 FileName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setFileName

      public void setFileName(String s) throws BusinessObjectException
      Sets exported File Name. 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

    • getExportFilePath

      public String getExportFilePath() throws BusinessObjectException
      Gets exported file 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 ExportFilePath
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setExportFilePath

      public void setExportFilePath(String s) throws BusinessObjectException
      Sets exported file path. 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

    • getPlfDirName

      public String getPlfDirName() throws BusinessObjectException
      Gets plfDirName. 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 PlfDirName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setPlfDirName

      public void setPlfDirName(String s) throws BusinessObjectException
      Sets plfDirName. 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

    • getTargetWbsId

      public ObjectId getTargetWbsId() throws BusinessObjectException
      Gets targetWbsId for job service. 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 TargetWbsId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setTargetWbsId

      public void setTargetWbsId(ObjectId o) throws BusinessObjectException
      Sets targetWbsId for job service. 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

    • 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

    • 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 JobService object in the database.
      Returns:
      ObjectId the unique ID of the newly created JobService 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, JobService[] jobservices) throws ServerException, NetworkException, BusinessObjectException
      Creates multiple JobService objects in the database.
      Parameters:
      session - the Session object
      jobservices - array of JobService objects to create
      Returns:
      ObjectId[] the array of unique IDs of newly created JobService 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 JobService load(Session session, String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
      Loads a single JobService object from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objId - unique ID of the JobService object
      Returns:
      JobService the JobService 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<JobService> load(Session session, String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple JobService objects from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objIds - object ids of the JobService 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 JobService 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, JobService[] jobservices) throws ServerException, NetworkException, BusinessObjectException
      Updates multiple JobService objects in the database.
      Parameters:
      session - the Session object
      jobservices - array of JobService 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 JobService 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, JobService[] jobservices) throws ServerException, NetworkException, BusinessObjectException
      Deletes multiple JobService objects from the database.
      Parameters:
      session - the Session object
      jobservices - array of JobService 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