com.sapportals.wcm.service.actioninbox
Interface IActionInboxCategory

[contained in: com.sap.km.cm.service.base.par - km.shared.service.actioninbox_api.jar]

All Known Implementing Classes:

AbstractActionInboxCategory

public interface IActionInboxCategory

A IActionInboxCategory describes the type of a IActionInboxNotification.
All IActionInboxNotifications and belong to such a category.

Copyright 2004 SAP AG

Field Summary

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.

Method Summary

IActionInboxAction	getAction(java.lang.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.
java.lang.String	getDescription(java.util.Locale locale) Get a (displayable) description for this category.
int	getDoneHandlingType() Check if deletion of items is allowed for this category.
java.lang.String	getID() Get the unique ID (the full path) of the category.
IActionInboxItemCategory	getItemCategory(IResourceContext context, com.sapportals.portal.security.usermanagement.IUMPrincipal owner) Get an item category for a specific user/group/role.
java.lang.String	getName() Get the name of the category. This name is only unique within the parent's name (see getID()).
IActionInboxCategory	getParent() Get the parent category for this category.
java.util.Properties	getRequiredItemProperties() Get a list of with the required properties. Warning: Only the keys are set for this property bag, all values are set to an empty string!
java.lang.String	getResourceType()
boolean	isUsersOnly() Check if action inboxes for this category are for users only (will lead to autoresolving of recipients).

Field Detail

CREATION_UPDATE

public static final int CREATION_UPDATE

Creation updates.

CREATION_ADD

public static final int CREATION_ADD

Creation adds.

DELETION_NOT_ALLOWED

public static final int DELETION_NOT_ALLOWED

Deletion of items is not allowed.

DELETION_ALLOWED

public static final int DELETION_ALLOWED

Deletion of items is allowed.

DONE_HANDLING_DONE

public static final int DONE_HANDLING_DONE

Linked done items are all marked as done.

DONE_HANDLING_AUTHORDONE

public static final int DONE_HANDLING_AUTHORDONE

Linked done items are marked as done for the done author, and marked as delete for all others.

DONE_HANDLING_DELETE

public static final int DONE_HANDLING_DELETE

Linked done items are deleted.

Method Detail

getID

public java.lang.String getID()

Get the unique ID (the full path) of the category.

Returns:

a String with the unique ID for this category.

getName

public java.lang.String getName()

Get the name of the category.
This name is only unique within the parent's name (see getID()).

Returns:

a String with the category's name.

getDescription

public java.lang.String getDescription(java.util.Locale locale)

Get a (displayable) description for this category.

Parameters:

locale - a Locale with the preferred language to get the description for.

Returns:

a String with the description for this category.

getParent

public IActionInboxCategory getParent()
                               throws WcmException

Get the parent category for this category.

Returns:

a IActionInboxCategory with the parent category for this category or null if no such parent category exists.

Throws:

a - WcmException if an error occurred.

getActions

public IActionInboxAction[] getActions()
                                throws WcmException

Get a list of available actions for this category.

Returns:

an array of IActionInboxAction for this category.

Throws:

a - WcmException if an error occurred.

getAction

public IActionInboxAction getAction(java.lang.String name)
                             throws WcmException

Get a specific action by name.

Parameters:

name - a String with the name of the action to get.

Returns:

a IActionInboxAction with the given name for this category.

Throws:

a - WcmException if an error occurred.

getRequiredItemProperties

public java.util.Properties getRequiredItemProperties()
                                               throws WcmException

Get a list of with the required properties.
Warning: Only the keys are set for this property bag, all values are set to an empty string!

Returns:

a bag of Properties with the keys of the required properties for this category, all values are set to an empty string.

getItemCategory

public IActionInboxItemCategory getItemCategory(IResourceContext context,
                                                com.sapportals.portal.security.usermanagement.IUMPrincipal owner)
                                         throws WcmException

Get an item category for a specific user/group/role.

Parameters:

context - the IResourceContext to use for accessing the inbox.

owner - the IUMPrincipal of the user/group/role to get the inbox for.

Returns:

a IActionInboxItemCategory with the inbox category for the given user/group/role.

Throws:

a - WcmException if an error occurred.

getResourceType

public java.lang.String getResourceType()

Returns:

the Type of the ActionInboxCategory, e.g. used for OTH, is read from the xml-specification of the categories

getCreationType

public int getCreationType()
                    throws WcmException

Check if creation of items is allowed for this category.

Returns:

an int with the CREATION_... code.

Throws:

a - WcmException if an error occurred.

getDeletionType

public int getDeletionType()
                    throws WcmException

Check if deletion of items is allowed for this category.

Returns:

an int with the DELETION_... code.

Throws:

a - WcmException if an error occurred.

getDoneHandlingType

public int getDoneHandlingType()
                        throws WcmException

Check if deletion of items is allowed for this category.

Returns:

an int with the DONE_HANDLING_... code.

Throws:

a - WcmException if an error occurred.

isUsersOnly

public boolean isUsersOnly()
                    throws WcmException

Check if action inboxes for this category are for users only (will lead to autoresolving of recipients).

Returns:

a boolean true if this category should send items to users only, false if roles/groups are allowed as recipients.

Throws:

a - WcmException if an error occurred.