com.sap.ip.collaboration.gw.api.framework.groupware
Interface IAvailabilityInfo

public interface IAvailabilityInfo

This interface represents the availability information of different users.

Copyright (c) SAP 2002

Version:

$Revision: 1.0$

Method Summary

java.util.SortedMap	getAvailabilityInformation() Returns the availability information as a map with the date range as the key and the availability type as the value.
java.util.List	getAvailabilityInformation(AvailabilityType type) Returns the availability information as a list of date ranges for the specified availability type For ex: getAvailabilityInformation(AvailabilityType.FREE) returns a sorted list of all free date ranges.
IDateRange	getTimeInterval() Returns the time interval of the availability information as a date range.
int	getTimeSlotDuration() Returns the duration of the time slots in minutes
int[]	getTimeSlots() Returns the availability information as an array of integers.
void	setAvailabilityInformation(java.util.SortedMap availabilityInfo) Sets the availability information as a map with the date range as the key and the availability type as the value.
void	setTimeInterval(IDateRange range) Sets the time interval of the availability information
void	setTimeSlotDuration(int duration) Sets the duration of the time slots in minutes
void	setTimeSlots(int[] timeslots) Sets the availability information as an array of integers Each entry represents the availability information in the corresponing time slot i.e.
void	setTimeSlots(java.lang.String timeslots) Sets the availability information as a string.

Method Detail

getAvailabilityInformation

public java.util.SortedMap getAvailabilityInformation()

Returns the availability information as a map with the date range as the key and the availability type as the value. The returned map is sorted on the date ranges .

Returns:

SortedMap

getAvailabilityInformation

public java.util.List getAvailabilityInformation(AvailabilityType type)

Returns the availability information as a list of date ranges for the specified availability type For ex: getAvailabilityInformation(AvailabilityType.FREE) returns a sorted list of all free date ranges.

Parameters:

AvailabilityType -

Returns:

List list of date ranges

getTimeInterval

public IDateRange getTimeInterval()

Returns the time interval of the availability information as a date range.

Returns:

IDateRange

getTimeSlotDuration

public int getTimeSlotDuration()

Returns the duration of the time slots in minutes

Returns:

int duration of time slot in minutes

getTimeSlots

public int[] getTimeSlots()

Returns the availability information as an array of integers. Each entry represents the availability information in the corresponing time slot i.e. free, busy, tentative etc.

Returns:

int[] array of time slots which could look like: {0,0,0,1,1,1,2,2,2,1,1,2,2,0,0,0} each entry representing the availability status of the corresponding time slot.

setAvailabilityInformation

public void setAvailabilityInformation(java.util.SortedMap availabilityInfo)

Sets the availability information as a map with the date range as the key and the availability type as the value.

Parameters:

SortedMap -

setTimeInterval

public void setTimeInterval(IDateRange range)

Sets the time interval of the availability information

Parameters:

DateRange - range

setTimeSlotDuration

public void setTimeSlotDuration(int duration)

Sets the duration of the time slots in minutes

Parameters:

int - duration of time slot in minutes

setTimeSlots

public void setTimeSlots(int[] timeslots)

Sets the availability information as an array of integers Each entry represents the availability information in the corresponing time slot i.e. free, busy, tentative etc.

Parameters:

int[] - array of timeslots.

setTimeSlots

public void setTimeSlots(java.lang.String timeslots)

Sets the availability information as a string. Each entry represents the availability information in the corresponing time slot i.e. free, busy, tentative etc.

Parameters:

String - timeslot string like:"0001112221122000".