All Packages  This Package  Class Hierarchy  Class Search  Index

Class com.syncbuilder.storage.Record
java.lang.Object
   |
   +----com.syncbuilder.storage.Block
           |
           +----com.syncbuilder.storage.Record

  Summary

public abstract class  Record
     extends com.syncbuilder.storage.Block
{
          // Fields 5
     public static final int ARCHIVED;
     public static final int BUSY;
     public static final int DELETED;
     public static final int MODIFIED;
     public static final int SECRET;

          // Constructors 2
     public Record();
     public Record(byte[], RecordID, int, int, int) throws IllegalArgumentException;

          // Methods 20
     public String describe();
     public boolean equals(Object);
     public void fill();
     public int getCategory();
     public int getFlags();
     public RecordID getID();
     public int getIndex();
     public boolean isArchived();
     public boolean isBusy();
     public boolean isDeleted();
     public boolean isModified();
     public boolean isSecret();
     public void setArchived(boolean);
     public void setBusy(boolean);
     public void setCategory(int) throws IllegalArgumentException;
     public void setDeleted(boolean);
     public void setID(RecordID);
     public void setIndex(int);
     public void setModified(boolean);
     public void setSecret(boolean);
}

The base-class for representations of a database-record. This type is meant for storage-databases. The content of resource-databases is represented by com.syncbuilder.storage.Resource.

See Also: Resource


  Cross Reference

Extended By:
Record, Record, Record, Record, Record, Record, Record

Returned By:
Many





  Fields

· DELETED

Summary  |  Top
   public static final int DELETED


· MODIFIED

Summary  |  Top
   public static final int MODIFIED


· BUSY

Summary  |  Top
   public static final int BUSY


· SECRET

Summary  |  Top
   public static final int SECRET


· ARCHIVED

Summary  |  Top
   public static final int ARCHIVED


  Constructors

· Record

Summary  |  Top

   public Record() 


· Record

Summary  |  Top
   public Record(byte[] contents, 
                 RecordID id, 
                 int index, 
                 int attr, 
                 int category)  throws IllegalArgumentException

Create a Record with the specified content and attributes. The content which you specify as raw bytes is automatically processed by the unpack()-method to distribute it to the properties of the Record.

Parameter Description
contents the content in the native format of the PalmPilot application
id the ID of the Record, or null if the ID shall be assigned by the PalmOS during HotSync.
index the index of the Record
attr the attributes. Use the DELETED, MODIFIED, BUSY, SECRET, and ARCHIVED flags.
category the category of the Record. Use values from 0-15.



  Methods

· fill

Summary  |  Top
   public void fill() 

Initialize the Record. All attributes are set to false. Index will be 0. Category is 0. ID will be assigned by the PalmOS when the Record is written to the device.

Overrides:
fill in class Block


· describe

Summary  |  Top
   public String describe() 
Overrides:
describe in class Block


· equals

Summary  |  Top
   public boolean equals(Object obj) 

Determine the equality of this Record and some other Object.

Overrides:
equals in class Object


· isDeleted

Summary  |  Top
   public boolean isDeleted() 


· isModified

Summary  |  Top
   public boolean isModified() 


· isBusy

Summary  |  Top
   public boolean isBusy() 


· isSecret

Summary  |  Top
   public boolean isSecret() 


· isArchived

Summary  |  Top
   public boolean isArchived() 


· setDeleted

Summary  |  Top
   public void setDeleted(boolean flag) 


· setModified

Summary  |  Top
   public void setModified(boolean flag) 


· setBusy

Summary  |  Top
   public void setBusy(boolean flag) 


· setSecret

Summary  |  Top
   public void setSecret(boolean flag) 


· setArchived

Summary  |  Top
   public void setArchived(boolean flag) 


· getFlags

Summary  |  Top
   public int getFlags() 

Get a numerical representation of the flags



· getIndex

Summary  |  Top
   public int getIndex() 


· setIndex

Summary  |  Top
   public void setIndex(int index) 


· getID

Summary  |  Top
   public RecordID getID() 


· setID

Summary  |  Top
   public void setID(RecordID id) 


· getCategory

Summary  |  Top
   public int getCategory() 


· setCategory

Summary  |  Top
   public void setCategory(int category)  throws IllegalArgumentException


All Packages  This Package  Class Hierarchy  Class Search  Index
Freshly brewed Java API Documentation automatically generated with polardoc Version 1.0.7