isyncdocument.java

j2me sip客户端程序源码 提供了J2ME中SIP协议开发样例源码

/**
 * @(#)$RCSfile: ISyncDocument.java,v $            $Revision: 1.2 $
 *
 * ====================================================================
 * Copyright 2001, Reaxion Corp.,
 * 11418 105th PL NE, Kirkland, WA, 98033, USA
 * All rights reserved.
 * ====================================================================
 *
 * The contents of this file are subject to the Mozilla Public
 * License Version 1.1 (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.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS
 * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
 * implied. See the License for the specific language governing
 * rights and limitations under the License.
 *
 * The Original Code is the Tequila SyncML.
 *
 * The Initial Developer of the Original Code is Reaxion Corp.
 * All Rights Reserved.
 */
package com.reaxion.tequila.syncml.sync.doc;

import java.util.*;

import com.reaxion.tequila.syncml.*;
import com.reaxion.tequila.syncml.sync.stack.*;
/**
 * XML documend that is synchronized at the moment should implements this interface
 *
 * @version   $1.0$
 * @author    Oleg A. Oksyuk
 */
public interface ISyncDocument
{

    /**
     * @return     DocumentStack for this document
     */
    DocumentStack getDocumentStack();

    /**
     * @return     Database name for this document. (e.g. file name with this document
     */
    String getDbName();

    /**
     * Called when we begin to process a new package
     *
     * @param      aMsgId   package message id.
     */
    Enumeration startPackage(String aMsgId, boolean headerRespNeeded);

    /**
     * Called for each Command (Status/Alert/Sync) with this document as a target
     *
     * @param      inCommand   command to perform.
     * @return     the ennumeration of reply commands
     */
    Enumeration performCommand(SyncCmdIdOwner inCommand);

    /**
     * Called when we end to process a package
     *
     * @return     the ennumeration of commands that should be send
     *             in a reply for this package
     */
    Enumeration endPackage();

    /**
     * If the synchronization is finished for the document performs a sync session
     * 'finilization' for it.
     * Don't call this method if isSyncFinished returns true!!!
     *
     * @return  if the synchronization is finished for the document while this method processed
     */
    boolean tryToEndSync();

    /**
     * @return  if the synchronization is finished for the document
     */
    boolean isSyncFinished();
}

/* -----------------------------------------------------------------------------
 * Change log:
 * -----------------------------------------------------------------------------
 * $Log: ISyncDocument.java,v $
 * Revision 1.2  2001/10/17 15:27:42  OlegO
 * changed comments for better javadoc
 *
 * Revision 1.1.1.1  2001/10/11 13:13:32  OlegO
 * no message
 *
 * Revision 1.2  2001/07/27 07:44:52  OlegO
 * no message
 *
 */