org.eclipse.persistence.internal.sequencing.SequencingHome Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of eclipselink Show documentation

EclipseLink build based upon Git transaction 346465e

There is a newer version: 5.0.0-B05

/*
 * Copyright (c) 1998, 2023 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0,
 * or the Eclipse Distribution License v. 1.0 which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
 */

// Contributors:
//     Oracle - initial API and implementation from Oracle TopLink
package org.eclipse.persistence.internal.sequencing;

import org.eclipse.persistence.descriptors.ClassDescriptor;
import org.eclipse.persistence.sequencing.SequencingControl;

import java.util.Collection;

/**
 * 
 * Purpose: Define interface for getting all sequencing interfaces.
 * 

 * Description: This interface accessed through
 * DatabaseSession.getSequencingHome() method.
 * 

 * Responsibilities:
 * 

 *  Provides a hub for all sequencing interfaces used by DatabaseSession.
 * 
 * @see org.eclipse.persistence.internal.sessions.DatabaseSessionImpl
 * @see Sequencing
 * @see org.eclipse.persistence.sequencing.SequencingControl
 * @see SequencingServer
 * @see SequencingCallback
 */
public interface SequencingHome extends SequencingLogInOut {
    Sequencing getSequencing();

    SequencingControl getSequencingControl();

    SequencingServer getSequencingServer();

    boolean isSequencingCallbackRequired();

    void onAddDescriptors(Collection descriptors);
}