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

Interface IAvailabilityInfo


public interface IAvailabilityInfo

This interface represents the availability information of different users.


Method Summary
 SortedMap getAvailabilityInformation()
          Returns the availability information as a map with the date range as the key and the availability type as the value.
 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(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. free, busy, tentative etc.
 void setTimeSlots(String timeslots)
          Sets the availability information as a string.
 

Method Detail

getTimeSlotDuration

public int getTimeSlotDuration()
Returns the duration of the time slots in minutes

Returns:
int duration of time slot in minutes

setTimeSlotDuration

public void setTimeSlotDuration(int duration)
Sets the duration of the time slots in minutes


getTimeInterval

public IDateRange getTimeInterval()
Returns the time interval of the availability information as a date range.

Returns:
IDateRange Date range Object.

setTimeInterval

public void setTimeInterval(IDateRange range)
Sets the time interval of the availability information


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.

setTimeSlots

public void setTimeSlots(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.


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.


getAvailabilityInformation

public 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.

Returns:
List list of date ranges containing avalability information of given type.

getAvailabilityInformation

public 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 sorted map containing date interval - availability info pairs.

setAvailabilityInformation

public void setAvailabilityInformation(SortedMap availabilityInfo)
Sets the availability information as a map with the date range as the key and the availability type as the value.



Copyright 2006 SAP AG. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Microsoft, Windows, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation. Oracle is a registered trademark of Oracle Corporation. UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group. Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc. HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C, World Wide Web Consortium, Massachusetts Institute of Technology. Java is a registered trademark of Sun Microsystems, Inc. JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape. MaxDB is a trademark of MySQL AB, Sweden. SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary. These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.