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

Class AutovueAttr

java.lang.Object
com.primavera.integration.client.BOBase
com.primavera.integration.client.bo.BusinessObject
com.primavera.integration.client.bo.object.AutovueAttr
public class AutovueAttr extends BusinessObject
This needs to be updated. Newly added integration attributes.

See Also:   Quick reference of AutovueAttr fields

  • Constructor Details

    • AutovueAttr

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

    • AutovueAttr

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

    • AutovueAttr

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

    • getAVPropertyId

      public ObjectId getAVPropertyId() 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.
      Returns:
      the value in the field AVPropertyId
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setAVPropertyId

      public void setAVPropertyId(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.
      Parameters:
      o - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getDocumentExternalKey

      public String getDocumentExternalKey() throws BusinessObjectException
      Gets document id associated. 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 DocumentExternalKey
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setDocumentExternalKey

      public void setDocumentExternalKey(String s) throws BusinessObjectException
      Sets document id associated. 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:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getAVPropertyName

      public String getAVPropertyName() throws BusinessObjectException
      Gets name of the property. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Returns:
      the value in the field AVPropertyName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getAVPropertyLastUpdated

      public Date getAVPropertyLastUpdated() throws BusinessObjectException
      Gets date when this property was last updated. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Returns:
      the value in the field AVPropertyLastUpdated
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getAVPropertyExternalDocKey

      public String getAVPropertyExternalDocKey() throws BusinessObjectException
      Gets id of the external document. 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 AVPropertyExternalDocKey
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setAVPropertyExternalDocKey

      public void setAVPropertyExternalDocKey(String s) throws BusinessObjectException
      Sets id of the external document. 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:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getAVPropertyType

      public String getAVPropertyType() throws BusinessObjectException
      Gets name of the document type. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Returns:
      the value in the field AVPropertyType
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getAVCreateUser

      public String getAVCreateUser() throws BusinessObjectException
      Gets user created this property. This field is automatically loaded by default whenever this type of business object is loaded from the database.
      Returns:
      the value in the field AVCreateUser
      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 AutovueAttr object in the database.
      Returns:
      ObjectId the unique ID of the newly created AutovueAttr 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, AutovueAttr[] autovueattrs) throws ServerException, NetworkException, BusinessObjectException
      Creates multiple AutovueAttr objects in the database.
      Parameters:
      session - the Session object
      autovueattrs - array of AutovueAttr objects to create
      Returns:
      ObjectId[] the array of unique IDs of newly created AutovueAttr 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 AutovueAttr load(Session session, String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
      Loads a single AutovueAttr object from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objId - unique ID of the AutovueAttr object
      Returns:
      AutovueAttr the AutovueAttr 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<AutovueAttr> load(Session session, String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
      Loads multiple AutovueAttr objects from the database.
      Parameters:
      session - the Session object
      fields - fields to load
      objIds - object ids of the AutovueAttr 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 AutovueAttr 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, AutovueAttr[] autovueattrs) throws ServerException, NetworkException, BusinessObjectException
      Updates multiple AutovueAttr objects in the database.
      Parameters:
      session - the Session object
      autovueattrs - array of AutovueAttr 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 AutovueAttr 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, AutovueAttr[] autovueattrs) throws ServerException, NetworkException, BusinessObjectException
      Deletes multiple AutovueAttr objects from the database.
      Parameters:
      session - the Session object
      autovueattrs - array of AutovueAttr 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