com.sapportals.wcm.service.actioninbox

Class AbstractActionInboxCategory

java.lang.Object
  com.sapportals.wcm.service.actioninbox.AbstractActionInboxCategory

All Implemented Interfaces:

IActionInboxCategory

public class AbstractActionInboxCategory

extends Object

implements IActionInboxCategory

A base implementation for an IActionInboxCategory.

Copyright 2004 SAP AG

Field Summary

Fields inherited from interface com.sapportals.wcm.service.actioninbox.IActionInboxCategory

CREATION_ADD, CREATION_UPDATE, DELETION_ALLOWED, DELETION_NOT_ALLOWED, DONE_HANDLING_AUTHORDONE, DONE_HANDLING_DELETE, DONE_HANDLING_DONE

Constructor Summary

AbstractActionInboxCategory(IActionInboxService manager, String name, IActionInboxCategory parent, Descriptions descriptions, Properties requiredItemProperties, String resourceType, HashMap actions, int creationType, int deletionType, int doneHandlingType, boolean isUsersOnly)

Method Summary

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, com.sapportals.portal.security.usermanagement.IUMPrincipal owner) Get an item category for a specific user/group/role.
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).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractActionInboxCategory

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

Method Detail

getID

public String getID()

Description copied from interface: IActionInboxCategory

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

Specified by:

getID in interface IActionInboxCategory

Returns:

a String with the unique ID for this category.

getName

public String getName()

Description copied from interface: IActionInboxCategory

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

Specified by:

getName in interface IActionInboxCategory

Returns:

a String with the category's name.

getDescription

public String getDescription(Locale locale)

Description copied from interface: IActionInboxCategory

Get a (displayable) description for this category.

Specified by:

getDescription in interface IActionInboxCategory

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

Description copied from interface: IActionInboxCategory

Get the parent category for this category.

Specified by:

getParent in interface IActionInboxCategory

Returns:

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

Throws:

WcmException

getActions

public IActionInboxAction[] getActions()
                                throws WcmException

Description copied from interface: IActionInboxCategory

Get a list of available actions for this category.

Specified by:

getActions in interface IActionInboxCategory

Returns:

an array of IActionInboxAction for this category.

Throws:

WcmException

getAction

public IActionInboxAction getAction(String name)
                             throws WcmException

Description copied from interface: IActionInboxCategory

Get a specific action by name.

Specified by:

getAction in interface IActionInboxCategory

Parameters:

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

Returns:

a IActionInboxAction with the given name for this category.

Throws:

WcmException

getRequiredItemProperties

public Properties getRequiredItemProperties()
                                     throws WcmException

Description copied from interface: IActionInboxCategory

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!

Specified by:

getRequiredItemProperties in interface IActionInboxCategory

Returns:

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

Throws:

WcmException

getResourceType

public String getResourceType()

Specified by:

getResourceType in interface IActionInboxCategory

Returns:

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

getItemCategory

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

Description copied from interface: IActionInboxCategory

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

Specified by:

getItemCategory in interface IActionInboxCategory

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:

WcmException

getCreationType

public int getCreationType()
                    throws WcmException

Description copied from interface: IActionInboxCategory

Check if creation of items is allowed for this category.

Specified by:

getCreationType in interface IActionInboxCategory

Returns:

an int with the CREATION_... code.

Throws:

WcmException

getDeletionType

public int getDeletionType()
                    throws WcmException

Description copied from interface: IActionInboxCategory

Check if deletion of items is allowed for this category.

Specified by:

getDeletionType in interface IActionInboxCategory

Returns:

an int with the DELETION_... code.

Throws:

WcmException

getDoneHandlingType

public int getDoneHandlingType()
                        throws WcmException

Description copied from interface: IActionInboxCategory

Check if deletion of items is allowed for this category.

Specified by:

getDoneHandlingType in interface IActionInboxCategory

Returns:

an int with the DONE_HANDLING_... code.

Throws:

WcmException

isUsersOnly

public boolean isUsersOnly()
                    throws WcmException

Description copied from interface: IActionInboxCategory

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

Specified by:

isUsersOnly in interface IActionInboxCategory

Returns:

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

Throws:

WcmException