com.ibm.commerce.usermanagement.commands

Interface MemberRoleUpdateCmd

  • All Superinterfaces:
    AccCommand, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ControllerCommand, ECCommand, Protectable, java.io.Serializable, com.ibm.websphere.command.TargetableCommand
    All Known Implementing Classes:
    MemberRoleUpdateCmdImpl

    public interface MemberRoleUpdateCmd
extends ControllerCommand
    Assigns roles to a member for an organization.

    Use this command with SSL (Secure Sockets Layer) to ensure that the information are encrypted. To do so type the command with the HTTPS secure protocol.

    The parameters memberId, roleId and orgEntityId are mandatory.

    Usage:
    Usage 1
    To assign roles to a user in an organization based on the user's user_id, use the following syntax. In this example, the user with user_id 2 will be granted roles -2 and -4 in the default organization:
    memberId=2&roleId0=-2&orgEntityId0=-2000&roleId1=-4&orgEntityId1=-2000
    Note that if the user had other roles defined, then these roles will be implicitly removed. The end result will be that the user only plays the two roles defined in this example.
    Usage 2
    To define roles for an organization. In this example, the roles -2 and -4 will be added to the default organization:
    memberId=-2000&roleId0=-2&orgentityId0=-2000&roleId1=-4&orgentityId1=-2000
    Usage 3
    To assign a role to a user based on the user's distinguished name (DN). In this example, the user with DN uid=buyeraadmin,o=buyer a organization,o=root organization will be granted the -2 role in the default organization.
    distinguishedName=uid=buyeraadmin,o=buyer organization,o=root organization&roleId=-2&orgentityId=-2000
    Usage 4
    To unassign a role from a user based on the user's distinguished name (DN). This example will take away the buyeradmin's -2 role in the default organization (if it existed).
    distinguishedName=uid=buyeradmin,o=buyer organization,o=root organization&roleId=-2&orgentityId=-2000&unassignRole=true

    Exception Conditions

    • The memberId, roleId and orgEntityId must be not-null and their length must be greater than 0.

    • Field Detail

      • COPYRIGHT

        static final java.lang.String COPYRIGHT
        IBM copyright notice field.
        See Also:
        Constant Field Values

      • NAME

        static final java.lang.String NAME
        defaultCommandClassName is the default implementation class used by command factory to instantiate this command if the interface com.ibm.commerce.tools.campaigns.CalcCodeDeleteControllerCmd is not defined in the CMDREG table.
        See Also:
        Constant Field Values

      • REQUEST_PARAM_UNASSIGNROLE

        static final java.lang.String REQUEST_PARAM_UNASSIGNROLE
        Request parameter: unassignRole
        See Also:
        Constant Field Values

      • REQUEST_PARAM_UNASSIGNROLE_VALUE_TRUE

        static final java.lang.String REQUEST_PARAM_UNASSIGNROLE_VALUE_TRUE
        unassignRole request parameter value: true
        See Also:
        Constant Field Values

      • REQUEST_PARAM_MEMBERID

        static final java.lang.String REQUEST_PARAM_MEMBERID
        Request parameter: memberId
        See Also:
        Constant Field Values

      • REQUEST_PARAM_ROLEID

        static final java.lang.String REQUEST_PARAM_ROLEID
        Request parameter: roleId
        See Also:
        Constant Field Values

      • REQUEST_PARAM_ORGENTITYID

        static final java.lang.String REQUEST_PARAM_ORGENTITYID
        Request parameter: orgEntityId
        See Also:
        Constant Field Values

      • REQUEST_PARAM_DISTINGUISHEDNAME

        static final java.lang.String REQUEST_PARAM_DISTINGUISHEDNAME
        Request parameter: distinguishedName
        See Also:
        Constant Field Values

    • Method Detail

      • getMemberId

        java.lang.String getMemberId()
        Gets the memberId of the user or orgEntities to assign roles.
        Returns:
        The memberId

      • getRedirectURL

        java.lang.String getRedirectURL()
        Return redirect URL.
        Returns:
        The redirect URL.

      • setMemberId

        void setMemberId(java.lang.String astrMemberId)
        Sets the memberId of the user or orgEntities to assign roles.
        Parameters:
        astrMemberId - The memberId

      • setRedirectURL

        void setRedirectURL(java.lang.String astrRedirectURL)
        Sets redirect URL.
        Parameters:
        astrRedirectURL - The redirect URL
Skip navigation links