com.ibm.commerce.grouping

Interface Groupable

All Known Implementing Classes:

GiftListTypeProtectableProxy, GiftRegistryOrderDataBean, LayoutTypeProtectableProxy, OrderChangeReason, com.ibm.commerce.order.objimpl.OrderChangeReasonEntityBase, OrderDataBean, OrderProcessSystem, com.ibm.commerce.order.objimpl.OrderProcessSystemEntityBase, RFQDataBean, StoreAccessBean, StoreDataBean, UserAccessBean, UserDataBean, com.ibm.commerce.user.beansrc.UserDataBeanBase, WalletItemTypeProtectableProxy

public interface Groupable

This interface is to be implemented by the objects/resources that want to participate in the implicit resource grouping based on attributes. The implicit resource grouping is used in access control. An example would be the Order resource which the access control rules differ based on the "Status" attribute on the Order resource. So the order resource will implement Groupable interface and provide an implementation for the getGroupingAttributeValue method which would understand the "Status" attribute.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM Copyright field.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getGroupingAttributeValue(java.lang.String attributeName, GroupingContext context) Returns the value of a resource attribute - based on the attributeName and context.

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

IBM Copyright field.

See Also:

Constant Field Values

Method Detail

getGroupingAttributeValue

java.lang.Object getGroupingAttributeValue(java.lang.String attributeName,
                                           GroupingContext context)
                                    throws java.lang.Exception

Returns the value of a resource attribute - based on the attributeName and context. Used by access control to determine if a resource falls within a resource group.

Parameters:

attributeName - java.lang.String The attribute name.

context - The grouping context.

Returns:

java.lang.Object The grouping attribute value.

Throws:

java.lang.Exception