com.ibm.itim.dataservices.model.pim
Class GlobalCredentialSetting

java.lang.Object
  com.ibm.itim.dataservices.model.pim.CredentialSetting
      com.ibm.itim.dataservices.model.pim.GlobalCredentialSetting

All Implemented Interfaces:

java.io.Serializable

public class GlobalCredentialSetting
extends CredentialSetting

This class holds the global credential settings

Since:

6.0

See Also:

Crdential, Serialized Form

Nested Class Summary

static class

GlobalCredentialSetting.LEASE_EXPIRATION_NOTIFICATION_MODE The valid values for lease expiration handling. NOTIFY_ONLY indicates upon expiration, notification email will be sent. NOTIFY_AND_CHECKIN indicates upon expiration, credential will be automatically checked-in and lesse will be notified

Constructor Summary

GlobalCredentialSetting(Credential.AccessMode accessMode)
This Constructor is intended to set the global setting to non-shared credential.

GlobalCredentialSetting(Credential.AccessMode accessMode, boolean passwordViewable)
This Constructor is intended to set global setting to non-exclusive mode.

GlobalCredentialSetting(Credential.AccessMode accessMode, boolean resetPassword, int checkoutDuration, boolean searchEnabled, boolean passwordViewable, java.lang.String operationName)
This Constructor is intended to set global setting to the exclusive mode

Method Summary

java.util.List<NotificationTemplate>	getNotificationTemplates() This API returns the lease expiration email notification templates.
long	getnotifyFrequency() This API returns the global setting lease expiration notification frequency.
int	getNotifyOption() This API get the integer value of notificationMode property.
java.lang.String	getOperationName() This API returns the checkout operation name defined in global setting.
com.ibm.itim.workflow.definition.Participant	getParticipant() This API returns the participant for lease expiration notification.
long	getScheduleFrequency() This API returns the global setting lease expiration scheduler frequency.
boolean	isNotifyOnly() This API returns the setting of notificationMode property.
void	setNotificationTemplates(java.util.List<NotificationTemplate> notificationTemplates) This API changes the lease expiration email notification templates.
void	setNotifyFrequency(long valueInMinute) This API changes the global setting lease expiration notification frequency.
void	setNotifyOnly(GlobalCredentialSetting.LEASE_EXPIRATION_NOTIFICATION_MODE notificationMode) This API change the setting of notificationMode property.
void	setParticipant(com.ibm.itim.workflow.definition.Participant participant) This API change the participant for lease expiration notification.
void	setScheduleFrequency(long valueInMinute) This API changes the global setting lease expiration scheduler frequency.

Methods inherited from class com.ibm.itim.dataservices.model.pim.CredentialSetting

getAccessMode, getCheckoutDuration, isCheckoutSearchEnable, isExclusive, isHidePasswordEnable, isPasswordViewable, isResetPasswordAtCheckin, setAccessMode, setCheckoutDuration, setIsCheckoutSearchEnable, setIsPasswordViewable, setIsResetPasswordAtCheckin

Methods inherited from class java.lang.Object

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

Constructor Detail

GlobalCredentialSetting

public GlobalCredentialSetting(Credential.AccessMode accessMode,
                               boolean resetPassword,
                               int checkoutDuration,
                               boolean searchEnabled,
                               boolean passwordViewable,
                               java.lang.String operationName)

This Constructor is intended to set global setting to the exclusive mode

Parameters:

accessMode - Credential.AccessMode This parameter specifies the enum constant.

resetPassword - boolean This parameter specifies the boolean value that decides whether the password needs to be reset during checkin.

checkoutDuration - int This parameter specifies the maximum checkout time in hours.

searchEnabled - boolean This parameter specifies the boolean value that decides whether the credential is searchable during the checkout process.

passwordViewable - boolean This parameter specifies the boolean value that decides whether the password can be displayed to user after the checkout.

operationName - This parameter specifies the check-out operation name

GlobalCredentialSetting

public GlobalCredentialSetting(Credential.AccessMode accessMode,
                               boolean passwordViewable)

This Constructor is intended to set global setting to non-exclusive mode.

Parameters:

accessMode - Credential.AccessMode This parameter specifies the enum constant.

passwordViewable - boolean This parameter specifies the boolean value that decides whether the password can be displayed to user after the checkout.

GlobalCredentialSetting

public GlobalCredentialSetting(Credential.AccessMode accessMode)

This Constructor is intended to set the global setting to non-shared credential.

Parameters:

accessMode - Credential.AccessMode This parameter specifies the enum constant.

Method Detail

getOperationName

public java.lang.String getOperationName()

This API returns the checkout operation name defined in global setting.

getParticipant

public com.ibm.itim.workflow.definition.Participant getParticipant()

This API returns the participant for lease expiration notification.

Returns:

Participant represents the workflow participant object

setParticipant

public void setParticipant(com.ibm.itim.workflow.definition.Participant participant)

This API change the participant for lease expiration notification.

Parameters:

participant - a workflow participant object containing either person or role information

isNotifyOnly

public boolean isNotifyOnly()

This API returns the setting of notificationMode property.

Returns:

boolean true indicates NOTIFY_ONLY,
false indicates NOTIFY_AND_CHECKIN.

setNotifyOnly

public void setNotifyOnly(GlobalCredentialSetting.LEASE_EXPIRATION_NOTIFICATION_MODE notificationMode)

This API change the setting of notificationMode property.

Parameters:

notificationMode - containing the valid values of enumeration LEASE_EXPIRATION_NOTIFICATION_MODE.

getNotifyOption

public int getNotifyOption()

This API get the integer value of notificationMode property.

Returns:

int represents the integer value of notificationMode.

getScheduleFrequency

public long getScheduleFrequency()

This API returns the global setting lease expiration scheduler frequency.

Returns:

long represents the scheduler run frequency in minutes.

setScheduleFrequency

public void setScheduleFrequency(long valueInMinute)

This API changes the global setting lease expiration scheduler frequency.

Parameters:

valueInMinute - represents the scheduler run frequency in minutes.

getnotifyFrequency

public long getnotifyFrequency()

This API returns the global setting lease expiration notification frequency.

Returns:

long represents the notification frequency in minutes.

setNotifyFrequency

public void setNotifyFrequency(long valueInMinute)

This API changes the global setting lease expiration notification frequency.

Parameters:

valueInMinute - represents the notification frequency in minutes.

getNotificationTemplates

public java.util.List<NotificationTemplate> getNotificationTemplates()

This API returns the lease expiration email notification templates.

Returns:

List containing NOTIFY_ONLY template followed by NOTIFY_AND_CHECKIN template

setNotificationTemplates

public void setNotificationTemplates(java.util.List<NotificationTemplate> notificationTemplates)

This API changes the lease expiration email notification templates.

Parameters:

List - containing NOTIFY_ONLY template followed by NOTIFY_AND_CHECKIN template