public interface IActionInboxItem extends IActionInboxNotification
IActionInboxNotification
object for a specific
user.
Changes between major releases 7.0 and 7.X
Added methods: getDoneAuthorUME()
,
getOwnerUME()
,
setDone(com.sapportals.wcm.repository.IResourceContext, com.sap.security.api.IUser, java.lang.String)
.
Copyright 2004 SAP AG
Modifier and Type | Method and Description |
---|---|
void |
delete(IResourceContext context)
Delete the action item.
|
boolean |
executeAction(IResourceContext context,
IActionInboxAction action)
Perform the given action for this item.
|
String |
getDescription(IResourceContext context)
Provides a description for this action item's notification.
|
com.sapportals.portal.security.usermanagement.IUser |
getDoneAuthor()
Deprecated.
As of NetWeaver 7.1, replaced by
getDoneAuthorUME() |
IUser |
getDoneAuthorUME()
Get the user, who was caused the 'done'.
|
String |
getDoneReason()
Get the reason, why an item was set to done.
|
String |
getID()
Get the unique ID for this item.
|
IActionInboxItemCategory |
getItemCategory()
Get the item category for this item.
|
Collection |
getLinkedOwners(IResourceContext context)
Get the list of owners for a linked action item.
|
Date |
getModificationDate()
Get the last modification date of this item.
|
com.sapportals.portal.security.usermanagement.IUMPrincipal |
getOwner()
Deprecated.
As of NetWeaver 7.1, replaced by
getOwnerUME() |
IPrincipal |
getOwnerUME()
Get the owner of this item.
|
String |
getProducerID()
Get the id of the producer which once produced this item.
|
IResource |
getResource(IResourceContext context)
Get the resource associated to this item.
|
boolean |
isDone()
Check, if this item is in done state (
setDone() has been
called). |
boolean |
isLinked()
Check, if this item is a linked item (an item that is stored as a multiple
but crosslinked item in the inboxes for several users).
|
boolean |
isRead()
Check, if this item was already read by it's owner (
setRead()
has been called). |
boolean |
setDone(IResourceContext context,
com.sapportals.portal.security.usermanagement.IUser reasonAuthor,
String reasonID)
Deprecated.
As of NetWeaver 7.1, replaced by
setDone(IResourceContext,com.sap.security.api.IUser,String) |
boolean |
setDone(IResourceContext context,
IUser reasonAuthor,
String reasonID)
Set the 'done' state.
|
boolean |
setRead(IResourceContext context)
Set the 'read' state.
|
getAssignedRef, getAssignedRID, getCategoryID, getNotificationDate, getOriginator, getOriginatorUME, getProperties
String getID()
String
with the unique ID for this item.String getDescription(IResourceContext context)
context
- a IResourceContext
with the context of the
user to get the description for.String
with the description for this item's
notification or null
if the producer for this
item is no longer registered.IResource getResource(IResourceContext context) throws WcmException
context
- the IResourceContext
to use.IResource
with the associated resource.WcmException
- if an error occured.com.sapportals.portal.security.usermanagement.IUMPrincipal getOwner() throws WcmException
getOwnerUME()
IUMPrincipal
with the owner of this item.WcmException
- if an error occured.IPrincipal getOwnerUME() throws WcmException
IUMPrincipal
with the owner of this item.WcmException
- if an error occurred.IActionInboxItemCategory getItemCategory() throws WcmException
IActionInboxItemCategory
the item belongs to.WcmException
- if an error occurred.String getProducerID() throws WcmException
String
with the item's producer id.WcmException
- if an error occurred.Date getModificationDate() throws WcmException
Date
of the timestamp when this item was last
modified.WcmException
- if an error occurred.boolean isLinked() throws WcmException
boolean
true
if the item is linked to
others.WcmException
- if an error occured.Collection getLinkedOwners(IResourceContext context) throws WcmException
context
- the IResourceContext
to use for accessing
the inbox.Collection
of IUMPrincipal
s with the
list of owners for linked items or null
if this item
is not linked.WcmException
- if an error occurred.boolean isRead() throws WcmException
setRead()
has been called).boolean
true
if the item was set to
'read' state for it's owner, false
if not.WcmException
- if an error occurred.boolean setRead(IResourceContext context) throws WcmException
context
- the IResourceContext
to use for accessing
the inbox.boolean
true
if the item was set to
'read' state, false
if the item is in the wrong state
for setting to 'read' (already done).WcmException
- if an error occurred.boolean isDone() throws WcmException
setDone()
has been
called).boolean
true
if the item was set to
'done' state, false
if not.WcmException
- if an error occured.String getDoneReason() throws WcmException
String
with the reason id, null
if
no reason is available (e.g. if not in 'done' state).WcmException
- if an error occured.com.sapportals.portal.security.usermanagement.IUser getDoneAuthor() throws WcmException
getDoneAuthorUME()
IUser
with the user who cause the 'done',
null
if not available (e.g. if the item is not in
'done' state).WcmException
- if an error occured.IUser getDoneAuthorUME() throws WcmException
IUser
with the user who cause the 'done',
null
if not available (e.g. if the item is not in
'done' state).WcmException
- if an error occurred.boolean setDone(IResourceContext context, com.sapportals.portal.security.usermanagement.IUser reasonAuthor, String reasonID) throws WcmException
setDone(IResourceContext,com.sap.security.api.IUser,String)
context
- the IResourceContext
to use for accessing
the inbox.reasonAuthor
- a IUser
with the user who caused the
'done' state.reasonID
- a String
with a reason code.boolean
true
if the item was set to
'done' state, false
if the item is in the wrong state
for setting to 'read' (already done).WcmException
- if an error occured.boolean setDone(IResourceContext context, IUser reasonAuthor, String reasonID) throws WcmException
context
- the IResourceContext
to use for accessing
the inbox.reasonAuthor
- a IUser
with the user who caused the
'done' state.reasonID
- a String
with a reason code.boolean
true
if the item was set to
'done' state, false
if the item is in the wrong state
for setting to 'read' (already done).WcmException
- if an error occurred.void delete(IResourceContext context) throws WcmException
context
- the IResourceContext
to use for accessing
the inbox.WcmException
- if an error occurred.boolean executeAction(IResourceContext context, IActionInboxAction action) throws WcmException
context
- the IResourceContext
to performing the action
for.action
- the IActionInboxAction
to perform on this item.true
if the action was
executed successfuly, false
otherwiseWcmException
- if an error occured.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