jSyncManager

org.jSyncManager.API.Protocol.Util
Class DLPDatabaseInfo

java.lang.Object
  |
  +--org.jSyncManager.API.Protocol.Util.DLPDatabaseInfo
All Implemented Interfaces:
java.io.Serializable

public class DLPDatabaseInfo
extends java.lang.Object
implements java.io.Serializable

A class to store information on a handheld database. This class holds the information on a single database.

Version:
$Revision: 1.6 $
Author:
Brad BARCLAY <bbarclay@jsyncmanager.org>
Last modified by: $Author: yaztromo $ on $Date: 2003/05/14 03:51:27 $.
See Also:
Serialized Form

Field Summary
static byte EXCLUDE_FROM_SYNC
          A flag to denote that this database should be excluded from synchronization.
static byte RAM_BASED
          A flag to denote that this database is RAM based.
static char UNKNOWN_DB_INDEX
          A value denoting an unknown database index.
 
Constructor Summary
(package private) DLPDatabaseInfo()
          DLPDatabaseInfo default constructor.
  DLPDatabaseInfo(byte[] dbInfoData)
          DLPDatabaseInfo constructor, given the byte array data block.
 
Method Summary
 boolean checkDatabaseFlag(char c)
          Check the database flags against a char indicator to see if the flag is set.
 boolean checkMiscFlag(byte byte0)
          Check the Misc flags against a byte indicator to see if the flag is set.
 DLP_Date getBackupTime()
          Return the last backup time in DLP_Date format.
 DLP_Date getCreationTime()
          Return the creation time of this database in DLP_Date format.
 int getCreator()
          Return the creator ID for this database as an int value.
 java.lang.String getCreatorID()
          Return the creator ID for this database as an String value.
 char getDatabaseFlags()
           
 char getDatabaseIndex()
          Return the database index as a char value.
 byte getMiscFlags()
          Return the Misc flags as a byte value.
 int getModificationNumber()
          Return the modification number of this database as an int value.
 DLP_Date getModificationTime()
          Return the last modification time of this database as a DLP_Date object.
 java.lang.String getName()
          Return the name of this database as a String value.
 int getType()
          Return the type of this database as an int value.
 java.lang.String getTypeID()
          Return the type ID of this database as a String value.
(package private)  java.lang.String getUniqueDBID()
          Return the unique DB ID of this database as a String value.
 int getVersion()
          Return the version of this database as an int value.
(package private)  void setBackupTime(DLP_Date dlp_date)
          Set the backup time from a DLP_Date object.
(package private)  void setCreationTime(DLP_Date dlp_date)
          Set the creation time from a DLP_Date object.
(package private)  void setCreator(int i)
          Set the creator ID from an int value.
(package private)  void setDatabaseFlags(char c)
          Set the database flags from a char value.
(package private)  void setDatabaseIndex(char c)
          Set the database index from a char value.
(package private)  void setMiscFlags(byte byte0)
          Set the misc flags from a byte value.
(package private)  void setModificationNumber(int i)
          Set the modification number from an int value.
(package private)  void setModificationTime(DLP_Date dlp_date)
          Set the modification number from an DLP_Date value.
(package private)  void setName(java.lang.String s)
          Set the name of this database.
(package private)  void setType(int i)
          Set the type of this database from an int value.
(package private)  void setVersion(int i)
          Set the version of this database from an int value.
 java.lang.String toString()
          Return a String representation of this database info object.
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

EXCLUDE_FROM_SYNC

public static final byte EXCLUDE_FROM_SYNC
A flag to denote that this database should be excluded from synchronization.

RAM_BASED

public static final byte RAM_BASED
A flag to denote that this database is RAM based.

UNKNOWN_DB_INDEX

public static final char UNKNOWN_DB_INDEX
A value denoting an unknown database index.
Constructor Detail

DLPDatabaseInfo

DLPDatabaseInfo()
DLPDatabaseInfo default constructor.

DLPDatabaseInfo

public DLPDatabaseInfo(byte[] dbInfoData)
                throws DLPFunctionCallException
DLPDatabaseInfo constructor, given the byte array data block.
Parameters:
dbInfoData - byte[] data block.
Throws:
DLPFunctionCallException. -  
Method Detail

checkDatabaseFlag

public boolean checkDatabaseFlag(char c)
Check the database flags against a char indicator to see if the flag is set.
Parameters:
c - char flag to check if set.
Returns:
boolean.

checkMiscFlag

public boolean checkMiscFlag(byte byte0)
Check the Misc flags against a byte indicator to see if the flag is set.
Parameters:
byte0 - byte flag to check if set.
Returns:
boolean.

getBackupTime

public DLP_Date getBackupTime()
Return the last backup time in DLP_Date format.
Returns:
DLP_Date.

getCreationTime

public DLP_Date getCreationTime()
Return the creation time of this database in DLP_Date format.
Returns:
DLP_Date.

getCreator

public int getCreator()
Return the creator ID for this database as an int value.
Returns:
int.

getCreatorID

public java.lang.String getCreatorID()
Return the creator ID for this database as an String value.
Returns:
java.lang.String.

getDatabaseFlags

public char getDatabaseFlags()

getDatabaseIndex

public char getDatabaseIndex()
Return the database index as a char value.
Returns:
char databaseIndex.

getMiscFlags

public byte getMiscFlags()
Return the Misc flags as a byte value.
Returns:
byte miscFlags.

getModificationNumber

public int getModificationNumber()
Return the modification number of this database as an int value.
Returns:
int modificationNumber.

getModificationTime

public DLP_Date getModificationTime()
Return the last modification time of this database as a DLP_Date object.
Returns:
DLP_Date modificationTime.

getName

public java.lang.String getName()
Return the name of this database as a String value.
Returns:
java.lang.String name.

getType

public int getType()
Return the type of this database as an int value.
Returns:
int type.

getTypeID

public java.lang.String getTypeID()
Return the type ID of this database as a String value.
Returns:
java.lang.String type ID.

getUniqueDBID

java.lang.String getUniqueDBID()
Return the unique DB ID of this database as a String value.
Returns:
java.lang.String.

getVersion

public int getVersion()
Return the version of this database as an int value.
Returns:
int version.

setBackupTime

void setBackupTime(DLP_Date dlp_date)
Set the backup time from a DLP_Date object.
Parameters:
dlp_date - DLP_Date object.

setCreationTime

void setCreationTime(DLP_Date dlp_date)
Set the creation time from a DLP_Date object.
Parameters:
dlp_date - DLP_Date object.

setCreator

void setCreator(int i)
Set the creator ID from an int value.
Parameters:
i - int value of new creator ID.

setDatabaseFlags

void setDatabaseFlags(char c)
Set the database flags from a char value.
Parameters:
c - char value of database flags.

setDatabaseIndex

void setDatabaseIndex(char c)
Set the database index from a char value.
Parameters:
c - char value of new database index.

setMiscFlags

void setMiscFlags(byte byte0)
Set the misc flags from a byte value.
Parameters:
byte0 - byte value of misc flags.

setModificationNumber

void setModificationNumber(int i)
Set the modification number from an int value.
Parameters:
i - int value of new modification number.

setModificationTime

void setModificationTime(DLP_Date dlp_date)
Set the modification number from an DLP_Date value.
Parameters:
dlp_date - new DLP_Date modification time value.

setName

void setName(java.lang.String s)
Set the name of this database.
Parameters:
s - String new name.

setType

void setType(int i)
Set the type of this database from an int value.
Parameters:
i - int new type value.

setVersion

void setVersion(int i)
Set the version of this database from an int value.
Parameters:
i - int new version value.

toString

public java.lang.String toString()
Return a String representation of this database info object.
Overrides:
toString in class java.lang.Object
Returns:
String.

jSyncManager

Copyright (c) 1999 - 2003 Brad BARCLAY and others. All Rights Reserved.