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

Class GlobalReplace

java.lang.Object
com.primavera.integration.client.BOBase
com.primavera.integration.client.bo.BusinessObject
com.primavera.integration.client.bo.object.GlobalReplace
public class GlobalReplace extends BusinessObject

Use this class to specify the template for Global replace.

See Also:   Quick reference of GlobalReplace fields

  • Constructor Details

    • GlobalReplace

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

    • GlobalReplace

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

    • GlobalReplace

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

    • getGreplaceObjectId

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

    • setGreplaceObjectId

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

    • getGlobalReplaceName

      public String getGlobalReplaceName() throws BusinessObjectException
      Gets the Global Replace Template 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 GlobalReplaceName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setGlobalReplaceName

      public void setGlobalReplaceName(String s) throws BusinessObjectException
      Sets the Global Replace Template 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

    • getGlobalReplaceData

      public String getGlobalReplaceData() throws BusinessObjectException
      Gets the GReplace Template Blob. 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 GlobalReplaceData
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setGlobalReplaceData

      public void setGlobalReplaceData(String s) throws BusinessObjectException
      Sets the GReplace Template Blob. 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

    • getUserObjectId

      public ObjectId getUserObjectId() throws BusinessObjectException
      Gets the unique ID of the associated user.
      Returns:
      the value in the field UserObjectId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setUserObjectId

      public void setUserObjectId(ObjectId o) throws BusinessObjectException
      Sets the unique ID of the associated user.
      Parameters:
      o - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getSubjectAreaType

      public String getSubjectAreaType() throws BusinessObjectException
      Gets the name of the object to be updated. 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 SubjectAreaType
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setSubjectAreaType

      public void setSubjectAreaType(String s) throws BusinessObjectException
      Sets the name of the object to be updated. 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

    • getSearchCriteria

      public String getSearchCriteria() throws BusinessObjectException
      Gets criteria to search and load the BOs. 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 SearchCriteria
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setSearchCriteria

      public void setSearchCriteria(String s) throws BusinessObjectException
      Sets criteria to search and load the BOs. 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

    • getReplaceFieldNameOne

      public String getReplaceFieldNameOne() throws BusinessObjectException
      Gets first replace field 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 ReplaceFieldNameOne
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setReplaceFieldNameOne

      public void setReplaceFieldNameOne(String s) throws BusinessObjectException
      Sets first replace field 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

    • getAllProjects

      public boolean getAllProjects() throws BusinessObjectException
      Gets the option used to set if all projects user has access is selected. 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 AllProjects
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setAllProjects

      public void setAllProjects(boolean b) throws BusinessObjectException
      Sets the option used to set if all projects user has access is selected. 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

    • getProjectIds

      public String getProjectIds() throws BusinessObjectException
      Gets comma seperated Project Ids. 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 ProjectIds
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setProjectIds

      public void setProjectIds(String s) throws BusinessObjectException
      Sets comma seperated Project Ids. 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

    • getProjectIdName

      public String getProjectIdName() throws BusinessObjectException
      Gets comma seperated Project Ids and Names. 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 ProjectIdName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setProjectIdName

      public void setProjectIdName(String s) throws BusinessObjectException
      Sets comma seperated Project Ids and Names. 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

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

    • load

      public static GlobalReplace load(Session session, String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
      Loads a single GlobalReplace object from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objId - unique ID of the GlobalReplace object
      Returns:
      GlobalReplace the GlobalReplace 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<GlobalReplace> load(Session session, String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple GlobalReplace objects from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objIds - object ids of the GlobalReplace 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 GlobalReplace 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, GlobalReplace[] globalreplace) throws ServerException, NetworkException, BusinessObjectException
      Updates multiple GlobalReplace objects in the database.
      Parameters:
      session - the Session object
      globalreplace - array of GlobalReplace 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