com.ibm.commerce.usermanagement.commands

Interface ProcessParentMemberCmd

  • All Superinterfaces:
    com.ibm.websphere.command.CacheableCommand, com.ibm.commerce.command.CacheableECCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ECCommand, java.io.Serializable, com.ibm.websphere.command.TargetableCommand, TaskCommand
    All Known Implementing Classes:
    ProcessParentMemberCmdImpl


    public interface ProcessParentMemberCmd
    extends TaskCommand
    This task command is used to calculate parentMemberId from given parentMember property.

    parentMember property can be encrypted parentMemberId or DN.
    If this task command is called by UserRegistrationAdminAdd/Update command, parentMember can also be un-encrypted parentMemberId.

    Inputs of this task command are:

     setRequestProperties(TypedProperty)
     - set request properties which should contain parentMember property. It may also contain
       parentMemberId (it will be ignored if the task command is not called by 
       UserRegistrationAdminAdd/Upate command).
     
    Outputs of this task command are:
     getRequestProperties(TypedProperty)
     - returns request properties which contains calculated parentMemberId property. The 'parentmember'
       property is removed.
     public OrganizationAccessBean getParentMember()
     - returns the parent OrganizationAccessBean
     public String getParentMemberType()
     - returns the type of parent organization ('O' or 'OU'). 
     
    • Field Detail

      • COPYRIGHT

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

        static final java.lang.String defaultCommandClassName
        The default implementation of this command.
        See Also:
        Constant Field Values
      • REQUEST_PARAM_PARENTMEMBERID

        static final java.lang.String REQUEST_PARAM_PARENTMEMBERID
        Request parameter: parentMemberId
        See Also:
        Constant Field Values
      • REQUEST_PARAM_PARENTMEMBER

        static final java.lang.String REQUEST_PARAM_PARENTMEMBER
        Request parameter: parentMember
        See Also:
        Constant Field Values
      • REQUEST_PARAM_APPENDROOTORGANIZATIONDN

        static final java.lang.String REQUEST_PARAM_APPENDROOTORGANIZATIONDN
        Request parameter: addParentMember
        See Also:
        Constant Field Values
      • RESPONSE_PARAM_PARENTMEMBERID

        static final java.lang.String RESPONSE_PARAM_PARENTMEMBERID
        Response parameter: parentMemberId
        See Also:
        Constant Field Values
    • Method Detail

      • getParentMember

        OrganizationAccessBean getParentMember()
        Gets the parent OrganizationAccessBean.
        Returns:
        The parent OrganizationAccessBean
      • getParentMemberType

        java.lang.String getParentMemberType()
        Gets the type of parent organization ('O' or 'OU').
        Returns:
        The type of parent organization
      • getRequestProperties

        TypedProperty getRequestProperties()
        Gets the processed request properties which contains calculated parentMemberId property. The parentMember property is removed.
        Returns:
        The request properties
      • setRequestProperties

        void setRequestProperties(TypedProperty aRequestProperties)
        Set the request properties which should contain parentMember property. It may also contain parentMemberId (it will be ignored if the task command is not called by UserRegistrationAdminAdd/Update command).
        Parameters:
        aRequestProperties - The request properties