public interface IActionInboxCategory
IActionInboxCategory
describes the type of a
IActionInboxNotification
. IActionInboxNotification
s and belong to such a category.
Changes between major releases 7.0 and 7.X
Added methods:
getItemCategory(com.sapportals.wcm.repository.IResourceContext, com.sap.security.api.IPrincipal)
.
Copyright 2004 SAP AG
Modifier and Type | Field and Description |
---|---|
static int |
CREATION_ADD
Creation adds.
|
static int |
CREATION_UPDATE
Creation updates.
|
static int |
DELETION_ALLOWED
Deletion of items is allowed.
|
static int |
DELETION_NOT_ALLOWED
Deletion of items is not allowed.
|
static int |
DONE_HANDLING_AUTHORDONE
Linked done items are marked as done for the done author, and marked
as delete for all others.
|
static int |
DONE_HANDLING_DELETE
Linked done items are deleted.
|
static int |
DONE_HANDLING_DONE
Linked done items are all marked as done.
|
Modifier and Type | Method and Description |
---|---|
IActionInboxAction |
getAction(String name)
Get a specific action by name.
|
IActionInboxAction[] |
getActions()
Get a list of available actions for this category.
|
int |
getCreationType()
Check if creation of items is allowed for this category.
|
int |
getDeletionType()
Check if deletion of items is allowed for this category.
|
String |
getDescription(Locale locale)
Get a (displayable) description for this category.
|
int |
getDoneHandlingType()
Check if deletion of items is allowed for this category.
|
String |
getID()
Get the unique ID (the full path) of the category.
|
IActionInboxItemCategory |
getItemCategory(IResourceContext context,
IPrincipal owner)
Get an item category for a specific user/group/role.
|
IActionInboxItemCategory |
getItemCategory(IResourceContext context,
com.sapportals.portal.security.usermanagement.IUMPrincipal owner)
Deprecated.
As of NetWeaver 7.1, replaced by
getItemCategory(IResourceContext,com.sap.security.api.IPrincipal) |
String |
getName()
Get the name of the category.
|
IActionInboxCategory |
getParent()
Get the parent category for this category.
|
Properties |
getRequiredItemProperties()
Get a list of with the required properties.
|
String |
getResourceType() |
boolean |
isUsersOnly()
Check if action inboxes for this category are for users only (will lead
to autoresolving of recipients).
|
static final int CREATION_UPDATE
static final int CREATION_ADD
static final int DELETION_NOT_ALLOWED
static final int DELETION_ALLOWED
static final int DONE_HANDLING_DONE
static final int DONE_HANDLING_AUTHORDONE
static final int DONE_HANDLING_DELETE
String getID()
String
with the unique ID for this category.String getName()
getID()
).String
with the category's name.String getDescription(Locale locale)
locale
- a Locale
with the preferred language to get the
description for.String
with the description for this category.IActionInboxCategory getParent() throws WcmException
IActionInboxCategory
with the parent category for
this category or null
if no such parent category
exists.WcmException
- if an error occurred.IActionInboxAction[] getActions() throws WcmException
IActionInboxAction
for this category.WcmException
- if an error occurred.IActionInboxAction getAction(String name) throws WcmException
name
- a String
with the name of the action to get.IActionInboxAction
with the given name for this
category.WcmException
- if an error occurred.Properties getRequiredItemProperties() throws WcmException
Properties
with the keys of the required
properties for this category, all values are set to an empty
string.WcmException
- if an error occurred.IActionInboxItemCategory getItemCategory(IResourceContext context, com.sapportals.portal.security.usermanagement.IUMPrincipal owner) throws WcmException
getItemCategory(IResourceContext,com.sap.security.api.IPrincipal)
context
- the IResourceContext
to use for accessing the
inbox.owner
- the IUMPrincipal
of the user/group/role to get
the inbox for.IActionInboxItemCategory
with the inbox category
for the given user/group/role.WcmException
- if an error occurred.IActionInboxItemCategory getItemCategory(IResourceContext context, IPrincipal owner) throws WcmException
context
- the IResourceContext
to use for accessing the
inbox.owner
- the IUMPrincipal
of the user/group/role to get
the inbox for.IActionInboxItemCategory
with the inbox category
for the given user/group/role.WcmException
- if an error occurred.String getResourceType()
int getCreationType() throws WcmException
int
with the CREATION_
... code.WcmException
- if an error occurred.int getDeletionType() throws WcmException
int
with the DELETION_
... code.WcmException
- if an error occurred.int getDoneHandlingType() throws WcmException
int
with the DONE_HANDLING_
... code.WcmException
- if an error occurred.boolean isUsersOnly() throws WcmException
boolean
true
if this category should
send items to users only, false
if roles/groups are
allowed as recipients.WcmException
- if an error occurred.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