Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

com.sapportals.wcm.service.actioninbox
Class AbstractActionInboxCategory

[contained in: com.sap.km.cm.service.base.par - km.shared.service.actioninbox_api.jar] 
java.lang.Object
  |
  +--com.sapportals.wcm.service.actioninbox.AbstractActionInboxCategory
All Implemented Interfaces:
IActionInboxCategory
public class AbstractActionInboxCategory
extends java.lang.Object
implements IActionInboxCategory

A base implementation for an IActionInboxCategory.

Copyright 2004 SAP AG

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, java.lang.String name, IActionInboxCategory parent, Descriptions descriptions, java.util.Properties requiredItemProperties, java.lang.String resourceType, java.util.HashMap actions, int creationType, int deletionType, int doneHandlingType, boolean isUsersOnly)
           
 
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).
 
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,
                                   java.lang.String name,
                                   IActionInboxCategory parent,
                                   Descriptions descriptions,
                                   java.util.Properties requiredItemProperties,
                                   java.lang.String resourceType,
                                   java.util.HashMap actions,
                                   int creationType,
                                   int deletionType,
                                   int doneHandlingType,
                                   boolean isUsersOnly)
                            throws WcmException
Method Detail

getID

public java.lang.String getID()
Description copied from interface: IActionInboxCategory
Get the unique ID (the full path) of the category.
Specified by:
getID in interface IActionInboxCategory
Following copied from interface: com.sapportals.wcm.service.actioninbox.IActionInboxCategory
Returns:
a String with the unique ID for this category.

getName

public java.lang.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
Following copied from interface: com.sapportals.wcm.service.actioninbox.IActionInboxCategory
Returns:
a String with the category's name.

getDescription

public java.lang.String getDescription(java.util.Locale locale)
Description copied from interface: IActionInboxCategory
Get a (displayable) description for this category.
Specified by:
getDescription in interface IActionInboxCategory
Following copied from interface: com.sapportals.wcm.service.actioninbox.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
Following copied from interface: com.sapportals.wcm.service.actioninbox.IActionInboxCategory
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
Description copied from interface: IActionInboxCategory
Get a list of available actions for this category.
Specified by:
getActions in interface IActionInboxCategory
Following copied from interface: com.sapportals.wcm.service.actioninbox.IActionInboxCategory
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
Description copied from interface: IActionInboxCategory
Get a specific action by name.
Specified by:
getAction in interface IActionInboxCategory
Following copied from interface: com.sapportals.wcm.service.actioninbox.IActionInboxCategory
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
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
Following copied from interface: com.sapportals.wcm.service.actioninbox.IActionInboxCategory
Returns:
a bag of Properties with the keys of the required properties for this category, all values are set to an empty string.

getResourceType

public java.lang.String getResourceType()
Specified by:
getResourceType in interface IActionInboxCategory
Following copied from interface: com.sapportals.wcm.service.actioninbox.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
Following copied from interface: com.sapportals.wcm.service.actioninbox.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:
a - WcmException if an error occurred.

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
Following copied from interface: com.sapportals.wcm.service.actioninbox.IActionInboxCategory
Returns:
an int with the CREATION_... code.
Throws:
a - WcmException if an error occurred.

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
Following copied from interface: com.sapportals.wcm.service.actioninbox.IActionInboxCategory
Returns:
an int with the DELETION_... code.
Throws:
a - WcmException if an error occurred.

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
Following copied from interface: com.sapportals.wcm.service.actioninbox.IActionInboxCategory
Returns:
an int with the DONE_HANDLING_... code.
Throws:
a - WcmException if an error occurred.

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
Following copied from interface: com.sapportals.wcm.service.actioninbox.IActionInboxCategory
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.
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD
Copyright © 2004 by SAP AG. All Rights Reserved.
SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.