org.eclipse.persistence.descriptors.MultitenantPolicy 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-B07

/*******************************************************************************
 * Copyright (c) 2011, 2015 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 v1.0 and Eclipse Distribution License v. 1.0 
 * which accompanies this distribution. 
 * The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
 * and the Eclipse Distribution License is available at 
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * Contributors:
 *     09/09/2011-2.3.1 Guy Pelletier 
 *       - 356197: Add new VPD type to MultitenantType 
 *     11/10/2011-2.4 Guy Pelletier 
 *       - 357474: Address primaryKey option from tenant discriminator column
 *     14/05/2012-2.4 Guy Pelletier  
 *       - 376603: Provide for table per tenant support for multitenant applications
 ******************************************************************************/  
package org.eclipse.persistence.descriptors;

import java.io.Serializable;

import org.eclipse.persistence.exceptions.DescriptorException;
import org.eclipse.persistence.internal.sessions.AbstractRecord;
import org.eclipse.persistence.internal.sessions.AbstractSession;
import org.eclipse.persistence.tools.schemaframework.TableDefinition;

/**
 * A multitenant interface.
 * 
 * @author Guy Pelletier
 * @since EclipseLink 2.3.1
 */
public interface MultitenantPolicy extends Serializable {
    public abstract void addToTableDefinition(TableDefinition tableDefinition);
    public abstract void addFieldsToRow(AbstractRecord row, AbstractSession session);
    public abstract MultitenantPolicy clone(ClassDescriptor descriptor);
    public abstract boolean isSingleTableMultitenantPolicy();
    public abstract boolean isSchemaPerMultitenantPolicy();
    public abstract boolean isTablePerMultitenantPolicy();
    public abstract void postInitialize(AbstractSession session);
    public abstract void initialize(AbstractSession session) throws DescriptorException;    
    public abstract void preInitialize(AbstractSession session) throws DescriptorException;
}