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

Interface IGroupwareItemFactory

public interface IGroupwareItemFactory

This is a class used for creating differenct types of Groupware Objects.

Method Summary

IAvailabilityInfo	getAvailabilityInfo() Method for fetching Availability information.
IDateRange	getDateRange(Date pStartDate, Date pEndDate)
IEmailAddress	getEmailObject(String pName)
IEmailAddress	getEmailObject(String pName, String pMailId)
IGroupwareItem	getNewInstance(GroupwareItemType type) Creates the Groupware item of the given type.
Object	getNewInstanceForImpl(GroupwareItemType type) Creates the object of the given groupware item type which is not actual Groupware Item Object but sub objects associated with the Standard Groupware Item. e.g Items like Attachements,Availability Info
IRecurrenceTransport	getRecurrenceImpl()

Method Detail

getNewInstance

IGroupwareItem getNewInstance(GroupwareItemType type)

Creates the Groupware item of the given type.

Parameters:

type - Groupware Item type.

Returns:

Instance of the given groupware item type.

Since:

NetWeaver 7.1

getNewInstanceForImpl

Object getNewInstanceForImpl(GroupwareItemType type)

Creates the object of the given groupware item type which is not actual Groupware Item Object but sub objects associated with the Standard Groupware Item. e.g Items like Attachements,Availability Info

Parameters:

type - Input Groupware item type.

Returns:

Instance of the Implementation of given groupware item type.

Since:

NetWeaver 7.1

getDateRange

IDateRange getDateRange(Date pStartDate,
                        Date pEndDate)

Parameters:

pStartDate - Start date value.

pEndDate - End date value.

Returns:

IDateRange Object. IDateRange object constructed out of given start date and end date object.

getEmailObject

IEmailAddress getEmailObject(String pName)
                             throws MalformedURLException

Parameters:

pName - A valid name object according to the RFC 822 is a String that does not contain the characters 0 - 31, 34 or 127 which is control characters, delete and qoute. This class will ruthlessly accept ANY strings as valid names and it is up to the implementors and users of this class to make sure that the name string get encoded or left out before attempting to use it in a protocoll specific manner.

Returns:

Email Address Object conforming to IEmailAddress.

Throws:

MalformedURLException - Upon creation of the address object an MalformedURLException will be thrown if the address does not conform to the above rules.

getEmailObject

IEmailAddress getEmailObject(String pName,
                             String pMailId)
                             throws MalformedURLException

Parameters:

pName - A valid name object according to the RFC 822 is a String that does not contain the characters 0 - 31, 34 or 127 which is control characters, delete and qoute. This class will ruthlessly accept ANY strings as valid names and it is up to the implementors and users of this class to make sure that the name string get encoded or left out before attempting to use it in a protocoll specific manner.

pMailId - A valid address string cannot - like the name string - contain the characters 0 - 31, 34 or 127. It also cannot contain spaces. An address must also contain a "@" character which cannot start or end the address string.

Returns:

Throws:

MalformedURLException - Upon creation of the address object an MalformedURLException will be thrown if the address does not conform to the above rules.

getAvailabilityInfo

IAvailabilityInfo getAvailabilityInfo()

Method for fetching Availability information.

Returns:

Availability information

getRecurrenceImpl

IRecurrenceTransport getRecurrenceImpl()

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-COLL	[sap.com] tc/kmc/coll/gw	api	EP-KM-COL