oracle.hsgbu.hdr.configuration

Interface ProfileOptionService

public interface ProfileOptionService

Field Summary

Fields

Modifier and Type	Field and Description
static String	SITE_LEVEL_NAME
static String	USER_LEVEL_NAME

Method Summary

Modifier and Type	Method and Description
void	createProfileOption(ProfileOption profileOption) Creates a profile option.
ProfileOption[]	getProfileOptions(String profileOptionCode, String profileOptionName, String activeFlag, String sysAdminVisibleOnly, String userVisibleOnly) Retrieves profile options based on ExternalApplicationTxt, profileOptionCode, profileOptionName, activeFlag, sysAdminVisibleOnly, and userVisibleOnly.
String	getProfileOptionValue(String profileOptionCode) Retrieves the value of a profile option.
String	getProfileOptionValueForLevel(String profileOptionCode, String profileLevelCode, String profileLevelValueId) Retrieves the value of a profile option for a specific level and level instance.If not value is set at the specific level and level instance, it will return the value set at SITE level.
void	inactivateProfileOption(String profileOptionCode) Deactivates a profile option by setting the EffectiveEndDate as the current date and time.
void	setProfileOptionValue(ProfileOptionValue profileOptionValue) Sets the value of a profile option.
void	updateProfileOption(ProfileOption profileOption) Updates a profile option.

Field Detail

USER_LEVEL_NAME

static final String USER_LEVEL_NAME

See Also:

Constant Field Values

SITE_LEVEL_NAME

static final String SITE_LEVEL_NAME

See Also:

Constant Field Values

Method Detail

createProfileOption

void createProfileOption(ProfileOption profileOption)
                  throws HDRConfigException

Creates a profile option.

Parameters:

profileOption - ProfileOption value object that have to be created.

Throws:

HDRConfigException -

• If ProfileOptionCode is not unique.
• If ProfileOptionName is not unique.
• If EffectiveStartDate of the profile option is later than EffectiveEndDate.
• If flag values are not set to "Y" or "N".
• If an updateable flag is set to "Y" when the corresponding visible flag is set to "N". For example, if SiteUpdateableFlag is set to "Y" when SiteVisibleFlag is set to "N".
• If an user access updateable flag is set to "Y" when the corresponding user updateable flag is set to "N". For example, if UserAccessUpdateableFlag is set to "Y" when UserUpdateableFlag is set to "N".
• If Constraint1 does not contain valid concept lists when ValueTypeCode is set to "LOOKUP".

updateProfileOption

void updateProfileOption(ProfileOption profileOption)
                  throws HDRConfigException

Updates a profile option.

Parameters:

profileOption - ProfileOption value object that have to be updated.

Throws:

HDRConfigException -

• If ProfileOptionName is not unique.
• If EffectiveStartDate of the profile option is later than EffectiveEndDate.
• If flag values are not set to "Y" or "N".
• If an updateable flag is set to "Y" when the corresponding visible flag is set to "N". For example, if SiteUpdateableFlag is set to "Y" when SiteVisibleFlag is set to "N".
• If an user access updateable flag is set to "Y" when the corresponding user updateable flag is set to "N". For example, if UserAccessUpdateableFlag is set to "Y" when UserUpdateableFlag is set to "N".
• If Constraint1 does not contain valid concept lists when ValueTypeCode is set to "LOOKUP".

inactivateProfileOption

void inactivateProfileOption(String profileOptionCode)
                      throws HDRConfigException

Deactivates a profile option by setting the EffectiveEndDate as the current date and time. For any inactivated profile option, we can neither set the profile value nor get the profile value.

Parameters:

profileOptionCode - ProfileOption value oject that have to be deactivated.

Throws:

HDRConfigException - If ProfileOptionCode is not valid.

getProfileOptions

ProfileOption[] getProfileOptions(String profileOptionCode,
                                  String profileOptionName,
                                  String activeFlag,
                                  String sysAdminVisibleOnly,
                                  String userVisibleOnly)
                           throws HDRConfigException

Retrieves profile options based on ExternalApplicationTxt, profileOptionCode, profileOptionName, activeFlag, sysAdminVisibleOnly, and userVisibleOnly.

Parameters:

profileOptionCode - Unique identifier of the profile option.

profileOptionName - Name of the profile option.

activeFlag - Status of the profile option. The valid values are "Y" and "N". Indicate "Y" if the profile option is active and "N" if inactive.

sysAdminVisibleOnly - Flag indicating if the profile options to be retrieved are visible to the system administrator at any level. The valid values are "Y" and "N".

userVisibleOnly - Flag indicating if the profile options to be retrieved are visible to the user. The valid values are "Y" and "N".

Returns:

Array of ProfileOption value objects that meet the criteria.

Throws:

HDRConfigException

setProfileOptionValue

void setProfileOptionValue(ProfileOptionValue profileOptionValue)
                    throws HDRConfigException

Sets the value of a profile option. Cannot set the value for an inactivated profile option.

Parameters:

profileOptionValue - ProfileOptionValue value object.

Throws:

HDRConfigException -

• If the ProfileOptionValue is invalid.
• If ProfileOptionValue does not contain valid concept list when ValueTypeCode is set to "LOOKUP".
• If ProfileOptionLevelValue is not a user identifier when ProfileOptionLevelCode is set to "USER".
• If the ProfileOptionLevelCode is invalid.
• If any user other than sysadmin attempts to set profile option value for other user.
• If the Profile Option is inactivated.

getProfileOptionValue

String getProfileOptionValue(String profileOptionCode)
                      throws HDRConfigException

Retrieves the value of a profile option. This method retrieves the value of the profile option, if any, using the following hierarchy:

1. The value for the logged in user is retrieved.
2. If the value for the user who is logged in is null, the value for the site level is retrieved.
3. Retrievesnull, if the all the visible flags at sysadnin level is set to 'N'.
4. Retrievesnull, if the visible flag at user level is set to 'N'.

Parameters:

profileOptionCode - ProfileOptionCode.

Returns:

Value of a profile option. null if the profile option is not set at any of the level instances. Will return null value for an inactivated profile option. But the API is dependent on the middle-tier cache to retrieve the value for an inactivated profile option. So till the middle-tier cache is synchronized with the DB this api will return the profile value. Cache timing can be controlled through the caching framework global setting.

Throws:

HDRConfigException - If the ProfileOptionCode is invalid.

getProfileOptionValueForLevel

String getProfileOptionValueForLevel(String profileOptionCode,
                                     String profileLevelCode,
                                     String profileLevelValueId)
                              throws HDRConfigException

Retrieves the value of a profile option for a specific level and level instance.If not value is set at the specific level and level instance, it will return the value set at SITE level. Will return null value for an inactivated profile option. Retrievesnull, if the all the visible flags at sysadnin level is set to 'N'. Retrievesnull, if the visible flag at user level is set to 'N' or if the visible flag at that specific level is set to 'N'

Parameters:

profileOptionCode - ProfileOptionCode of this ProfileOption. This attribute is mandatory.

profileLevelCode - ProfileOptionLevelCode of this ProfileOption. This attribute is mandatory and is validated against the CTB_PROFILE_OPTION_LEVELS concept list.

profileLevelValueId - ProfileOptionLevelValue of this ProfileOption.

• If ProfileOptionLevelCode is "USER", the parameter must be the user identifier.
• If ProfileOptionLevelCode is "SITE", the parameter must be null .

This attribute is mandatory if ProfileOptionLevelCode is not "SITE".

Returns:

Value of a profile option for a specific level and level instance.

Throws:

HDRConfigException -

• If ProfileOptionCode is invalid.
• If ProfileOptionLevelCode is invalid.
• If ProfileOptionLevelValue is invalid.