/******************************************************************************
 * Copyright AllSeen Alliance. All rights reserved.
 *
 *    Permission to use, copy, modify, and/or distribute this software for any
 *    purpose with or without fee is hereby granted, provided that the above
 *    copyright notice and this permission notice appear in all copies.
 *
 *    THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 *    WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 *    MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 *    ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 *    WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 *    ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 *    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 ******************************************************************************/

package org.allseen.timeservice.ajinterfaces;

import org.alljoyn.bus.BusException;
import org.alljoyn.bus.BusObject;
import org.alljoyn.bus.annotation.BusInterface;
import org.alljoyn.bus.annotation.BusProperty;
import org.alljoyn.bus.annotation.Secure;
import org.allseen.timeservice.TimeServiceConst;

/**
 * Time Service Clock interface
 */
@BusInterface(name = Clock.IFNAME, announced = "true")
@Secure
public interface Clock extends BusObject {

    /**
     * The name of the AllJoyn interface
     */
    public static final String IFNAME = TimeServiceConst.IFNAME_PREFIX + ".Clock";

    /**
     * The version of this interface
     */
    public static final short VERSION = 1;

    /**
     * Returns the interface version
     * 
     * @return Interface version number
     * @throws BusException
     */
    @BusProperty(signature = "q")
    short getVersion() throws BusException;

    /**
     * Returns the DateTime object of the {@link Clock}
     * 
     * @return {@link DateTimeAJ}
     * @throws BusException
     */
    @BusProperty(signature = "((qyy)(yyyq)n)")
    DateTimeAJ getDateTime() throws BusException;

    /**
     * Set DateTime to the {@link Clock}
     * 
     * @param dateTime
     * @throws BusException
     */
    @BusProperty(signature = "((qyy)(yyyq)n)")
    void setDateTime(DateTimeAJ dateTime) throws BusException;

    /**
     * The property is set to TRUE when the {@link Clock} is set.
     * 
     * @return Returns TRUE if the {@link Clock} has been set since the last
     *         reboot
     * @throws BusException
     */
    @BusProperty(signature = "b")
    boolean getIsSet() throws BusException;
}