com.ibm.di.connector.dominoUsers
Class UserDeletion

java.lang.Object
  com.ibm.di.connector.dominoUsers.UserDeletion

All Implemented Interfaces:

IDominoAction

public class UserDeletion
extends Object
implements IDominoAction

Field Summary

static String	ATTR_NAME_DELETE_GROUP_NAME
static String	ATTR_NAME_DELETE_MAIL_FILE
static int	DELETE_MAIL_FILE_DATABASE
static int	DELETE_MAIL_FILE_DONT
static int	DELETE_MAIL_FILE_REPLICAS

Constructor Summary

UserDeletion(DominoUsersConnector aParent)

Method Summary

String	canPerform() Inspects the data stored in the local data holders and determines if it is consistent and the Domino Action can be performed.
Entry	extractAndStoreData(Entry aEntry) This method extracts and stores data.
String	getAddToGroup()
String	getAddToGroupActionValue()
String	getDefaultAddToGroup()
int	getDefaultDeleteMailFile()
Integer	getDeleteMailFile()
String	getDeleteMailFileActionValue()
String	getUserFullName()
String	getUserMailFile()
boolean	mustPerform(Entry aEntry) Inspects the Attributes of the given Entry and determines if the Domino Action has to be performed.
void	perform() Performs the Domino Action useing the data from the local data holders.
void	resetData() Resets the local data holders to empty/default values according the business logic of the Domino Action.
void	setAddToGroup(String aAddToGroup)
void	setDefaultAddToGroup(String aDefaultAddToGroup)
void	setDefaultDeleteMailFile(int aDefaultDeleteMailFile)
void	setDeleteMailFile(Integer aDeleteMailFile)
void	setUserFullName(String aUserFullName)
void	setUserMailFile(String aUserMailFile)

Methods inherited from class java.lang.Object

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

Field Detail

ATTR_NAME_DELETE_MAIL_FILE

public static final String ATTR_NAME_DELETE_MAIL_FILE

See Also:

Constant Field Values

ATTR_NAME_DELETE_GROUP_NAME

public static final String ATTR_NAME_DELETE_GROUP_NAME

See Also:

Constant Field Values

DELETE_MAIL_FILE_DONT

public static final int DELETE_MAIL_FILE_DONT

See Also:

Constant Field Values

DELETE_MAIL_FILE_DATABASE

public static final int DELETE_MAIL_FILE_DATABASE

See Also:

Constant Field Values

DELETE_MAIL_FILE_REPLICAS

public static final int DELETE_MAIL_FILE_REPLICAS

See Also:

Constant Field Values

Constructor Detail

UserDeletion

public UserDeletion(DominoUsersConnector aParent)
             throws Exception

Throws:

Exception

Method Detail

getDefaultDeleteMailFile

public int getDefaultDeleteMailFile()

setDefaultDeleteMailFile

public void setDefaultDeleteMailFile(int aDefaultDeleteMailFile)
                              throws Exception

Throws:

Exception

getDefaultAddToGroup

public String getDefaultAddToGroup()

setDefaultAddToGroup

public void setDefaultAddToGroup(String aDefaultAddToGroup)
                          throws Exception

Throws:

Exception

getDeleteMailFile

public Integer getDeleteMailFile()

setDeleteMailFile

public void setDeleteMailFile(Integer aDeleteMailFile)

getAddToGroup

public String getAddToGroup()

setAddToGroup

public void setAddToGroup(String aAddToGroup)

getUserFullName

public String getUserFullName()

setUserFullName

public void setUserFullName(String aUserFullName)

getUserMailFile

public String getUserMailFile()

setUserMailFile

public void setUserMailFile(String aUserMailFile)

extractAndStoreData

public Entry extractAndStoreData(Entry aEntry)
                          throws Exception

Description copied from interface: IDominoAction

This method extracts and stores data. It performs the following actions:

(1) Extract data from the given Entry according to the fixed schema of Attributes;

(2) Stores this data into local data holders;

Specified by:

extractAndStoreData in interface IDominoAction

Parameters:

aEntry - The Entry object to extract data from.

Returns:

an Entry object that contains all Attributes of the aEntry parameter except those from the fixed schema.

Throws:

Exception - if an error that cannot be handled occurs while operating.

mustPerform

public boolean mustPerform(Entry aEntry)
                    throws Exception

Description copied from interface: IDominoAction

Inspects the Attributes of the given Entry and determines if the Domino Action has to be performed.

Specified by:

mustPerform in interface IDominoAction

Parameters:

aEntry - The Entry object which Attributes hold the necessary information whether to perform the Domino Action.

Returns:

"true" if the Domino Action must be performed; "false" otherwise.

Throws:

Exception - if an error that cannot be handled occurs while operating.

canPerform

public String canPerform()

Description copied from interface: IDominoAction

Inspects the data stored in the local data holders and determines if it is consistent and the Domino Action can be performed.

Specified by:

canPerform in interface IDominoAction

Returns:

"null" if the Domino Action can be performed with the current data;

and a non-empty string message explaining the problem, if the data is not consistent and the Action cannot be performed.

perform

public void perform()
             throws Exception

Description copied from interface: IDominoAction

Performs the Domino Action useing the data from the local data holders.

Specified by:

perform in interface IDominoAction

Throws:

Exception - if an error that cannot be handled occurs while operating.

resetData

public void resetData()
               throws Exception

Description copied from interface: IDominoAction

Resets the local data holders to empty/default values according the business logic of the Domino Action.

Specified by:

resetData in interface IDominoAction

Throws:

Exception - if an error that cannot be handled occurs while operating.

getDeleteMailFileActionValue

public String getDeleteMailFileActionValue()

getAddToGroupActionValue

public String getAddToGroupActionValue()