/*
 * Copyright 2006-2012 Amazon Technologies, Inc. or its affiliates.
 * Amazon, Amazon.com and Carbonado are trademarks or registered trademarks
 * of Amazon Technologies, Inc. or its affiliates.  All rights reserved.
 *
 * 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.amazon.carbonado.stored;

import org.joda.time.DateTime;

import com.amazon.carbonado.Alias;
import com.amazon.carbonado.Storable;
import com.amazon.carbonado.FetchException;
import com.amazon.carbonado.Index;
import com.amazon.carbonado.Indexes;
import com.amazon.carbonado.Join;
import com.amazon.carbonado.PrimaryKey;
import com.amazon.carbonado.Query;
import com.amazon.carbonado.Sequence;

/**
 * 
 *
 * @author Brian S O'Neill
 */
@Alias("TEST_SHIPMENT")
@Indexes(@Index("+orderID"))
@PrimaryKey("shipmentID")
public interface Shipment extends Storable<Shipment> {
    @Sequence("TEST_SHIPMENT_ID_SEQ")
    long getShipmentID();
    void setShipmentID(long id);

    String getShipmentNotes();
    void setShipmentNotes(String value);

    DateTime getShipmentDate();
    void setShipmentDate(DateTime value);

    long getOrderID();
    void setOrderID(long value);

    @Join
    Order getOrder() throws FetchException;
    void setOrder(Order value);

    long getShipperID();
    void setShipperID(long value);

    @Join
    Shipper getShipper() throws FetchException;
    void setShipper(Shipper value);

    @Join
    Query<OrderItem> getOrderItems() throws FetchException;
}