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

Class ActivityFilter

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

  • Constructor Details

    • ActivityFilter

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

    • ActivityFilter

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

    • ActivityFilter

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

    • getActivityFilterId

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

    • setActivityFilterId

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

    • getActivityFilterName

      public String getActivityFilterName() throws BusinessObjectException
      Gets name of the Activity Filter. 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 ActivityFilterName
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setActivityFilterName

      public void setActivityFilterName(String s) throws BusinessObjectException
      Sets name of the Activity Filter. 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

    • getUserId

      public ObjectId getUserId() throws BusinessObjectException
      Gets user Id in Activity Filter.
      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 user Id in Activity Filter.
      Parameters:
      o - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getFilterCriteria

      public String getFilterCriteria() throws BusinessObjectException
      Gets filter criteria for Activity Filter. 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 FilterCriteria
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setFilterCriteria

      public void setFilterCriteria(String s) throws BusinessObjectException
      Sets filter criteria for Activity Filter. 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

    • getFilterCriteriaConfig

      public String getFilterCriteriaConfig() throws BusinessObjectException
      Gets filter criteria Config for Activity Filter. 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 FilterCriteriaConfig
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setFilterCriteriaConfig

      public void setFilterCriteriaConfig(String s) throws BusinessObjectException
      Sets filter criteria Config for Activity Filter. 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

    • getFilterType

      public String getFilterType() throws BusinessObjectException
      Gets filter Type for Activity Filter.
      Returns:
      the value in the field FilterType
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setFilterType

      public void setFilterType(String s) throws BusinessObjectException
      Sets filter Type for Activity Filter.
      Parameters:
      s - the value to set this field to
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • getFilterGroup

      public String getFilterGroup() throws BusinessObjectException
      Gets filter Group for Activity Filter. 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 FilterGroup
      Throws:
      BusinessObjectException - if a problem occurred in the client-side business objects

    • setFilterGroup

      public void setFilterGroup(String s) throws BusinessObjectException
      Sets filter Group for Activity Filter. 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

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