Solaris Common Desktop Environment: Programmer's Guide

Entry Attributes

Table 10-5 lists the entry attributes supported in the CDE implementation. See the relevant man page for more information. The list of entry attributes is extensible through the extended naming convention.

Table 10-5 CSA Entry Attibutes


Attribute Name	Symbolic Name	Server Version	Data Version	Read Only?
Audio Reminder	CSA_ENTRY_ATTR_AUDIO_REMINDER	2-5	1-4	No
Character Set*	CSA_X_DT_ENTRY_ATTR_CHARACTER_SET	5	4	No
Classification	CSA_ENTRY_ATTR_CLASSIFICATION	5	2-4	No
Date Completed	CSA_ENTRY_ATTR_DATE_COMPLETED	5	4	No
Date Created	CSA_ENTRY_ATTR_DATE_CREATED	5	4	Yes
Description	CSA_ENTRY_ATTR_DESCRIPTION	5	4	No
Due Date	CSA_ENTRY_ATTR_DUE_DATE	5	4	No
End Date	CSA_ENTRY_ATTR_END_DATE	2-5	1-4	No
Exception Dates	CSA_ENTRY_ATTR_EXCEPTION_DATES	5	4	No
Flashing Reminder	CSA_ENTRY_ATTR_FLASHING_REMINDER	2-5	1-4	No
Last Update	CSA_ENTRY_ATTR_LAST_UPDATE	5	4	Yes
Mail Reminder	CSA_ENTRY_ATTR_MAIL_REMINDER	2-5	1-4	No
Number Recurrences	CSA_ENTRY_ATTR_NUMBER_RECURRENCES	5	4	Yes
Organizer	CSA_ENTRY_ATTR_ORGANIZER	2-5	1-4	Yes
Popup Reminder	CSA_ENTRY_ATTR_POPUP_REMINDER	2-5	1-4	No
Priority	CSA_ENTRY_ATTR_PRIORITY	5	4	No
Recurrence Rule	CSA_ENTRY_ATTR_RECURRENCE_RULE	5	4	No
Reference Identifier	CSA_ENTRY_ATTR_REFERENCE_IDENTIFIER	2-5	1-4	Yes
Repeat Interval*	CSA_X_ENTRY_ATTR_REPEAT_INTERVAL	2-5	1-4	**
Repeat Occurrence*	CSA_X_ENTRY_ATTR_REPEAT_OCCURRENCE_NUM	2-5	1-4	**
Repeat Times*	CSA_X_ENTRY_ATTR_REPEAT_TIMES	2-5	1-4	**
Repeat Type*	CSA_X_DT_ENTRY_ATTR_REPEAT_TYPE	2-5	1-4	**
Sequence End Date*	CSA_X_ENTRY_ATTR_SEQUENCE_END_DATE	2-5	1-4	**
Showtimes*	CSA_X_ENTRY_ATTR_SHOWTIME	2-5	1-4	No
Sponsor	CSA_ENTRY_ATTR_SPONSOR	5	4	No
Start Date	CSA_ENTRY_ATTR_START_DATE	2-5	1-4	No
Status	CSA_ENTRY_ATTR_STATUS	2-5	1-4	No
Subtype	CSA_ENTRY_ATTR_SUBTYPE	2-5	1-4	No
Summary	CSA_ENTRY_ATTR_SUMMARY	2-5	1-4	No
Transparency	CSA_ENTRY_ATTR_TIME_TRANSPARENCY	5	4	No
Type	CSA_ENTRY_ATTR_TYPE	2-5	1-4	Yes***

* CDE only

** This attribute can be specified and modified for data version 1 to 3, but is read-only for data version 4; for data version 4, the value is derived from the entry attribute CSA_ENTRY_ATTR_RECURRENCE_RULE

***Specified when the entry is added to the calendar and read-only afterwards

The following Entry attributes are not supported:

CSA_ENTRY_ATTR_ATTENDEE_LIST
CSA_ENTRY_ATTR_EXCEPTION_RULE  
CSA_ENTRY_ATTR_RECURRING_DATES 
CSA_ENTRY_ATTR_SEQUENCE_NUMBER

The following descriptions provide additional information about some of the entry attributes listed in Table 10-5.

Organizer

The organizer of an entry is set to the user who is running the application that calls csa_add_entry() to add the entry to the calendar. It becomes read-only and cannot be changed after the entry is added.
Reference Identifier

The reference identifier of an entry is a string that contains a unique identifier of the entry within the calendar as well as the name and location of the calendar. The format is n:calendar@location where n is a number that uniquely identifies the entry within the calendar, calendar is the name of the calendar, and location is the name of the machine where the calendar is stored.
Status

The CDE implementation defines the following additional status values:

CSA_X_DT_STATUS_ACTIVE
CSA_X_DT_STATUS_DELETE_PENDING  	
CSA_X_DT_STATUS_ADD_PENDING 
CSA_X_DT_STATUS_COMMITTED 
CSA_X_DT_STATUS_CANCELLED

Type

The value becomes read-only and cannot be changed after the entry is added. The CDE implementation defines the following additional type value:

	CSA_X_DT_TYPE_OTHER

CDE Entry Attributes

The following are CDE-defined entry attributes:

Show Time

The value of this attribute indicates whether the start and end time of the entry should be shown to the user. It can be modified using csa_update_entry_attributes(). This attribute is a CSA_VALUE_SINT32 type of attribute.
Repeat Type

The frequency of recurrence of the entry, which indicates how often the entry repeats.

This attribute is a CSA_VALUE_UINT32 type of attribute.

The following values are defined:

CSA_X_DT_REPEAT_ONETIME
CSA_X_DT_REPEAT_DAILY  
CSA_X_DT_REPEAT_WEEKLY  
CSA_X_DT_REPEAT_BIWEEKLY 
CSA_X_DT_REPEAT_MONTHLY_BY_WEEKDAY  
CSA_X_DT_REPEAT_MONTHLY_BY_DATE 
CSA_X_DT_REPEAT_YEARLY 
CSA_X_DT_REPEAT_EVERY_NDAY 
CSA_X_DT_REPEAT_EVERY_NWEEK  
CSA_X_DT_REPEAT_EVERY_NMONTH 
CSA_X_DT_REPEAT_MON_TO_FRI  
CSA_X_DT_REPEAT_MONWEDFRI  
CSA_X_DT_REPEAT_TUETHUR
CSA_X_DT_REPEAT_WEEKDAYCOMBO 
CSA_X_DT_REPEAT_OTHER 
CSA_X_DT_REPEAT_OTHER_WEEKLY  
CSA_X_DT_REPEAT_OTHER_MONTHLY 
CSA_X_DT_REPEAT_OTHER_YEARLY

Repeat Times

This attribute shows the number of times an entry repeats. This attribute is a CSA_VALUE_UINT32 type of attribute.
Repeat Interval

This attribute tells how often an entry with repeat types CSA_X_DT_REPEAT_EVERY_NDAY, CSA_X_DT_REPEAT_EVERY_NWEEK, or CSA_X_DT_REPEAT_EVERY_NMONTH repeats. For example, if the value of this attribute is 3 and the repeat type is CSA_X_DT_REPEAT_EVERY_NWEEK, the entry repeats every three weeks. This attribute is a CSA_VALUE_UINT32 type of attribute.
Repeat Occurrence Number

If the entry's repeat type is CSA_X_DT_REPEAT_MONTHLY_BY_WEEKDAY, this attribute tells in which week the entry repeats. This attribute is a CSA_VALUE_SINT32 type of attribute.
Sequence End Date

This entry attribute shows the end date of the sequence. This attribute is a CSA_VALUE_DATE_TIME type of attribute.

Entry Attributes for Recurrence Information

For data versions 1 to 3, the following entry attributes are used to specify recurrence information for an entry. They are all read/write attributes.

CSA_X_DT_ENTRY_ATTR_REPEAT_TYPE
CSA_X_DT_ENTRY_ATTR_REPEAT_TIMES  
CSA_X_DT_ENTRY_ATTR_REPEAT_INTERVAL 
CSA_X_DT_ENTRY_ATTR_REPEAT_OCCURRENCE_NUM 
CSA_X_DT_ENTRY_ATTR_SEQUENCE_END_DATE

For data version 4, entry attributes CSA_ENTRY_ATTR_RECURRENCE_RULE and CSA_ENTRY_ATTR_EXCEPTION_DATES are used to specify recurrence information of a calendar entry. Information in the CSA_ENTRY_ATTR_RECURRENCE_RULE attribute can be queried using the following attributes:

CSA_X_DT_ENTRY_ATTR_REPEAT_TYPE
CSA_X_DT_ENTRY_ATTR_REPEAT_TIMES  
CSA_X_DT_ENTRY_ATTR_REPEAT_INTERVAL 
CSA_X_DT_ENTRY_ATTR_REPEAT_OCCURRENCE_NUM 
CSA_X_DT_ENTRY_ATTR_SEQUENCE_END_DATE

These computed attributes are read-only for data version 4.

Supported Values by Data Version

CSA_ENTRY_ATTR_STATUS

This attribute is not supported in data version 1.

Data versions 2 and 3 support the following values:

CSA_X_DT_STATUS_ACTIVE
CSA_X_DT_STATUS_DELETE_PENDING  
CSA_X_DT_STATUS_ADD_PENDING 
CSA_X_DT_STATUS_COMMITTED 
CSA_X_DT_STATUS_CANCELLED

Data version 4 supports all status values:

CSA_STATUS_ACCEPTED
CSA_STATUS_NEEDS_ACTION  
CSA_STATUS_SENT  
CSA_STATUS_TENTATIVE 
CSA_STATUS_CONFIRMED  
CSA_STATUS_REJECTED  
CSA_STATUS_COMPLETED 
CSA_STATUS_DELEGATED  
CSA_X_DT_STATUS_ACTIVE  
CSA_X_DT_STATUS_DELETE_PENDING 
CSA_X_DT_STATUS_ADD_PENDING  
CSA_X_DT_STATUS_COMMITTED 
CSA_X_DT_STATUS_CANCELLED

CSA_ENTRY_ATTR_SUBTYPE

Data versions 1 to 3 support the following values:

CSA_SUBTYPE_APPOINTMENT
CSA_SUBTYPE_HOLIDAY

Data version 4 supports all defined values as well as the following application-defined values:

CSA_SUBTYPE_APPOINTMENT
CSA_SUBTYPE_CLASS  
CSA_SUBTYPE_HOLIDAY  
CSA_SUBTYPE_MEETING 
CSA_SUBTYPE_MISCELLANEOUS  
CSA_SUBTYPE_PHONE_CALL  
CSA_SUBTYPE_SICK_DAY 
CSA_SUBTYPE_SPECIAL_OCCASION  
CSA_SUBTYPE_TRAVEL 
CSA_SUBTYPE_VACATION

CSA_ENTRY_ATTR_TYPE

Data versions 1 to 3 support the following values:

CSA_TYPE_EVENT 
CSA_TYPE_TODO  
CSA_X_DT_TYPE_OTHER

Data version 4 supports all defined values:

CSA_TYPE_EVENT 
CSA_TYPE_TODO  
CSA_TYPE_MEMO  
CSA_X_DT_TYPE_OTHER

Note -

Only some combinations of type and subtype values--listed below--are supported in data version 1 to 3.

Combinations supported in data version 1:

CSA_TYPE_EVENT with subtype CSA_SUBTYPE_APPOINTMENT  
CSA_X_DT_TYPE_OTHER with no subtype value

Combinations supported in data versions 2 and 3:

CSA_TYPE_EVENT with subtype CSA_SUBTYPE_APPOINTMENT  
CSA_TYPE_EVENT with subtype CSA_SUBTYPE_HOLIDAY  
CSA_TYPE_TODO with no subtype value  
CSA_X_DT_TYPE_OTHER with no subtype value

CSA_X_ENTRY_ATTR_REPEAT_TYPE

For data versions 1 to 3, this attribute is used to specify the type of recurrence of an entry.

Values supported in data versions 1 and 2:

CSA_X_DT_REPEAT_ONETIME
CSA_X_DT_REPEAT_DAILY  
CSA_X_DT_REPEAT_WEEKLY  
CSA_X_DT_REPEAT_BIWEEKLY 
CSA_X_DT_REPEAT_MONTHLY_BY_DATE 
CSA_X_DT_REPEAT_YEARLY

Values supported in data version 3:

CSA_X_DT_REPEAT_ONETIME
CSA_X_DT_REPEAT_DAILY  
CSA_X_DT_REPEAT_WEEKLY  
CSA_X_DT_REPEAT_BIWEEKLY 
CSA_X_DT_REPEAT_MONTHLY_BY_WEEKDAY  
CSA_X_DT_REPEAT_MONTHLY_BY_DATE 
CSA_X_DT_REPEAT_YEARLY  
CSA_X_DT_REPEAT_EVERY_NDAY 
CSA_X_DT_REPEAT_EVERY_NWEEK  
CSA_X_DT_REPEAT_EVERY_NMONTH 
CSA_X_DT_REPEAT_MON_TO_FRI  
CSA_X_DT_REPEAT_MONWEDFRI  
CSA_X_DT_REPEAT_TUETHUR
CSA_X_DT_REPEAT_WEEKDAYCOMBO 
CSA_X_DT_REPEAT_OTHER

For data version 4, this is a read-only attribute and the value is derived from the entry attribute CSA_ENTRY_ATTR_RECURRENCE_RULE.