/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.resource.cci;
import java.util.Map;
import java.util.Collection;
import javax.resource.ResourceException;
import javax.resource.NotSupportedException;
/** The RecordFactory interface is used for creating MappedRecord and
* IndexedRecord instances. Note that the RecordFactory is only used
* for creation of generic record instances. A CCI implementation
* provides an implementation class for the RecordFactory interface.
*
* @author Rahul Sharma
* @since 0.8
* @see javax.resource.cci.IndexedRecord
* @see javax.resource.cci.MappedRecord
**/
public interface RecordFactory {
/** Creates a MappedRecord. The method takes the name of the record
* that is to be created by the RecordFactory. The name of the
* record acts as a pointer to the meta information (stored in
* the metadata repository) for a specific record type.
*
* @param recordName Name of the Record
* @return MappedRecord
* @throws ResourceException Failed to create a MappedRecord.
* Example error cases are:
*
* <UL>
* <LI> Invalid specification of record name
* <LI> Resource adapter internal error
* <LI> Failed to access metadata repository
* </UL>
* @throws NotSupportedException Operation not supported
*
**/
public
MappedRecord createMappedRecord(String recordName)
throws ResourceException;
/** Creates a IndexedRecord. The method takes the name of the record
* that is to be created by the RecordFactory. The name of the
* record acts as a pointer to the meta information (stored in
* the metadata repository) for a specific record type.
*
* @param recordName Name of the Record
* @return IndexedRecord
* @throws ResourceException Failed to create an IndexedRecord.
* Example error cases are:
*
* <UL>
* <LI> Invalid specification of record name
* <LI> Resource adapter internal error
* <LI> Failed to access metadata repository
* </UL>
* @throws NotSupportedException Operation not supported
**/
public
IndexedRecord createIndexedRecord(String recordName)
throws ResourceException;
}