public interface IActionInboxItemCategory
IActionInboxItemCategory
is a representation of a specific
user's inbox folder for a category. IActionInboxItem
s belong to an item category. A item
category belongs to a category. getItemsTop(IResourceContext context,int topNumber,Date date)
.
Copyright 2004 SAP AG
Modifier and Type | Method and Description |
---|---|
IActionInboxItem |
createItem(IResourceContext context,
IActionInboxItemProducer producer,
IActionInboxNotification notification,
String linkID)
Create a new item in the item category.
|
IActionInboxCategory |
getCategory()
Get the category for this item category.
|
String |
getID()
Get the unique ID of the action category.
|
IActionInboxItem |
getItem(IResourceContext context,
String itemID)
Get a specific item.
|
IActionInboxItemList |
getItems(IResourceContext context)
Get a list with the available items for this item category.
|
IActionInboxItemList |
getItems(IResourceContext context,
boolean withUnread,
boolean withRead,
boolean withDone)
Get a list with the available items for this item category for a given
state.
|
IActionInboxItemList |
getItemsSince(IResourceContext context,
Date date)
Get a list with the available items for this item category since given date.
|
IActionInboxItemList |
getItemsTop(IResourceContext context,
boolean withUnread,
boolean withRead,
boolean withDone,
int topNumber)
Get a list with the available items for this item category for a given
state.
|
IActionInboxItemList |
getItemsTop(IResourceContext context,
int topNumber)
Get a list with the available items for this item category depending
on certain parameters.
|
IActionInboxItemList |
getItemsTop(IResourceContext context,
int topNumber,
Date date)
Get a list with the available items for this item category depending
on certain parameters.
|
IActionInboxItemList |
getItemsTop(IResourceContext context,
int topNumber,
int depth,
String sortedBy,
boolean ascending)
Get a list with the available items for this item category depending
on certain parameters.
|
String |
getLinkID()
Get a link ID to crosslink items across several item categories.
|
com.sapportals.portal.security.usermanagement.IUMPrincipal |
getOwner()
Deprecated.
As of NetWeaver 7.1, replaced by
getOwnerUME() |
IPrincipal |
getOwnerUME()
Get the owner of this item category.
|
IResource |
getResource(IResourceContext context)
Get the resource associated to this item category.
|
void |
setItemsReadForCategory(IResourceContext context) |
String getID()
String
with the unique ID for this category.IResource getResource(IResourceContext context) throws WcmException
context
- the IResourceContext
to use.IResource
with the associated resource.WcmException
- a WcmException
if an error occurred.IActionInboxCategory getCategory() throws WcmException
IActionInboxCategory
with the category for
this item category.WcmException
- a WcmException
if an error occurred.com.sapportals.portal.security.usermanagement.IUMPrincipal getOwner() throws WcmException
getOwnerUME()
IUMPrincipal
with the owner of this item category.WcmException
- a WcmException
if an error occurred.IPrincipal getOwnerUME() throws WcmException
IUMPrincipal
with the owner of this item category.WcmException
- a WcmException
if an error occurred.IActionInboxItemList getItems(IResourceContext context) throws WcmException
context
- the IResourceContext
to use for accessing the
inbox.IActionInboxItemList
with all items for this
item category.WcmException
- a WcmException
if an error occurred.IActionInboxItemList getItemsSince(IResourceContext context, Date date) throws WcmException
context
- the IResourceContext
to use for accessing the
inbox.date
- from which the ActionInboxItems are to be returned.IActionInboxItemList
with all items for this
item category.WcmException
- a WcmException
if an error occurred.IActionInboxItemList getItems(IResourceContext context, boolean withUnread, boolean withRead, boolean withDone) throws WcmException
context
- the IResourceContext
to use for accessing the
inbox.withUnread
- a boolean
true
if unread
items should be includedwithRead
- a boolean
true
if read
items should be includedwithDone
- a boolean
true
if done
items should be includedIActionInboxItemList
with all items for this
item category and the specified state.WcmException
- a WcmException
if an error occurred.IActionInboxItem getItem(IResourceContext context, String itemID) throws WcmException
context
- the IResourceContext
to use for accessing the
inbox.itemID
- the String
with the id of the
IActionInboxItem
to get.IActionInboxItem
for the given id or
null
if not found.WcmException
- a WcmException
if an error occurred.String getLinkID() throws WcmException
String
with a unique link ID.WcmException
- a WcmException
if an error occurred.IActionInboxItem createItem(IResourceContext context, IActionInboxItemProducer producer, IActionInboxNotification notification, String linkID) throws WcmException
context
- the IResourceContext
to use for accessing the
inbox.producer
- the IActionInboxProducer
wich will provide
the actions allowed for this item. This producer has to be a
registered item producer - if not, an exception will be thrown!notification
- the IActionInboxNotification
to store
in the inbox category.linkID
- a String
with a common link ID to crosslink
several items from other item categories to this item or
null
if no other items are linked.IActionInboxItem
saved.WcmException
- a WcmException
if an error occurred.IActionInboxItemList getItemsTop(IResourceContext context, int topNumber) throws WcmException
context
- the IResourceContext
to use for accessing the
inbox.topNumber
- an int
that allows to limit the number of items
to query for. If this value is -1 then all items are retrieved
int
that allows to limit the number of itemsIActionInboxItemList
with all items for this
item category.WcmException
- a WcmException
if an error occurred.IActionInboxItemList getItemsTop(IResourceContext context, int topNumber, int depth, String sortedBy, boolean ascending) throws WcmException
context
- the IResourceContext
to use for accessing the
inbox.topNumber
- an int
that allows to limit the number of items
to query for. If this value is -1 then all items are retrieved
int
that allows to limit the number of items
to query for. If this value is -1 then all items are retrieveddepth
- an int
that allows to tune the retrieval of items
when aib migration process take places. Only migration process should use this parameter. If
no migration is required(normal case) this value should be equals to -1.sortedBy
- a String
Specify a AIB feature to be used to order the list. If
default order is to be used, just value it as empty string.ascending
- a boolean
true
to specify in which order
we want the items.IActionInboxItemList
with all items for this
item category and the specified state.WcmException
- a WcmException
if an error occurred.IActionInboxItemList getItemsTop(IResourceContext context, boolean withUnread, boolean withRead, boolean withDone, int topNumber) throws WcmException
context
- the IResourceContext
to use for accessing the
inbox.withUnread
- a boolean
true
if unread
items should be includedwithRead
- a boolean
true
if read
items should be includedwithDone
- a boolean
true
if done
items should be includedtopNumber
- an int
that allows to limit the number of items
to query for. If this value is -1 then all items are retrievedIActionInboxItemList
with all items for this
item category and the specified state.WcmException
- a WcmException
if an error occurred.IActionInboxItemList getItemsTop(IResourceContext context, int topNumber, Date date) throws WcmException
context
- the IResourceContext
to use for accessing the
inbox.topNumber
- an int
that allows to limit the number of items
to query for. If this value is -1 then all items are retrieveddate
- from which the ActionInboxItems are to be returned.IActionInboxItemList
with all items for this
item category.WcmException
- a WcmException
if an error occurred.void setItemsReadForCategory(IResourceContext context) throws WcmException
context
- the IResourceContext
WcmException
- a 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