A class to represent the structure and data of a record from the Contact handheld application
only for Palm T5
BIRTHDAY_FLAG
public static final long BIRTHDAY_FLAG
A flag to denote that a birthday is present in this record.
BIRTHDAY_FLAG_1
public static final long BIRTHDAY_FLAG_1
A flag to denote that a birthday is present in this record.
BIRTHDAY_FLAG_2
public static final long BIRTHDAY_FLAG_2
BIRTHDAY_REMEMBER_FLAG
public static final long BIRTHDAY_REMEMBER_FLAG
A flag to denote that a birthday-reminder is present in this record.
COMPANY_ADDRESS_FLAG
public static final long COMPANY_ADDRESS_FLAG
A flag to denote that an address is present in this record.
COMPANY_CITY_FLAG
public static final long COMPANY_CITY_FLAG
A flag to denote that a cite is present is this record.
COMPANY_COUNTRY_FLAG
public static final long COMPANY_COUNTRY_FLAG
A flag to denote that a country is present in this record.
COMPANY_FLAG
public static final long COMPANY_FLAG
A flag to denote that a company name is present in this record.
COMPANY_POSTALCODE_FLAG
public static final long COMPANY_POSTALCODE_FLAG
A flag to denote that a postal code is present in this record.
COMPANY_PROVINCE_FLAG
public static final long COMPANY_PROVINCE_FLAG
A flag to denote that a province/state is present is this record.
CUSTOM1_FLAG
public static final long CUSTOM1_FLAG
A flag to denote that the 1st Custom field is present in this record.
CUSTOM2_FLAG
public static final long CUSTOM2_FLAG
A flag to denote that the 2nd Custom field is present in this record.
CUSTOM3_FLAG
public static final long CUSTOM3_FLAG
A flag to denote that the 3rd Custom field is present in this record.
CUSTOM4_FLAG
public static final long CUSTOM4_FLAG
A flag to denote that the 4th Custom field is present in this record.
CUSTOM5_FLAG
public static final long CUSTOM5_FLAG
A flag to denote that the 5th Custom field is present in this record.
CUSTOM6_FLAG
public static final long CUSTOM6_FLAG
A flag to denote that the 6th Custom field is present in this record.
CUSTOM7_FLAG
public static final long CUSTOM7_FLAG
A flag to denote that the 7th Custom field is present in this record.
CUSTOM8_FLAG
public static final long CUSTOM8_FLAG
A flag to denote that the 8th Custom field is present in this record.
CUSTOM9_FLAG
public static final long CUSTOM9_FLAG
A flag to denote that the 9th Custom field is present in this record.
EMAIL_LABEL
public static final long EMAIL_LABEL
Denotes that this phone field is an e-mail address.
FAX_LABEL
public static final long FAX_LABEL
Denotes that this phone field is a facsimilie (fax) telephone number.
GIVENNAME_FLAG
public static final long GIVENNAME_FLAG
A flag to denote that a given name is present in this record.
HOME_LABEL
public static final long HOME_LABEL
Denotes that this phone field is a home telephone number.
IM1_FLAG
public static final long IM1_FLAG
A flag to denote that instantmessangernumber #1 is present in this record.
IM2_FLAG
public static final long IM2_FLAG
A flag to denote that instantmessangernumber #2 is present in this record.
MAIN_LABEL
public static final long MAIN_LABEL
Denotes that this phone field is a "main" telephone number.
MAX_ADDRESSES
public static final int MAX_ADDRESSES
The maximum number of address fields.
MAX_CUSTOMFIELDS
public static final int MAX_CUSTOMFIELDS
The maximum number of custom fields allowed.
MAX_INSTANTMESSENGERS
public static final int MAX_INSTANTMESSENGERS
The maximum number of instantmessangers allowed.
MAX_PHONELABELS
public static final int MAX_PHONELABELS
The maximum number of phone labels allowed.
MAX_PHONES
public static final int MAX_PHONES
The maximum number of phone/fax/mobile/e-mail fields.
MOBILE_LABEL
public static final long MOBILE_LABEL
Denotes that this phone field is a mobile/cellular telephone number.
NOTE_FLAG
public static final long NOTE_FLAG
A flag to denote that a note is present in this record.
OTHER_ADDRESS_FLAG
public static final long OTHER_ADDRESS_FLAG
A flag to denote that an address is present in this record.
OTHER_CITY_FLAG
public static final long OTHER_CITY_FLAG
A flag to denote that a cite is present is this record.
OTHER_COUNTRY_FLAG
public static final long OTHER_COUNTRY_FLAG
A flag to denote that a country is present in this record.
OTHER_LABEL
public static final long OTHER_LABEL
Denotes that this phone field is an "other" phone number.
OTHER_POSTALCODE_FLAG
public static final long OTHER_POSTALCODE_FLAG
A flag to denote that a postal code is present in this record.
OTHER_PROVINCE_FLAG
public static final long OTHER_PROVINCE_FLAG
A flag to denote that a province/state is present is this record.
PAGER_LABEL
public static final long PAGER_LABEL
Denotes that this phone field is a pager telephone number.
PHONE1_FLAG
public static final long PHONE1_FLAG
A flag to denote that phone entry #1 is present in this record.
PHONE2_FLAG
public static final long PHONE2_FLAG
A flag to denote that phone entry #2 is present in this record.
PHONE3_FLAG
public static final long PHONE3_FLAG
A flag to denote that phone entry #3 is present in this record.
PHONE4_FLAG
public static final long PHONE4_FLAG
A flag to denote that phone entry #4 is present in this record.
PHONE5_FLAG
public static final long PHONE5_FLAG
A flag to denote that phone entry #5 is present in this record.
PHONE6_FLAG
public static final long PHONE6_FLAG
A flag to denote that phone entry #6 is present in this record.
PHONE7_FLAG
public static final long PHONE7_FLAG
A flag to denote that phone entry #7 is present in this record.
PRIVATE_ADDRESS_FLAG
public static final long PRIVATE_ADDRESS_FLAG
A flag to denote that an address is present in this record.
PRIVATE_CITY_FLAG
public static final long PRIVATE_CITY_FLAG
A flag to denote that a cite is present is this record.
PRIVATE_COUNTRY_FLAG
public static final long PRIVATE_COUNTRY_FLAG
A flag to denote that a country is present in this record.
PRIVATE_POSTALCODE_FLAG
public static final long PRIVATE_POSTALCODE_FLAG
A flag to denote that a postal code is present in this record.
PRIVATE_PROVINCE_FLAG
public static final long PRIVATE_PROVINCE_FLAG
A flag to denote that a province/state is present is this record.
SURNAME_FLAG
public static final long SURNAME_FLAG
A flag to denote that a sur/family name is present in this record.
TITLE_FLAG
public static final long TITLE_FLAG
A flag to denote that a title (honourific) is present in this record.
WEBSITE_FLAG
public static final long WEBSITE_FLAG
A flag to denote that a bensite is present in this record.
WORK_LABEL
public static final long WORK_LABEL
Denotes that this phone field is a work telephone number.
bytesToArray
public static void bytesToArray(String name,
byte[] bytes)
checkFlags
public boolean checkFlags(long flags)
Check flags input long and return whether the flags are set or not.
flags - the flag to test.
- true if this flag is set, false otherwise.
generateData
public void generateData()
Generates a byte array representation of this object, storing it in this objects data byte
array.
- generateData in interface DLPRecord
getAddressField
public int getAddressField(int i)
Gets the specified address field type.
i - the index of the address field type to query.
- the address field type indentifier.
getAddressFieldTitle
public String getAddressFieldTitle(int fieldID)
Gets the title for the specified address field. This method will check the address field type
for the selected field ID, and will return the name of this field.
fieldID - the ID of the field to retreive the name for.
- the title for the specified address field.
getBirthday
public Date getBirthday()
Gets the birthday information from this record, if present. If birthday data is not present,
null will be returned.
- the information from the birthday field, or null if it's not present.
getBirthdayReminder
public boolean getBirthdayReminder()
Gets the birthday-reminder information from this record, if present. If birthday-reminder
data is not present, null will be returned.
- the information from the birthday-reminder field, or false if it's not present.
getCompany
public String getCompany()
Gets the company information from this record, if present. If company data is not present,
null will be returned.
- the information from the company field, or null if it's not present.
getCompanyAddress
public String getCompanyAddress()
getCompanyCity
public String getCompanyCity()
Gets the company-city information from this record, if present. If city data is not present,
null will be returned.
- the information from the company-city field, or null if it's not present.
getCompanyCountry
public String getCompanyCountry()
getCompanyPostalCode
public String getCompanyPostalCode()
getCompanyProvince
public String getCompanyProvince()
getCompanyState
public String getCompanyState()
getCustomField
public java.lang.String getCustomField(int i)
Gets the specified custom field information from this record, if present. If the specified
custom field data is not present, null will be returned.
i - the custom field to retreive data from.
- the information from the specified custom field, or null if it's not present.
getCustomFields
public java.lang.String[] getCustomFields()
Gets the custom field information from this record, if present.
- the custom field information from this record, if present.
getDisplayForList
public int getDisplayForList()
Returns the value of the "Display For List" flagset. This flagset is used to determine which
fields should be displayed as a part of the phone list.
- the value of the "Display For List" flagset.
getGivenName
public String getGivenName()
Gets the given (first) name information from this record, if present. If given name data is
not present, null will be returned.
- the information from the given name field, or null if it's not present.
getInstantmessanger
public java.lang.String getInstantmessanger(int i)
getInstantmessangerFieldTitle
public String getInstantmessangerFieldTitle(int fieldID)
Gets the title for the specified instantmessenger field. This method will check the
instantmessenger field type for the selected field ID, and will return the name of this
field.
fieldID - the ID of the field to retreive the name for.
- the title for the specified instantmessenger field.
getInstantmessengerField
public int getInstantmessengerField(int i)
Gets the specified instantmessenger field type.
i - the index of the instantmessenger field type to query.
- the instantmassenger field type indentifier.
getNote
public String getNote()
Gets the note information from this record, if present. If note data is not present, null
will be returned.
- the information from the note, or null if it's not present.
getOtherAddress
public String getOtherAddress()
getOtherCity
public String getOtherCity()
Gets the other-city information from this record, if present. If city data is not present,
null will be returned.
- the information from the other-city field, or null if it's not present.
getOtherCountry
public String getOtherCountry()
getOtherPostalCode
public String getOtherPostalCode()
getOtherProvince
public String getOtherProvince()
getOtherState
public String getOtherState()
getPhoneField
public int getPhoneField(int i)
Gets the specified phone field type.
i - the index of the phone field type to query.
- the phone field type indentifier.
getPhoneFieldTitle
public String getPhoneFieldTitle(int fieldID)
Gets the title for the specified phone field. This method will check the phone field type for
the selected field ID, and will return the name of this field.
fieldID - the ID of the field to retreive the name for.
- the title for the specified phone field.
getPhoneFields
public int[] getPhoneFields()
Gets the phone field type information. This method returns an array listing the phone fields
in use for this record, in order.
- the phone field information.
getPhones
public java.lang.String[] getPhones()
Gets all telephone data in this record, as Strings.
- all telephone data in this record, as Strings.
getPhones
public java.lang.String getPhones(int i)
Get the phone information for the specified field.
i - the index of the phone field to query.
- the phone information for the specified field.
getPhoto
public byte[] getPhoto()
Gets the photo information from this record, if present. If photo data is not present, null
will be returned.
The foto is a jpg-Image.
- the information from the photo field, or null if it's not present.
getPrivateAddress
public String getPrivateAddress()
Gets the address information from this record, if present. If address data is not present,
null will be returned.
- the information from the address field, or null if it's not present.
getPrivateCity
public String getPrivateCity()
Gets the private-city information from this record, if present. If city data is not present,
null will be returned.
- the information from the private-city field, or null if it's not present.
getPrivateCountry
public String getPrivateCountry()
Gets the country information from this record, if present. If country data is not present,
null will be returned.
- the information from the country field, or null if it's not present.
getPrivatePostalCode
public String getPrivatePostalCode()
Gets the postal (zip) code information from this record, if present. If postal code data is
not present, null will be returned.
- the information from the postal code field, or null if it's not present.
getPrivateProvince
public String getPrivateProvince()
Gets the province information from this record, if present. If province data is not present,
null will be returned.
- the information from the province field, or null if it's not present.
getPrivateState
public String getPrivateState()
Gets the state information from this record, if present. If state data is not present, null
will be returned. Note that this method is identical to calling getProvince().
- the information from the state field, or null if it's not present.
getSurname
public String getSurname()
Gets the surname (family name) information from this record, if present. If surname data is
not present, null will be returned.
- the information from the surname field, or null if it's not present.
getTitle
public String getTitle()
Gets the title (honourific) information from this record, if present. If title data is not
present, null will be returned.
- the information from the title field, or null if it's not present.
getWebsite
public String getWebsite()
setAddressField
public void setAddressField(int num,
int newValue)use setAddressType (changed parameter sequence matching setAddress to avoid
confusion).
Sets the type of a address.
num - the address entry index to set.newValue - the new type for the given address entry.
setAddressFields
public void setAddressFields(tmpOrders[] )
Sets the address fields for this record.
setAddressType
public void setAddressType(int newValue,
int num) Sets the type of a address field.
newValue - the new type for the given address entry.num - the index number for the address type to set.
setBirthday
public void setBirthday(Date newValue)
Sets the birthday line for this record.
newValue - the birthday line for this record.
setCompany
public void setCompany(String newValue)
Sets the company line for this record.
newValue - the company line for this record.
setCompanyAddress
public void setCompanyAddress(String newValue)
setCompanyCity
public void setCompanyCity(String newValue)
setCompanyCountry
public void setCompanyCountry(String newValue)
setCompanyPostalCode
public void setCompanyPostalCode(String newValue)
setCompanyProvince
public void setCompanyProvince(String newValue)
setCompanyState
public void setCompanyState(String newValue)
setCustomField
public void setCustomField(java.lang.String newValue,
int num) Sets the specified custom field to the specified data.
newValue - the data to set in the specified custom field.num - the custom field index to write the data to.
setCustomFields
public void setCustomFields(newValue[] )
Sets the custom fields for this record.
setDisplayForList
public void setDisplayForList(int newValue)
Sets the display for list bitmap to the specified value.
newValue - the new value for the display for list bitmap.
setFlags
public void setFlags(long flags,
boolean value) This method allows for the manual setting of the contents bitmap for this contact record. The
content bitmap is used to flag which elements of an contact record are present in this
record. When converting this object to a PalmOS-compatible buffer, elements flagged in the
bitmap will be included, while those not flagged are ignored. If value == true , all
flags are set to 1 ( true ) in contentFlags, otherwise they are are set to 0 (
false ).
flags - the flags which should be set / resetvalue - Boolean value of flags to be set / reset. ( true -> set, false ->
reset).
setGivenName
public void setGivenName(String newValue)
Sets the given name field for this record.
newValue - the given name field for this record.
setInstantmassenger
public void setInstantmassenger(java.lang.String newValue,
int num) Sets the specified instantmassenger field to the specified value.
newValue - the data to write to the specified instantmassenger entry.num - the index of the instantmassenger entry to write the specified data to.
setInstantmassengerField
public void setInstantmassengerField(int num,
int newValue)use setInstantmassengerType (changed parameter sequence matching
setInstantmassenger to avoid confusion).
Sets the type of a instantmassenger.
num - the instantmassenger entry index to set.newValue - the new type for the given instantmassenger entry.
setInstantmassengerFields
public void setInstantmassengerFields(tmpOrders[] )
Sets the instantmassenger fields for this record.
setInstantmassengerType
public void setInstantmassengerType(int newValue,
int num) Sets the type of a instantmassenger field.
newValue - the new type for the given instantmassenger entry.num - the index number for the instantmassenger type to set.
setInstantmassengers
public void setInstantmassengers(newValue[] )
Set the instantmassenger data array to the specified value.
setNote
public void setNote(String newValue)
Sets the note for this record.
newValue - the note for this record.
setOtherAddress
public void setOtherAddress(String newValue)
setOtherCity
public void setOtherCity(String newValue)
setOtherCountry
public void setOtherCountry(String newValue)
setOtherPostalCode
public void setOtherPostalCode(String newValue)
setOtherProvince
public void setOtherProvince(String newValue)
setOtherState
public void setOtherState(String newValue)
setPhone
public void setPhone(java.lang.String newValue,
int num) Sets the specified phone field to the specified value.
newValue - the data to write to the specified phone entry.num - the index of the phone entry to write the specified data to.
setPhoneField
public void setPhoneField(int num,
int newValue)use setPhoneType (changed parameter sequence matching setPhone to avoid
confusion).
Sets the type of a phone.
num - the phone entry index to set.newValue - the new type for the given phone entry.
setPhoneFields
public void setPhoneFields(tmpOrders[] )
Sets the telephone fields for this record.
setPhoneType
public void setPhoneType(int newValue,
int num) Sets the type of a phone field.
newValue - the new type for the given phone entry.num - the index number for the phone type to set.
setPhones
public void setPhones(newValue[] )
Set the phone data array to the specified value.
setPhoto
public void setPhoto(byte[] newValue)
Sets the photo for this record.
newValue - the note for this record.
setPrivateAddress
public void setPrivateAddress(String newValue)
Sets the address line for this record.
newValue - the address line for this record.
setPrivateCity
public void setPrivateCity(String newValue)
Sets the city line for this record.
newValue - the city line for this record.
setPrivateCountry
public void setPrivateCountry(String newValue)
Sets the country line for this record.
newValue - the country line for this record.
setPrivatePostalCode
public void setPrivatePostalCode(String newValue)
Sets the postal (zip) code line for this record.
newValue - the postal code line for this record.
setPrivateProvince
public void setPrivateProvince(String newValue)
Sets the province line for this record.
newValue - the province line for this record.
setPrivateState
public void setPrivateState(String newValue)
Sets the state line for this record. Note that this method is functionally identical to
setProvince().
newValue - the state line for this record.
setSurname
public void setSurname(String newValue)
Sets the surname (family name) line for this record.
newValue - the surname line for this record.
setTitle
public void setTitle(String newValue)
Sets the title (honourific) line for this record.
newValue - the title line for this record.
toString
public String toString()
Converts this contact record to a human-readable String.
- toString in interface DLPRecord
- this contact record as a human-readable String.
toString
public String toString(AddressAppBlock appBlock)
Converts this contact record to a human-readable String, using the specified contact
Application Block object. Calls to this toString method, with a valid Contact App Block
object are more specific, as we are able to retreive custom field titles, and other
database-global information.
- this contact record as a human-readable String.