com.ibm.commerce.user.beans

Class OrganizationListDataBean

java.lang.Object

com.ibm.commerce.beans.InputDataBeanImpl

com.ibm.commerce.beans.SmartDataBeanImpl

com.ibm.commerce.user.beans.OrganizationListDataBean

All Implemented Interfaces:

DataBean, InputDataBean, SmartDataBean, java.io.Serializable

public class OrganizationListDataBean
extends SmartDataBeanImpl

This organization list data bean is used to get all the organizations that a register customer is entitled to shop under. The criteria used to determine the organizations where a user can shop are: - user's parent organization - user has the "Organization Participant" role set explicitly in an organization - any descendant organizations of the organizations where the user's has the "Organization Participant" role There are different settings that can affect the results: - if setExplicitEntitlement is set to true then only the organization where the user has the "Organization Participant" role set explicitly will be returned. It will exclude the parent organization and any sub-organizations inheritance of roles. The default behaviour has this flag set to false.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT The internal copyright field.

Fields inherited from interface com.ibm.commerce.beans.DataBean

emptyString

Constructor Summary

Constructors

Constructor and Description
OrganizationListDataBean() OrganizationListDataBean constructor comment.

Method Summary

Modifier and Type	Method and Description
boolean	getAccountCheck() Gets the user ID of selected organization.
CommandContext	getCommandContext() Get the command context.
OrganizationAccessBean[]	getEntitledOrganizations() Get the list of organizations that the user can shop under.
TypedProperty	getRequestProperties() Get the request properties.
void	populate() Search for the organizations that the user can shop under and save the result set in the entiledOrganizations.
void	setAccountCheck(boolean iAccountCheck) Sets the Account check to be included or not.
void	setCommandContext(CommandContext inCommandContext) Set the command context.
void	setExplicitEntitlement(boolean isExplicitEntitlementOnly) Make the result set of organizations to only return the actual organizations where the role is played.
void	setRequestProperties(TypedProperty param) Set the request properties for the bean.

Methods inherited from class com.ibm.commerce.beans.SmartDataBeanImpl

fulfills, getHttpRequest, getHttpResponse, getResources, getViewCommandContext, setHttpRequest, setHttpResponse, setViewCommandContext

Methods inherited from class java.lang.Object

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

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

The internal copyright field.

See Also:

Constant Field Values

Constructor Detail

OrganizationListDataBean

public OrganizationListDataBean()

OrganizationListDataBean constructor comment.

Method Detail

getCommandContext

public CommandContext getCommandContext()

Get the command context.

Specified by:

getCommandContext in interface SmartDataBean

Overrides:

getCommandContext in class SmartDataBeanImpl

Returns:

the com.ibm.commerce.command.CommandContext.

getEntitledOrganizations

public OrganizationAccessBean[] getEntitledOrganizations()

Get the list of organizations that the user can shop under.

Returns:

Array of organization data beans that a user can shop under.

getRequestProperties

public TypedProperty getRequestProperties()

Get the request properties.

Specified by:

getRequestProperties in interface InputDataBean

Overrides:

getRequestProperties in class InputDataBeanImpl

Returns:

the com.ibm.commerce.datatype.TypedProperty containing the request properties.

populate

public void populate()
              throws java.lang.Exception

Search for the organizations that the user can shop under and save the result set in the entiledOrganizations.

Specified by:

populate in interface SmartDataBean

Overrides:

populate in class SmartDataBeanImpl

Throws:

java.lang.Exception - Any uncaught exception encountered during execution.

setCommandContext

public void setCommandContext(CommandContext inCommandContext)

Set the command context.

Specified by:

setCommandContext in interface SmartDataBean

Overrides:

setCommandContext in class SmartDataBeanImpl

Parameters:

inCommandContext - com.ibm.commerce.command.CommandContext.

setExplicitEntitlement

public void setExplicitEntitlement(boolean isExplicitEntitlementOnly)

Make the result set of organizations to only return the actual organizations where the role is played. If set to true the parent organization of the user will not be returned as part of the result set. And no sub-organization inheritance of roles will be taken into account.

Parameters:

isExplicitEntitlementOnly - To perform explicit role search only.

setRequestProperties

public void setRequestProperties(TypedProperty param)
                          throws java.lang.Exception

Set the request properties for the bean.

Specified by:

setRequestProperties in interface InputDataBean

Overrides:

setRequestProperties in class InputDataBeanImpl

Parameters:

param - This is an object that represents the set of properties passed to the JSP page that invokes this data bean.

Throws:

java.lang.Exception - Any uncaught exception encountered during execution.

See Also:

InputDataBean.setRequestProperties(com.ibm.commerce.datatype.TypedProperty)

setAccountCheck

public void setAccountCheck(boolean iAccountCheck)

Sets the Account check to be included or not.

Parameters:

iAccountCheck - Business Account Check.

getAccountCheck

public boolean getAccountCheck()

Gets the user ID of selected organization.

Returns:

accountCheck Business Account Check.