public interface IGroupwareManager
Modifier and Type | Method and Description |
---|---|
void |
clearAllTransports()
Clears all the transports in the Registry that it holds.
|
IAttachment |
getAttachmentContent(GroupwareItemType itemType,
String transportName,
String id,
String attachmentId,
IUser user)
Returns content of the attachment based on the id specified.
|
Map |
getAvailabilityInfo(IDateRange range,
int timeInterval,
List addresses,
com.sapportals.portal.security.usermanagement.IUser user)
Deprecated.
As of NetWeaver 7.1, replaced by
getAvailabilityInfo(IDateRange,int,List,com.sap.security.api.IUser) |
Map |
getAvailabilityInfo(IDateRange range,
int timeInterval,
List addresses,
IUser user)
Returns the availability information for a list of users.
|
IGroupwareCredentials |
getCredentials(com.sapportals.portal.security.usermanagement.IUser user,
String serverAlias)
Deprecated.
As of NetWeaver 7.1, replaced by
getCredentials(com.sap.security.api.IUser,String) |
IGroupwareCredentials |
getCredentials(IUser user,
String serverAlias) |
Properties |
getCredentialsProperties(int itemType,
String transportName)
Returns different credential properties needed by the specified
transport.Used for fetching information from user mapping.
|
IGWResourceManager |
getGWResourceManager()
Returns the IGWResourceManager instance available with this manager.
|
IGroupwareItem |
getItem(GroupwareItemType itemType,
String transportName,
String Id,
IUser user)
Returns a groupware item from the transport based on the id specified.
|
List |
getItemList(GroupwareItemType itemType,
IDateRange range,
IUser user)
Returns all groupware items for the specified date range.
|
List |
getItemList(GroupwareItemType itemType,
IDateRange range,
Properties searchCriteria,
IUser user,
int nCount)
Returns all groupware items for the specified date range and search attributes.
|
List |
getSystemIds(int itemType,
String transportName)
Method get the ids of different systems for the specified transport.
|
Map |
getTransportNames(GroupwareItemType itemType,
TransportType transportType,
Locale locale)
Returns names of the available transposrts for the specified
transport type.The names are returned as a map with the transport
name as the key, and the description as the value.
|
Map |
getTransports(GroupwareItemType itemType,
TransportType transportType)
Returns the available transposrts for the specified
transport type.The tranpsports are returned as a map with the transport
name as the key, and the transport as the value.
|
void |
loadTransport(String transportClass,
List transportProperties)
Loads up the specified transport class, initializes it and registers
the transport with transport registry.
|
void |
loadTransport(String transportClass,
List transportProperties,
boolean isDefault)
Loads up the specified transport class, initializes it and registers
the transport with transport registry.
|
void |
remove(IGroupwareItem item,
com.sapportals.portal.security.usermanagement.IUser user)
Deprecated.
As of NetWeaver 7.1, replaced by
remove(IGroupwareItem,com.sap.security.api.IUser) |
void |
remove(IGroupwareItem item,
IUser user)
Saves the groupware item.This method obtains the necessery credentials
for connecting to the groupware server from credentials factory.
|
void |
remove(IGroupwareItem item,
com.sapportals.portal.security.usermanagement.IUser user,
boolean isSeries)
Deprecated.
As of NetWeaver 7.1, replaced by
remove(IGroupwareItem,com.sap.security.api.IUser,boolean) |
void |
remove(IGroupwareItem item,
IUser user,
boolean isSeries)
Saves the groupware item.This method obtains the necessery credentials
for connecting to the groupware server from credentials factory.
|
void |
save(IGroupwareItem item,
com.sapportals.portal.security.usermanagement.IUser user)
Deprecated.
As of NetWeaver 7.1, replaced by
save(IGroupwareItem,com.sap.security.api.IUser) |
void |
save(IGroupwareItem item,
IUser user)
Saves the groupware item.This method obtains the necessery credentials
for connecting to the groupware server from credentials factory.
|
void |
send(IGroupwareItem item,
com.sapportals.portal.security.usermanagement.IUser user)
Deprecated.
As of NetWeaver 7.1, replaced by
send(IGroupwareItem,com.sap.security.api.IUser) |
void |
send(IGroupwareItem item,
IUser user)
Sends the groupware item to the intended recipient list.This method
obtains the necessery credentials for connecting to the groupware
server from credentials factory.
|
void |
shutDown()
Terminates the groupware manager.
|
void |
startUp()
Initalizes the groupware manager.
|
void startUp() throws GroupwareException
GroupwareException
- When error occursvoid shutDown() throws GroupwareException
GroupwareException
- When error occursvoid loadTransport(String transportClass, List transportProperties) throws GroupwareException
transportClass
- Class name of the transport to be loaded.transportProperties
- Transport properties.GroupwareException
- When error occursvoid loadTransport(String transportClass, List transportProperties, boolean isDefault) throws GroupwareException
transportClass
- Class name of the transport to be loaded.transportProperties
- Transport properties.isDefault
- true if transport (with its classname transportClass)is default or falseGroupwareException
- When error occursvoid save(IGroupwareItem item, com.sapportals.portal.security.usermanagement.IUser user) throws GroupwareException
save(IGroupwareItem,com.sap.security.api.IUser)
item
- groupware item to be saveduser
- User ObjectGroupwareException
- When error occursvoid save(IGroupwareItem item, IUser user) throws GroupwareException
item
- groupware item to be saveduser
- User ObjectGroupwareException
- When error occursvoid remove(IGroupwareItem item, com.sapportals.portal.security.usermanagement.IUser user) throws GroupwareException
remove(IGroupwareItem,com.sap.security.api.IUser)
item
- groupware item to be saveduser
- User objectGroupwareException
- When error occursvoid remove(IGroupwareItem item, IUser user) throws GroupwareException
item
- groupware item to be saveduser
- User objectGroupwareException
- When error occursvoid remove(IGroupwareItem item, com.sapportals.portal.security.usermanagement.IUser user, boolean isSeries) throws GroupwareException
remove(IGroupwareItem,com.sap.security.api.IUser,boolean)
item
- groupware item to be saveduser
- User objectisSeries
- GroupwareException
- When error occursvoid remove(IGroupwareItem item, IUser user, boolean isSeries) throws GroupwareException
item
- groupware item to be saveduser
- User objectisSeries
- GroupwareException
- When error occursvoid send(IGroupwareItem item, com.sapportals.portal.security.usermanagement.IUser user) throws GroupwareException
send(IGroupwareItem,com.sap.security.api.IUser)
item
- groupware item to be sentuser
- User objectGroupwareException
- When error occursvoid send(IGroupwareItem item, IUser user) throws GroupwareException
item
- groupware item to be sentuser
- User objectGroupwareException
- When error occursList getItemList(GroupwareItemType itemType, IDateRange range, IUser user) throws GroupwareException
itemType
- groupware item type like mail, meeting, taskrange
- date range for which the groupware items are fetcheduser
- User ObjectGroupwareException
- When error occursList getItemList(GroupwareItemType itemType, IDateRange range, Properties searchCriteria, IUser user, int nCount) throws GroupwareException
itemType
- groupware item type like mail, meeting, taskrange
- date range for which the groupware items are fetchedsearchCriteria
- search criteria to search in groupware server groupware itemsnCount
- of items to be returned.user
- User objectGroupwareException
- When error occursIGroupwareItem getItem(GroupwareItemType itemType, String transportName, String Id, IUser user) throws GroupwareException
itemType
- groupware item type like mail, meeting, tasktransportName
- name of the transport from which the item will be fetchedId
- id of the groupware itemuser
- User ObjectGroupwareException
- When error occursMap getAvailabilityInfo(IDateRange range, int timeInterval, List addresses, com.sapportals.portal.security.usermanagement.IUser user) throws GroupwareException
getAvailabilityInfo(IDateRange,int,List,com.sap.security.api.IUser)
range
- range date rangetimeInterval
- time slot unit(eg in the time intervals of 30 minutes) for which availability status is fetched.addresses
- list of e-mailId of usersuser
- object.GroupwareException
- When error occursMap getAvailabilityInfo(IDateRange range, int timeInterval, List addresses, IUser user) throws GroupwareException
range
- range date rangetimeInterval
- time slot unit(eg in the time intervals of 30 minutes) for which availability status is fetched.addresses
- list of e-mailId of usersuser
- object.GroupwareException
- When error occursMap getTransportNames(GroupwareItemType itemType, TransportType transportType, Locale locale)
itemType
- groupware item type like mail, meeting, tasktransportType
- transport types like read, or send transportlocale
- locale for the description textMap getTransports(GroupwareItemType itemType, TransportType transportType)
itemType
- groupware item type like mail, meeting, tasktransportType
- transport types like read, or send transportProperties getCredentialsProperties(int itemType, String transportName) throws GroupwareException
itemType
- groupware item type like mail, meeting, tasktransportName
- name of the transportGroupwareException
- When error occursIAttachment getAttachmentContent(GroupwareItemType itemType, String transportName, String id, String attachmentId, IUser user) throws GroupwareException
itemType
- groupware item type like mail, meeting, tasktransportName
- name of the transport from which the item will be fetchedid
- id of the groupware itemattachmentId
- id of the attchmentuser
- ObjectGroupwareException
- When error occursList getSystemIds(int itemType, String transportName)
itemType
- groupware item type like mail, meeting, tasktransportName
- name of the transportIGroupwareCredentials getCredentials(com.sapportals.portal.security.usermanagement.IUser user, String serverAlias) throws GroupwareException
getCredentials(com.sap.security.api.IUser,String)
user
- User Object.serverAlias
- system name under which the user's groupware authentication information is present.GroupwareException
- When error occursIGroupwareCredentials getCredentials(IUser user, String serverAlias) throws GroupwareException
user
- User Object.serverAlias
- system name under which the user's groupware authentication information is present.GroupwareException
- When error occursIGWResourceManager getGWResourceManager() throws GroupwareException
GroupwareException
- When error occursvoid clearAllTransports() throws GroupwareException
GroupwareException
Access Rights |
---|
SC | DC | Public Part | ACH |
---|---|---|---|
[sap.com] KMC-COLL
|
[sap.com] tc/kmc/coll/gw
|
api
|
EP-KM-COL
|
Copyright 2018 SAP AG Complete Copyright Notice