ProcessProfileTypeCmd

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

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:

ProcessProfileTypeCmdImpl
```
public interface ProcessProfileTypeCmd
extends TaskCommand
```
This task command is called by UserRegistration commands to determine the profileType of a user during registration.
This task command is called after the ProcessParentMember task command is called.
The default logic of this task command is:
If profileType is specified in requestProperties, check if it equals either 'C' or 'B'. If it does not equal either of these values, an exception is thrown.
If profileType is not specified in requestProperties, and parentMemberId is null or is Default Organization, then set profileType to 'C', otherwise, set profileType to 'B'.
The default logic can be overwritten.
Inputs of this task command are:
```
 setRequestProperties(TypedProperty)
 - sets request properties which may or may not contain profileType property, but should contain
   parentMemberId property, otherwise, an exception is thrown.
 
```
Outputs of this task command are:
```
 getRequestProperties(TypedProperty)
 - returns request properties which contains the profileType property.
 getProfileType
 - gets the profileType.
 
```

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT` IBM Copyright notice field.
`static java.lang.String`	`defaultCommandClassName` The default implementation of this command.
`static java.lang.String`	`NAME` The name of this command.

Fields inherited from interface com.ibm.websphere.command.Command
serialVersionUID

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.String`	`getProfileType()` Gets the profile type.
`TypedProperty`	`getRequestProperties()` Gets the request properties.
`void`	`setRequestProperties(TypedProperty aRequestProperties)` Sets the request properties.

Methods inherited from interface com.ibm.commerce.command.CacheableECCommand
execute

Methods inherited from interface com.ibm.websphere.command.CacheableCommand
executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache

Methods inherited from interface com.ibm.websphere.command.TargetableCommand
getCommandTarget, getCommandTargetName, hasOutputProperties, performExecute, setCommandTarget, setCommandTargetName, setOutputProperties

Methods inherited from interface com.ibm.websphere.command.Command
isReadyToCallExecute, reset

Methods inherited from interface com.ibm.websphere.command.CommandCaller
unionDependencies

Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

- 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
```
    The name of this command.
    
    See Also:
    
    Constant Field Values
  - defaultCommandClassName
```
static final java.lang.String defaultCommandClassName
```
    The default implementation of this command.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getProfileType
```
java.lang.String getProfileType()
```
    Gets the profile type.
    
    Returns:
    
    the profile type.
  - getRequestProperties
```
TypedProperty getRequestProperties()
```
    Gets the request properties.
    
    Returns:
    
    The request properties.
  - setRequestProperties
```
void setRequestProperties(TypedProperty aRequestProperties)
```
    Sets the request properties.
    
    Parameters:
    
    aRequestProperties - The request properties.