com.viaoa.datasource.OADataSourceInterface Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of oa-core Show documentation
Object Automation library
The newest version!
/*  Copyright 1999 Vince Via [email protected]
    Licensed 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 com.viaoa.datasource;

import java.util.Iterator;

import com.viaoa.object.OAObject;
import com.viaoa.object.OAObjectInfo;
import com.viaoa.object.OAObjectKey;
import com.viaoa.util.OAFilter;

public interface OADataSourceInterface {

	boolean isClassSupported(Class clazz);

	boolean isClassSupported(Class clazz, OAFilter filter);

	boolean supportsStorage();

	boolean isAvailable();

	boolean getEnabled();

	void setEnabled(boolean b);

	boolean getAllowIdChange();

	void setAssignIdOnCreate(boolean b);

	boolean getAssignIdOnCreate();

	void assignId(OAObject object);

	boolean getSupportsPreCount();

	void close();

	void reopen(int pos);

	boolean willCreatePropertyValue(OAObject object, String propertyName);

	void save(OAObject obj);

	void update(OAObject object, String[] includeProperties, String[] excludeProperties);

	void update(OAObject obj);

	void insert(OAObject object);

	void insertWithoutReferences(OAObject obj);

	void delete(OAObject object);

	void deleteAll(Class c);

	void updateMany2ManyLinks(OAObject masterObject, OAObject[] adds, OAObject[] removes, String propFromMaster);

	/**
	 * @param selectClass
	 * @param queryWhere              where clause for selecting objects.
	 * @param params                  param values for "?" in the queryWhere.
	 * @param queryOrder              sort order
	 * @param whereObject             master object to select from.
	 * @param propertyFromWhereObject
	 * @param extraWhere              added to the query.
	 * @param max
	 * @param filter                  this can be used if the datasource does not support a way to query for the results.
	 * @param bDirty                  true if objects should be fully populated, even if they are already loaded (in cache, etc).
	 * @return
	 */
	Iterator select(Class selectClass,
			String queryWhere, Object[] params, String queryOrder,
			OAObject whereObject, String propertyFromWhereObject, String extraWhere,
			int max, OAFilter filter, boolean bDirty);

	Iterator selectPassthru(Class selectClass,
			String queryWhere, String queryOrder,
			int max, OAFilter filter, boolean bDirty);

	Object execute(String command);

	int count(Class selectClass,
			String queryWhere, Object[] params,
			OAObject whereObject, String propertyFromWhereObject, String extraWhere, int max);

	int countPassthru(Class selectClass,
			String queryWhere, int max);

	Object getObject(OAObjectInfo oi, Class clazz, OAObjectKey key, boolean bDirty);

	byte[] getPropertyBlobValue(OAObject obj, String propertyName);

	int getMaxLength(Class c, String propertyName);

	default void checkForCorruption() throws Exception {
	}

	default void backup(String location) throws Exception {
	}

	default void restore(String location) throws Exception {
	}

	default void compress() throws Exception {
	}

	/**
	 * Is this a client computer that needs to remotely connect to datasource on a server.
	 */
	default boolean isClient() {
		return false;
	}

}