public class AbstractActionInboxCategory extends Object implements IActionInboxCategory
IActionInboxCategory
.
Copyright 2004 SAP AG
CREATION_ADD, CREATION_UPDATE, DELETION_ALLOWED, DELETION_NOT_ALLOWED, DONE_HANDLING_AUTHORDONE, DONE_HANDLING_DELETE, DONE_HANDLING_DONE
Constructor and Description |
---|
AbstractActionInboxCategory(IActionInboxService manager,
String name,
IActionInboxCategory parent,
Descriptions descriptions,
Properties requiredItemProperties,
String resourceType,
HashMap actions,
int creationType,
int deletionType,
int doneHandlingType,
boolean isUsersOnly) |
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).
|
public AbstractActionInboxCategory(IActionInboxService manager, String name, IActionInboxCategory parent, Descriptions descriptions, Properties requiredItemProperties, String resourceType, HashMap actions, int creationType, int deletionType, int doneHandlingType, boolean isUsersOnly) throws WcmException
WcmException
public String getID()
IActionInboxCategory
getID
in interface IActionInboxCategory
String
with the unique ID for this category.public String getName()
IActionInboxCategory
getID()
).getName
in interface IActionInboxCategory
String
with the category's name.public String getDescription(Locale locale)
IActionInboxCategory
getDescription
in interface IActionInboxCategory
locale
- a Locale
with the preferred language to get the
description for.String
with the description for this category.public IActionInboxCategory getParent() throws WcmException
IActionInboxCategory
getParent
in interface IActionInboxCategory
IActionInboxCategory
with the parent category for
this category or null
if no such parent category
exists.WcmException
- if an error occurred.public IActionInboxAction[] getActions() throws WcmException
IActionInboxCategory
getActions
in interface IActionInboxCategory
IActionInboxAction
for this category.WcmException
- if an error occurred.public IActionInboxAction getAction(String name) throws WcmException
IActionInboxCategory
getAction
in interface IActionInboxCategory
name
- a String
with the name of the action to get.IActionInboxAction
with the given name for this
category.WcmException
- if an error occurred.public Properties getRequiredItemProperties() throws WcmException
IActionInboxCategory
getRequiredItemProperties
in interface IActionInboxCategory
Properties
with the keys of the required
properties for this category, all values are set to an empty
string.WcmException
- if an error occurred.public String getResourceType()
getResourceType
in interface IActionInboxCategory
public IActionInboxItemCategory getItemCategory(IResourceContext context, com.sapportals.portal.security.usermanagement.IUMPrincipal owner) throws WcmException
getItemCategory(IResourceContext,com.sap.security.api.IPrincipal)
IActionInboxCategory
getItemCategory
in interface IActionInboxCategory
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.public IActionInboxItemCategory getItemCategory(IResourceContext context, IPrincipal owner) throws WcmException
IActionInboxCategory
getItemCategory
in interface IActionInboxCategory
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.public int getCreationType() throws WcmException
IActionInboxCategory
getCreationType
in interface IActionInboxCategory
int
with the CREATION_
... code.WcmException
- if an error occurred.public int getDeletionType() throws WcmException
IActionInboxCategory
getDeletionType
in interface IActionInboxCategory
int
with the DELETION_
... code.WcmException
- if an error occurred.public int getDoneHandlingType() throws WcmException
IActionInboxCategory
getDoneHandlingType
in interface IActionInboxCategory
int
with the DONE_HANDLING_
... code.WcmException
- if an error occurred.public boolean isUsersOnly() throws WcmException
IActionInboxCategory
isUsersOnly
in interface IActionInboxCategory
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