EDBCommit.java

/**
 * Licensed to the Austrian Association for Software Tool Integration (AASTI)
 * under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright
 * ownership. The AASTI licenses this file to you under the Apache License,
 * Version 2.0 (the "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.openengsb.core.edb.api;

import java.util.List;
import java.util.UUID;

/**
 * A Commit object represents a change to the data source. It can either reflect a change that already happened in the
 * past, in which it will contain a list of OIDs which have been changed by this commit. Or a new change that is going
 * to be committed to the database. Then the commit is filled with objects, or deletions. When everything is prepared,
 * the commit() function can be executed to send the change over to the database. If a commit was committed once, it
 * throws an exception if you want to commit it again.
 */
public interface EDBCommit {
    /**
     * Add an object to be inserted. The object's timestamp must match the commit's timestamp.
     */
    void insert(EDBObject obj) throws EDBException;
    
    /**
     * Add an object to be updated. The object's timestamp must match the commit's timestamp.
     */
    void update(EDBObject obj) throws EDBException;

    /**
     * Delete an object that already exists.
     */
    void delete(String oid) throws EDBException;

    /**
     * For a created commit: retrieve the list of all objects that have been inserted to this commit.
     */
    List<EDBObject> getInserts();
    
    /**
     * For a created commit: retrieve the list of all objects that have been updated to this commit.
     */
    List<EDBObject> getUpdates();
    
    /**
     * For a created commit: retrieve the list of all objects that should be inserted or updated with this commit.
     */
    List<EDBObject> getObjects();

    /**
     * For both, a created, or a queried commit: Retrieve a list of deleted OIDs.
     */
    List<String> getDeletions();

    /**
     * Get the committer's name.
     */
    String getCommitter();

    /**
     * Get the commit's timestamp.
     */
    Long getTimestamp();

    /**
     * Get the commit's context id.
     */
    String getContextId();

    /**
     * returns if this commit was already committed
     */
    boolean isCommitted();

    /**
     * sets if the commit is already committed, should be called by the EnterpriseDatabaseService at the commit
     * procedure
     */
    void setCommitted(Boolean committed);

    /**
     * this setter should be called by the EnterpriseDatabaseService at the commit procedure
     */
    void setTimestamp(Long timestamp);
    
    /**
     * Returns the revision number for the EDBCommit object.
     */
    UUID getRevisionNumber();
    
    /**
     * Returns the revision number of the parent of the EDBCommit object.
     */
    UUID getParentRevisionNumber();
    
    /**
     * Sets the revision number of the parent of the EDBCommit object.
     */
    void setHeadRevisionNumber(UUID revisionNumber);
    
    /**
     * Returns the domain id from which this commit has been sent.
     */
    String getDomainId();
    
    /**
     * Sets the domain id from which this commit has been sent.
     */
    void setDomainId(String domainId);
    
    /**
     * Returns the connector id from which this commit has been sent.
     */
    String getConnectorId();
    
    /**
     * Sets the connector id from which this commit has been sent.
     */
    void setConnectorId(String connectorId);
    
    /**
     * Returns the instance id from which this commit has been sent.
     */
    String getInstanceId();
    
    /**
     * Sets the instance id from which this commit has been sent.
     */
    void setInstanceId(String instanceId);
    
    /**
     * Returns the comment to this commit.
     */
    String getComment();
    
    /**
     * Sets the comment for this commit.
     */
    void setComment(String comment);
}