wt.calendar
Interface CalendarAccessProtocol

All Known Implementing Classes:

LocalCAP

public interface CalendarAccessProtocol

Abstract base class for iCalendar Access Protocol (CAP). The concrete children of this abstraction will provide the application layer processing and transport as needed for access to either local or remote calendar stores. The type of access to use will be specified in the WTDefault.properties wt.calendar.location property. For R5, only access to a local Windchill based calendar will be provided. In the R6 timeframe, if this property is set to remote; then an additional property, wt.calendar.URL, will specify the URL to the 3rd Party Calendar Server.

Supported API: false

Extendable: false

Method Summary

WTCalendar	createCalendar(WTPrincipalReference user, long start_date, long end_date, int zone_offset) This method will create the specified calendar component over the date range start-end inclusive.
CalendarComponent	createComponent(WTCalendar userCalendar, long start_date, long end_date, WTPrincipalReference delegate, boolean workingDay, int zone_offset) This method will create the specified calendar component over the date range start-end inclusive.
Vector	createComponents(WTCalendar userCalendar, long start_date, long end_date, WTPrincipalReference delegate, boolean workingDay, int zone_offset) This method will create the specified calendar component over the date range start-end inclusive.
boolean	deleteCalendar(WTPrincipalReference user, int zone_offset) This method will delete the specified calendar component type for the user over the date range start-end inclusive.
boolean	deleteComponent(WTCalendar userCalendar, long start_date, long end_date, int zone_offset) This method will delete the specified calendar component type for the user over the date range start-end inclusive.
boolean	deleteComponents(WTCalendar userCalendar, long start_date, long end_date, int zone_offset) This method will delete the specified calendar component type for the user over the date range start-end inclusive.
WTCalendar	readCalendar(int calObjType, WTPrincipalReference user, long start_date, long end_date, int zone_offset) Read out the user's calendar objects of the type specified between the dates start and end.
CalendarComponent	readComponent(WTCalendar userCalendar, long start_date, long end_date, int zone_offset) Modifies the calendar component object having date range start-end inclusive.
Vector	readComponents(WTCalendar userCalendar, long start_date, long end_date, int zone_offset) Modifies the calendar component object having date range start-end inclusive.
WTCalendar	updateCalendar(WTPrincipalReference user, WTPrincipalReference indefinite_delegate, long indefinite_delegate_date, int zone_offset) Modifies the calendar object type(s) over the date range start-end inclusive.
CalendarComponent	updateComponent(WTCalendar userCalendar, long start_date, long end_date, boolean workingDay, int zone_offset) Modifies the calendar object type(s) over the date range start-end inclusive.
CalendarComponent	updateComponent(WTCalendar userCalendar, long start_date, long end_date, WTPrincipalReference delegate, boolean workingDay, int zone_offset) Modifies the calendar object type(s) over the date range start-end inclusive.
CalendarComponent	updateComponent(WTCalendar userCalendar, long start_date, long end_date, WTPrincipalReference delegate, int zone_offset) Modifies the calendar object type(s) over the date range start-end inclusive.
Vector	updateComponents(WTCalendar userCalendar, long start_date, long end_date, boolean workingDay, int zone_offset) Modifies the calendar object type(s) over the date range start-end inclusive.
Vector	updateComponents(WTCalendar userCalendar, long start_date, long end_date, WTPrincipalReference delegate, boolean workingDay, int zone_offset) Modifies the calendar object type(s) over the date range start-end inclusive.
Vector	updateComponents(WTCalendar userCalendar, long start_date, long end_date, WTPrincipalReference delegate, int zone_offset) Modifies the calendar object type(s) over the date range start-end inclusive.

Method Detail

createCalendar

public WTCalendar createCalendar(WTPrincipalReference user,
                                 long start_date,
                                 long end_date,
                                 int zone_offset)
                          throws CalendarException

This method will create the specified calendar component over the date range start-end inclusive. Returns true if successful.

Supported API: false

Parameters:

user -

start_date -

end_date -

zone_offset -

Returns:

WTCalendar

Throws:

CalendarException

readCalendar

public WTCalendar readCalendar(int calObjType,
                               WTPrincipalReference user,
                               long start_date,
                               long end_date,
                               int zone_offset)
                        throws CalendarException

Read out the user's calendar objects of the type specified between the dates start and end. Returns the objects in a vector..

Supported API: false

Parameters:

calObjType -

user -

start_date -

end_date -

zone_offset -

Returns:

WTCalendar

Throws:

CalendarException

updateCalendar

public WTCalendar updateCalendar(WTPrincipalReference user,
                                 WTPrincipalReference indefinite_delegate,
                                 long indefinite_delegate_date,
                                 int zone_offset)
                          throws CalendarException

Modifies the calendar object type(s) over the date range start-end inclusive. Return true if successfull.

Supported API: false

Parameters:

user -

indefinite_delegate -

indefinite_delegate_date -

zone_offset -

Returns:

WTCalendar

Throws:

CalendarException

deleteCalendar

public boolean deleteCalendar(WTPrincipalReference user,
                              int zone_offset)
                       throws CalendarException

This method will delete the specified calendar component type for the user over the date range start-end inclusive. Returns true if successfull.

Supported API: false

Parameters:

user -

zone_offset -

Returns:

boolean

Throws:

CalendarException

createComponent

public CalendarComponent createComponent(WTCalendar userCalendar,
                                         long start_date,
                                         long end_date,
                                         WTPrincipalReference delegate,
                                         boolean workingDay,
                                         int zone_offset)
                                  throws CalendarException

This method will create the specified calendar component over the date range start-end inclusive. Returns true if successful.

Supported API: false

Parameters:

userCalendar -

start_date -

end_date -

delegate -

workingDay -

zone_offset -

Returns:

CalendarComponent

Throws:

CalendarException

readComponent

public CalendarComponent readComponent(WTCalendar userCalendar,
                                       long start_date,
                                       long end_date,
                                       int zone_offset)
                                throws CalendarException

Modifies the calendar component object having date range start-end inclusive. Return the modified component.

Supported API: false

Parameters:

userCalendar -

start_date -

end_date -

zone_offset -

Returns:

CalendarComponent

Throws:

CalendarException

updateComponent

public CalendarComponent updateComponent(WTCalendar userCalendar,
                                         long start_date,
                                         long end_date,
                                         WTPrincipalReference delegate,
                                         boolean workingDay,
                                         int zone_offset)
                                  throws CalendarException

Modifies the calendar object type(s) over the date range start-end inclusive. Return true if successfull.

Supported API: false

Parameters:

userCalendar -

start_date -

end_date -

delegate -

workingDay -

zone_offset -

Returns:

CalendarComponent

Throws:

CalendarException

updateComponent

public CalendarComponent updateComponent(WTCalendar userCalendar,
                                         long start_date,
                                         long end_date,
                                         boolean workingDay,
                                         int zone_offset)
                                  throws CalendarException

Modifies the calendar object type(s) over the date range start-end inclusive. Return true if successfull.

Supported API: false

Parameters:

userCalendar -

start_date -

end_date -

workingDay -

zone_offset -

Returns:

CalendarComponent

Throws:

CalendarException

updateComponent

public CalendarComponent updateComponent(WTCalendar userCalendar,
                                         long start_date,
                                         long end_date,
                                         WTPrincipalReference delegate,
                                         int zone_offset)
                                  throws CalendarException

Modifies the calendar object type(s) over the date range start-end inclusive. Return true if successfull.

Supported API: false

Parameters:

userCalendar -

start_date -

end_date -

delegate -

zone_offset -

Returns:

CalendarComponent

Throws:

CalendarException

deleteComponent

public boolean deleteComponent(WTCalendar userCalendar,
                               long start_date,
                               long end_date,
                               int zone_offset)
                        throws CalendarException

This method will delete the specified calendar component type for the user over the date range start-end inclusive. Returns true if successfull.

Supported API: false

Parameters:

userCalendar -

start_date -

end_date -

zone_offset -

Returns:

boolean

Throws:

CalendarException

createComponents

public Vector createComponents(WTCalendar userCalendar,
                               long start_date,
                               long end_date,
                               WTPrincipalReference delegate,
                               boolean workingDay,
                               int zone_offset)
                        throws CalendarException

This method will create the specified calendar component over the date range start-end inclusive. Returns true if successful.

Supported API: false

Parameters:

userCalendar -

start_date -

end_date -

delegate -

workingDay -

zone_offset -

Returns:

Vector

Throws:

CalendarException

readComponents

public Vector readComponents(WTCalendar userCalendar,
                             long start_date,
                             long end_date,
                             int zone_offset)
                      throws CalendarException

Modifies the calendar component object having date range start-end inclusive. Return the modified component.

Supported API: false

Parameters:

userCalendar -

start_date -

end_date -

zone_offset -

Returns:

Vector

Throws:

CalendarException

updateComponents

public Vector updateComponents(WTCalendar userCalendar,
                               long start_date,
                               long end_date,
                               WTPrincipalReference delegate,
                               boolean workingDay,
                               int zone_offset)
                        throws CalendarException

Modifies the calendar object type(s) over the date range start-end inclusive. Return true if successfull.

Supported API: false

Parameters:

userCalendar -

start_date -

end_date -

delegate -

workingDay -

zone_offset -

Returns:

Vector

Throws:

CalendarException

updateComponents

public Vector updateComponents(WTCalendar userCalendar,
                               long start_date,
                               long end_date,
                               WTPrincipalReference delegate,
                               int zone_offset)
                        throws CalendarException

Modifies the calendar object type(s) over the date range start-end inclusive. Return true if successfull.

Supported API: false

Parameters:

userCalendar -

start_date -

end_date -

delegate -

zone_offset -

Returns:

Vector

Throws:

CalendarException

updateComponents

public Vector updateComponents(WTCalendar userCalendar,
                               long start_date,
                               long end_date,
                               boolean workingDay,
                               int zone_offset)
                        throws CalendarException

Modifies the calendar object type(s) over the date range start-end inclusive. Return true if successfull.

Supported API: false

Parameters:

userCalendar -

start_date -

end_date -

workingDay -

zone_offset -

Returns:

Vector

Throws:

CalendarException

deleteComponents

public boolean deleteComponents(WTCalendar userCalendar,
                                long start_date,
                                long end_date,
                                int zone_offset)
                         throws CalendarException

This method will delete the specified calendar component type for the user over the date range start-end inclusive. Returns true if successfull.

Supported API: false

Parameters:

userCalendar -

start_date -

end_date -

zone_offset -

Returns:

boolean

Throws:

CalendarException