jSyncManager

org.jSyncManager.API.Protocol.Util.StdApps
Class MailAppBlock

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

public class MailAppBlock
extends DLPBlock

Application information block for the Palm Mail database.

Version:
$Revision: 1.9 $
Author:
Brad BARCLAY <bbarclay@jsyncmanager.org>
Last modified by: $Author: yaztromo $ on $Date: 2003/05/13 19:29:46 $.
See Also:
Serialized Form

Field Summary
static byte NO_UNSENT_MESSAGES
          Specifies that this database contains no unsent messages.
static byte SORT_BY_DATE
          Specifies that this database is sorted by date.
static byte SORT_BY_FROM
          Specifies that this database is sorted by sender.
static byte SORT_BY_SUBJECT
          Specifies that this database is sorted by subject.
 
Fields inherited from class org.jSyncManager.API.Protocol.Util.DLPBlock
blockSize, data
 
Constructor Summary
MailAppBlock()
          MailAppBlock default constructor.
MailAppBlock(DLPBlock block)
          Construct a new MailAppBlock from the specified DLPBlock object as read from the handhelds Mail database.
 
Method Summary
protected  void generateData()
          Generate the raw data block from the existing fields.
 CategoryInfo[] getCategories()
          Return an array of the category info blocks.
 char getDirtyAppInfo()
          Get the designator for whether the app info has changed and needs to be refreshed.
 byte getLastUniqueID()
          Get the last unique ID.
 int getNumCategories()
          Return the number of categories.
 char getSignatureOffset()
          Get the signature offset.
 byte getSortOrder()
          Get the sort order for the data records.
 long getUnsentMessage()
          Get the unsent message indicator value.
protected  void parseFields()
          Parse the data fields.
 void setDirtyAppInfo(char c)
          Set the designator for Whether the app info has changed and needs to be refreshed.
 void setLastUniqueID(byte b)
          Set the last unique ID value.
 void setSignatureOffset(char c)
          Set the signature offset.
 void setSortOrder(byte order)
          Set the sort order of this application block.
 void setUnsentMessage(long l)
          Set the unsent message indicator value.
 
Methods inherited from class org.jSyncManager.API.Protocol.Util.DLPBlock
getBlockSize, getData, setData, toString
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

SORT_BY_DATE

public static final byte SORT_BY_DATE
Specifies that this database is sorted by date.

SORT_BY_FROM

public static final byte SORT_BY_FROM
Specifies that this database is sorted by sender.

SORT_BY_SUBJECT

public static final byte SORT_BY_SUBJECT
Specifies that this database is sorted by subject.

NO_UNSENT_MESSAGES

public static final byte NO_UNSENT_MESSAGES
Specifies that this database contains no unsent messages.
Constructor Detail

MailAppBlock

public MailAppBlock()
MailAppBlock default constructor.

MailAppBlock

public MailAppBlock(DLPBlock block)
Construct a new MailAppBlock from the specified DLPBlock object as read from the handhelds Mail database.
Parameters:
block - the DLPBlock object to create this object from.
Method Detail

generateData

protected void generateData()
Generate the raw data block from the existing fields.
Overrides:
generateData in class DLPBlock

parseFields

protected void parseFields()
Parse the data fields.
Overrides:
parseFields in class DLPBlock

getNumCategories

public int getNumCategories()
Return the number of categories.
Returns:
the number of categories.

getSortOrder

public byte getSortOrder()
Get the sort order for the data records.
Returns:
the sort order for the data records.

setSortOrder

public void setSortOrder(byte order)
Set the sort order of this application block.
Parameters:
order - byte representation of the sort order.

getLastUniqueID

public byte getLastUniqueID()
Get the last unique ID.
Returns:
the last unique ID.

setLastUniqueID

public void setLastUniqueID(byte b)
Set the last unique ID value.
Parameters:
b - byte value of last unique ID.

getCategories

public CategoryInfo[] getCategories()
Return an array of the category info blocks.
Returns:
an array of the category info blocks.

getDirtyAppInfo

public char getDirtyAppInfo()
Get the designator for whether the app info has changed and needs to be refreshed.
Returns:
the dirty App info bitmap.

setDirtyAppInfo

public void setDirtyAppInfo(char c)
Set the designator for Whether the app info has changed and needs to be refreshed.
Parameters:
c - the dirty App info indicator.

getSignatureOffset

public char getSignatureOffset()
Get the signature offset.
Returns:
char Signature offset.

setSignatureOffset

public void setSignatureOffset(char c)
Set the signature offset.
Parameters:
char - Signature offset.

getUnsentMessage

public long getUnsentMessage()
Get the unsent message indicator value.
Returns:
the unsent message indicator value.

setUnsentMessage

public void setUnsentMessage(long l)
Set the unsent message indicator value.
Parameters:
l - Unsent message indicator value.

jSyncManager

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