package org.crosswire.xml;

/**
 * Copyright (c) 2001 CrossWire Bible Society. 
 * Distributable under the terms of the GNU GPL V2.
 */


import java.sql.Timestamp;

/** This object defines a filter criteria for gaining a set of XMLObjects
 *  @version $Id: XMLMetaData.java,v 1.3.2.2 2001/03/08 08:39:26 troy Exp $
 */

public interface XMLMetaData extends java.lang.Cloneable {

    public static final int TYPE = 1;
    public static final int SUBTYPE = 2;
    public static final int KEY1 = 3;
    public static final int KEY2 = 4;
    public static final int KEY3 = 5;
    public static final int TSCREATE = 6;
    public static final int TSLASTMOD = 7;
    public static final int TSMISC = 8;

    public static final int [] primaryKeys = new int [] { TYPE, SUBTYPE, KEY1, KEY2, KEY3 };
    public Object clone();

    public String toString();


    /** Sets the status of an xmlobject, the four
     *  statuses avaliable are ready = R,
     *  done = D, cancel = C, and
     *  Not Applicable = _
     */
    public XMLMetaData setObjectState(char value);


    /** Gets the state of the order.
     */
    public char getObjectState();


    /** Sets one of the three key value for
     *  xmlobject's metadata
     */
    public XMLMetaData setKey(int keyConstant, String value);


    /** Gets the key value for requested key
     *  from the xmlobject.
         */
    public String getKey(int keyConstant);


    /** Gets the Timestamp of the xmlobject.
     */
    public Timestamp getTimeStamp(int keyConstant);


    /** Sets any of the three Timestamps
     *  for an xmlobject with a
     *  timestamp value.
     */
    public XMLMetaData setTimeStamp(int keyConstant, Timestamp value);


    /** Gets the StatusMask
     */
    public String getStatusMask();


    /** Gets the current Status
     */
        // for uniqueMetaData (NA are turned to OFF)
    public long getStatusLong();


    /** Gets the current Status
     */
        // for uniqueMetaData (NA are turned to OFF)
    public String getStatus();


    /** Sets the Status of the xmlobject
     */
        public XMLMetaData setStatus(String sm);


    /** Sets the StatusMaskBit
     */
    public XMLMetaData setStatusMaskBit(int bit, char option);


    /** Sets the StatusMask
     */
    public XMLMetaData setStatusMask(long mask, char option);

    /** Gets a unique string that identifies this object
     * 
     * @return uid unique strin (<type>.<subtype>.<key1>.<key2>.<key3>)
     */
//    public String getUID();
    
    /** Sets unique string that identifies this object
     * 
     * @param uid unique string (<type>.<subtype>.<key1>.<key2>.<key3>)
     */
//    public void setUID(String uid);


}