com.ibm.commerce.user.beans

Class 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 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

      • 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.
      • 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.
      • 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.
      • 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.