public class RecipientFactory extends Object
IRecipient
s. IRecipient
Modifier and Type | Method and Description |
---|---|
IRecipientList |
createRecipientList()
Create an empty
IRecipientList . |
static RecipientFactory |
getInstance()
Get an instance of the
RecipientFactory . |
IRecipient |
getRecipient(IPrincipal principal)
Get an
IRecipient for the given user-management object. |
IRecipient |
getRecipient(com.sapportals.portal.security.usermanagement.IUMPrincipal principal)
Deprecated.
As of NetWeaver 7.1, replaced by
getRecipient(com.sap.security.api.IPrincipal) |
IRecipient |
getRecipient(String id,
int type)
Get a
IRecipient for the given id and type. |
public static RecipientFactory getInstance() throws WcmException
RecipientFactory
.RecipientFactory
.WcmException
- if no factory instance is available.public IRecipient getRecipient(com.sapportals.portal.security.usermanagement.IUMPrincipal principal) throws WcmException
getRecipient(com.sap.security.api.IPrincipal)
IRecipient
for the given user-management object.principal
- a IUMPrincipal
with user-management object
(an IUser
, IGroup
or IRole
).IRecipient
for the given user-management object,
null
if the recipient does not exist.WcmException
- if the recipient could not be retrieved.public IRecipient getRecipient(IPrincipal principal) throws WcmException
IRecipient
for the given user-management object.principal
- a IUMPrincipal
with user-management object
(an IUser
, IGroup
or IRole
).IRecipient
for the given user-management object,
null
if the recipient does not exist.WcmException
- if the recipient could not be retrieved.public IRecipient getRecipient(String id, int type) throws WcmException
IRecipient
for the given id and type.id
- a String
with the IRecipient
's system
id.type
- an int
with the type of the recipient (IUSER
, IGROUP
or IROLE
, see
com.sap.wp.security.IUMPrincipal ).IRecipient
for the given id and type, null
if the recipient does not exist.WcmException
- if the recipient could not be retrieved.public IRecipientList createRecipientList() throws WcmException
IRecipientList
.IRecipientList
.WcmException
- if the list could not be created.Access Rights |
---|
SC | DC | Public Part | ACH |
---|---|---|---|
[sap.com] KMC-CM
|
[sap.com] tc/km/frwk
|
api
|
EP-KM-CM
|
[sap.com] KMC-WPC
|
[sap.com] tc/kmc/wpc/wpcfacade
|
api
|
EP-PIN-WPC-WCM
|
Copyright 2018 SAP AG Complete Copyright Notice