source: OAIProvider/trunk/src/main/java/eu/clarin/oai/provider/Record.java @ 1914

package eu.clarin.oai.provider;

import java.util.Date;
import java.util.List;

import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamWriter;

/**
 * An item in the repository. This adapter interface is used by the OAI
 * provider to get items from the repository. The repository is expected
 * to set the required values.
 */
public interface Record {
    /**
     * Get the localId of the record. The returned object must be compatible
     * with repository's implementation of <code>parseLocalId</code> and
     * <code>unparseLocalId</code>.
     *
     * @returns the local Id object of the record
     * @see Repository#parseLocalId(String)
     * @see Repository#unparseLocalId(Object)
     */
    public Object getLocalId();
    
    /**
     * Get the last changed timestamp of the item.
     *
     * @return the last changed timestamp of the item
     * @see Repository#getGranularity()
     */
    public Date getDatestamp();

    /**
     * set deletion state of the record.
     *
     * @return <code>true</code> of the record is deleted, <code>false</code>
     *         otherwise
     * @see Repository#getDeletedNotion()            
     */
    public boolean isDeleted();

    /**
     * Get the sets to which this record belongs to.
     *
     * @return the list of sets to which the records belongs to or
     *         <code>null</code> if it does not belong to any sets or the
     *         repository does not support set
     */
    public List<String> getSetSpecs();

    public boolean supportsFormat(MetadataFormat format);

    public void writeRecord(XMLStreamWriter writer, MetadataFormat format)
            throws XMLStreamException, OAIException;
} // interface Record