com.ibm.commerce.foundation.server.services.dataaccess

Interface PhysicalDataContainer

  • All Known Implementing Classes:
    PhysicalDataContainerImpl

    public interface PhysicalDataContainer
    This is an external interface for the physical data container that is used to perform create, update and delete (CRUD) operations on the physical entities.

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM Copyright statement

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      java.lang.Object createPhysicalObject(java.lang.Object owningObject, java.lang.Class objectClass)
      Create a physical entity of the specified entity class.
      java.lang.Long getNextPrimaryKey(java.lang.Class aClass)
      Gets the unique key for a database table represented by the given class (the mapping between the physical table name and class name is defined by the object-relational mapping).
      boolean getPagingRecordSetCompleteIndicator()
      Returns a boolean value to indicate whether or not you have reached the end of the result set.
      java.math.BigInteger getPagingRecordSetCount()
      Returns the number of records from the query result set returned by this request.
      java.lang.String getPagingRecordSetReferenceId()
      Returns a paging reference identifier for a paging request.
      java.math.BigInteger getPagingRecordSetStartNumber()
      This method returns the index of the first record to be retrieved from the query result set.
      java.math.BigInteger getPagingTotal()
      Returns the total number of physical objects which match the specified selection criteria in a paged search.
      java.util.List getPhysicalObjects()
      Gets the physical objects
      void removePhysicalObject(java.lang.Object entityObject)
      Removes the physical object from the objects associated with the container.
      void save()
      This method applies all the changes made to the entity objects stored by this physical data container.

    • Field Detail

      • COPYRIGHT

        static final java.lang.String COPYRIGHT
        IBM Copyright statement
        See Also:
        Constant Field Values

    • Method Detail

      • getPhysicalObjects

        java.util.List getPhysicalObjects()
        Gets the physical objects
        Returns:
        The physical objects

      • createPhysicalObject

        java.lang.Object createPhysicalObject(java.lang.Object owningObject,
                                      java.lang.Class objectClass)
        Create a physical entity of the specified entity class.
        Parameters:
        owningObject - The parent physical entity
        objectClass - The entity class
        Returns:
        The physical entity

      • removePhysicalObject

        void removePhysicalObject(java.lang.Object entityObject)
        Removes the physical object from the objects associated with the container. The change is persisted upon save.
        Parameters:
        entityObject - The entity object to be removed

      • save

        void save()
        This method applies all the changes made to the entity objects stored by this physical data container.

      • getNextPrimaryKey

        java.lang.Long getNextPrimaryKey(java.lang.Class aClass)
        Gets the unique key for a database table represented by the given class (the mapping between the physical table name and class name is defined by the object-relational mapping).
        Parameters:
        aClass - - class representing the physical table
        Returns:
        unique key

      • getPagingTotal

        java.math.BigInteger getPagingTotal()
        Returns the total number of physical objects which match the specified selection criteria in a paged search.
        Returns:
        the total number of the physical objects

      • getPagingRecordSetCompleteIndicator

        boolean getPagingRecordSetCompleteIndicator()
        Returns a boolean value to indicate whether or not you have reached the end of the result set.
        Returns:
        'true' if it is the last page, 'false' if there are more pages.

      • getPagingRecordSetReferenceId

        java.lang.String getPagingRecordSetReferenceId()
        Returns a paging reference identifier for a paging request. This identifier is used to resolve paging information on a subsequent request.
        Returns:
        the reference id of the paging record set

      • getPagingRecordSetStartNumber

        java.math.BigInteger getPagingRecordSetStartNumber()
        This method returns the index of the first record to be retrieved from the query result set.
        Returns:
        The index of the first record to be returned

      • getPagingRecordSetCount

        java.math.BigInteger getPagingRecordSetCount()
        Returns the number of records from the query result set returned by this request.
        Returns:
        number of records from the result set.
Skip navigation links