com.netegrity.llsdk6.imsapi.utility
Class AccountReason

java.lang.Object
  com.netegrity.llsdk6.imsapi.utility.AccountReason

public class AccountReason
extends java.lang.Object

Contains information about how the eTrust Admin account was created.

Note: This object requires an instance of eTrust Admin Directory.

Since:

Identity Manager 8.1

Field Summary

static int	REASON_EXPLICITCREATE An administrator explicitly created the account for the user.
static int	REASON_ROLEMEMBER The account was created from information in a provisioning role that the user is assigned to -- that is, attributes in the provisioning policies contained in the role were automatically propagated to the account.

Constructor Summary

AccountReason()
Internal use only.

AccountReason(java.lang.String roleName, java.lang.String policyName)
Internal use only.

AccountReason(java.lang.String creator, java.lang.String creationDate, java.lang.String creationComments)
Internal use only.

Method Summary

java.lang.String	getExplicitCreationComments() Retrieves any comments provided for an explicitly created account.
java.lang.String	getExplicitCreationDate() Retrieves the date that the account was explicitly created.
java.lang.String	getExplicitCreatorName() Retrieves the name of the administrator who explicitly created the account.
java.lang.String	getPolicyName() Retrieves the name of the policy whose attributes were used to create the user's account.
int	getReasonCode() Retrieves the reason code that applies to this AccountReason object.
java.lang.String	getRoleName() Retrieves the name of the role whose policy attributes were used to create the user's account.
void	setExplicitCreationComments(java.lang.String creationComments) Internal use only.
void	setExplicitCreationDate(java.lang.String creationDate) Internal use only.
void	setExplicitCreatorName(java.lang.String creatorName) Internal use only.
void	setPolicyName(java.lang.String policyName) Internal use only.
void	setReasonCode(int reason) Internal use only.
void	setRoleName(java.lang.String roleName) Internal use only.
java.lang.String	toString() Retuns the Account Reasons formatted as a string.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

REASON_ROLEMEMBER

public static int REASON_ROLEMEMBER

The account was created from information in a provisioning role that the user is assigned to -- that is, attributes in the provisioning policies contained in the role were automatically propagated to the account.

REASON_EXPLICITCREATE

public static int REASON_EXPLICITCREATE

An administrator explicitly created the account for the user.

Constructor Detail

AccountReason

public AccountReason()

Internal use only.

AccountReason

public AccountReason(java.lang.String roleName,
                     java.lang.String policyName)

Internal use only.

AccountReason

public AccountReason(java.lang.String creator,
                     java.lang.String creationDate,
                     java.lang.String creationComments)

Internal use only.

Method Detail

setReasonCode

public void setReasonCode(int reason)

Internal use only.

getReasonCode

public int getReasonCode()

Retrieves the reason code that applies to this AccountReason object.

setRoleName

public void setRoleName(java.lang.String roleName)

Internal use only.

getRoleName

public java.lang.String getRoleName()

Retrieves the name of the role whose policy attributes were used to create the user's account.

The account is automatically created when the user is assigned to the role.

setPolicyName

public void setPolicyName(java.lang.String policyName)

Internal use only.

getPolicyName

public java.lang.String getPolicyName()

Retrieves the name of the policy whose attributes were used to create the user's account.

setExplicitCreatorName

public void setExplicitCreatorName(java.lang.String creatorName)

Internal use only.

getExplicitCreatorName

public java.lang.String getExplicitCreatorName()

Retrieves the name of the administrator who explicitly created the account.

setExplicitCreationDate

public void setExplicitCreationDate(java.lang.String creationDate)

Internal use only.

getExplicitCreationDate

public java.lang.String getExplicitCreationDate()

Retrieves the date that the account was explicitly created.

setExplicitCreationComments

public void setExplicitCreationComments(java.lang.String creationComments)

Internal use only.

getExplicitCreationComments

public java.lang.String getExplicitCreationComments()

Retrieves any comments provided for an explicitly created account.

toString

public java.lang.String toString()

Retuns the Account Reasons formatted as a string.

Overrides:

toString in class java.lang.Object

Returns:

A string containing the reasons - formatted as: "Role=[roleName]& Policy=[policyName]: CreatorName=[explicitCreatorName]& CreationDate=[explicitCreationDate]& CreationComments=[explicitCreationComments]"