oracle.hsgbu.hdr.configuration

Interface ProfileOption

All Superinterfaces:

Serializable

public interface ProfileOption
extends Serializable

Defines methods for updating and retrieving attributes of a profile option. Profile option is a user-defined variable whose value influences application behavior at run-time. Profile options offer a mechanism by which multi-level preferences can be declared in HDR.

Attributes of ProfileOption value object:

Attribute Name	Type	Mandatory	Update Allowed	Validated	Description
ProfileOptionCode	String	Yes	Yes	Yes	Uniquely identifies a profile option.Only UPPER CASE letters should be used for Profile Option Code. See: getProfileOptionCode(). See: setProfileOptionCode(java.lang.String)
ProfileOptionName	String	Yes	Yes	Yes	Unique name of the profile option. See: getProfileOptionName(). See: setProfileOptionName(java.lang.String)
Description	String	No	Yes	No	Additional information about the profile option. See: getDescription(). See: setDescription(java.lang.String)
ValueTypeCode	String	No	Yes	Yes	Can be set to "LOOKUP" or null. See: getValueTypeCode(). See: setValueTypeCode(java.lang.String)
ValueTypeCodeConstraint	String	No	Yes	Yes	Value type code constraint on the profile option.This constraint is to be set if the ProfileOption ValueTypeCode is set to "LOOKUP" See: setConstraint1(java.lang.String)
UserVisibleFlag	String	No	Yes	Yes	Flag that indicates if system administrators can view ProfileOptionValue at the user level. The default value of this attribute is "Y". See: getUserVisibleFlag(). See: setUserVisibleFlag(java.lang.String)
UserUpdateableFlag	String	No	Yes	Yes	Flag that indicates if system administrators can update ProfileOptionValue at the user level. If the value of UserVisibleFlag attribute is "Y", this attribute defaults to "Y". If the value of UserVisibleFlag attribute is "N", this attribute defaults to "N". See: getUserUpdateableFlag(). See: setUserUpdateableFlag(java.lang.String)
SiteVisibleFlag	String	No	Yes	Yes	Flag that indicates if system administrators can view ProfileOptionValue at the site level. The default value of this attribute is "Y". See: getSiteVisibleFlag(). See: setSiteVisibleFlag(java.lang.String)
SiteUpdateableFlag	String	No	Yes	Yes	Flag that indicates if system administrators can update ProfileOptionValue at the site level. If the value of SiteVisibleFlag attribute is "Y", this attribute defaults to "Y". If the value of SiteVisibleFlag attribute is "N", this attribute defaults to "N". See: getSiteUpdateableFlag(). See: setSiteUpdateableFlag(java.lang.String)
ApplicationShortName	String	No	Yes	Yes	Represents the Application Short Name to which the ProfileOption belongs. The default value of this attribute is "HDR". See: getApplicationShortName(). See: setApplicationShortName(java.lang.String)
EffectiveStartDate	String	No	Yes	Yes	Date and time when the profile option becomes active. The default value for this attribute is the current date and time. See: getEffectiveStartDate(). See: setEffectiveStartDate(java.util.Date)
EffectiveEndDate	String	No	Yes	Yes	Date and time when the profile option becomes inactive. See: getEffectiveEndDate(). See: setEffectiveEndDate(java.util.Date)

Field Summary

Fields

Modifier and Type	Field and Description
static String	HDR_APPLICATION_SHORT_NAME Profile Option ApplicationShortName.
static String	LOOKUP_VALUE_TYPE_CODE Profile Option ValueTypeCode.

Method Summary

Modifier and Type	Method and Description
String	getApplicationShortName() Gets the ApplicationShortName for a profile option.
String	getConstraint1() Gets the first constraint on profile option.
String	getDescription() Gets the description of a profile option.
Date	getEffectiveEndDate() Gets the date and time when the profile option becomes inactive.
Date	getEffectiveStartDate() Returns the date and time when the profile option becomes active.
String	getProfileOptionCode() Gets the unique identifier of a profile option.
String	getProfileOptionName() Gets the name of a profile option.
String	getSiteUpdateableFlag() Gets the flag that indicates if system administrators can update ProfileOptionValue at the site level.
String	getSiteVisibleFlag() Gets the flag that indicates if system administrators can view ProfileOptionValue at the site level.
String	getUserUpdateableFlag() Gets the flag that indicates if system administrators can update ProfileOptionValue at the user level.
String	getUserVisibleFlag() Gets the flag that indicates if system administrators can view ProfileOptionValue at the user level.
String	getValueTypeCode() Gets the ValueTypeCode of the profile option.
String	getValueTypeCodeConstraint() Gets the value type code constraint on profile option.
void	setApplicationShortName(String applicationShortName) Sets the ApplicationShortName for a profile option.
void	setConstraint1(String constraint1) Sets the constraint on profile option based on the ValueTypeCode set.
void	setDescription(String description) Sets the description of a profile option.
void	setEffectiveEndDate(Date effectiveEndDate) Sets the date and time when the profile option becomes inactive.
void	setEffectiveStartDate(Date effectiveStartDate) Sets the date and time when the profile option becomes active.
void	setProfileOptionCode(String profileOptionCode) Sets the unique identifier of a profile option.
void	setProfileOptionName(String profileOptionName) Sets the name of a profile option.
void	setSiteUpdateableFlag(String siteUpdateableFlag) Sets the flag that indicates if system administrators can update ProfileOptionValue at the site level.
void	setSiteVisibleFlag(String siteVisibleFlag) Sets the flag that indicates if system administrators can view ProfileOptionValue at the site level.
void	setUserUpdateableFlag(String userUpdateableFlag) Sets the flag that indicates if system administrators can update ProfileOptionValue at the user level.
void	setUserVisibleFlag(String userVisibleFlag) Sets the flag that indicates if system administrators can view ProfileOptionValue at the user level.
void	setValueTypeCode(String valueTypeCode) Sets the ValueTypeCode of the profile option.
void	setValueTypeCodeConstraint(String constraint) Sets the value type code constraint on profile option based on the ValueTypeCode set.

Field Detail

LOOKUP_VALUE_TYPE_CODE

static final String LOOKUP_VALUE_TYPE_CODE

Profile Option ValueTypeCode. Can be set to LOOKUP or NULL.

See Also:

Constant Field Values

HDR_APPLICATION_SHORT_NAME

static final String HDR_APPLICATION_SHORT_NAME

Profile Option ApplicationShortName. Can be set to HDR or any other registered and valid FND application name.

See Also:

Constant Field Values

Method Detail

setProfileOptionCode

void setProfileOptionCode(String profileOptionCode)

Sets the unique identifier of a profile option.

Parameters:

profileOptionCode - Unique identifier of the profile option. Only UPPER CASE letters should be used for Profile Option Code.

See Also:

getProfileOptionCode()

getProfileOptionCode

String getProfileOptionCode()

Gets the unique identifier of a profile option.

Returns:

Unique identifier of the profile option.

See Also:

setProfileOptionCode(java.lang.String)

setProfileOptionName

void setProfileOptionName(String profileOptionName)

Sets the name of a profile option.

Parameters:

profileOptionName - Name of the profile option.

See Also:

getProfileOptionCode()

getProfileOptionName

String getProfileOptionName()

Gets the name of a profile option.

Returns:

Name of the profile option.

See Also:

setProfileOptionCode(java.lang.String)

setApplicationShortName

void setApplicationShortName(String applicationShortName)

Sets the ApplicationShortName for a profile option.

Parameters:

applicationShortName - ApplicationShortName for this ProfileOption.

See Also:

getApplicationShortName()

getApplicationShortName

String getApplicationShortName()

Gets the ApplicationShortName for a profile option.

Returns:

ApplicationShortName of this ProfileOption.

See Also:

setApplicationShortName(java.lang.String)

setDescription

void setDescription(String description)

Sets the description of a profile option.

Parameters:

description - Description of the profile option.

See Also:

getDescription()

getDescription

String getDescription()

Gets the description of a profile option.

Returns:

The description of the profile option.

See Also:

setDescription(java.lang.String)

setValueTypeCode

void setValueTypeCode(String valueTypeCode)

Sets the ValueTypeCode of the profile option. This attribute is used to determine the valid values of the profile option. This attribute can be set to "LOOKUP" or null.

Parameters:

valueTypeCode - ValueTypeCode for this ProfileOption.

getValueTypeCode

String getValueTypeCode()

Gets the ValueTypeCode of the profile option.

Returns:

ValueTypeCode of this ProfileOption.

See Also:

getValueTypeCode()

setValueTypeCodeConstraint

void setValueTypeCodeConstraint(String constraint)

Sets the value type code constraint on profile option based on the ValueTypeCode set.

• If ValueTypeCode is "LOOKUP", ValueTypeCodeConstraint can contain any active concept lists with LOOKUPS_GROUP set to "LOOKUPS".

Parameters:

constraint - Value type code constraint on profile option.

getValueTypeCodeConstraint

String getValueTypeCodeConstraint()

Gets the value type code constraint on profile option.

Returns:

value type code constraint on profile option.

See Also:

setValueTypeCodeConstraint(java.lang.String)

setUserVisibleFlag

void setUserVisibleFlag(String userVisibleFlag)

Sets the flag that indicates if system administrators can view ProfileOptionValue at the user level. The default value of this attribute is "Y".

Parameters:

userVisibleFlag - UserVisibleFlag for this ProfileOption . The valid values are "Y" and "N".

See Also:

getUserVisibleFlag()

getUserVisibleFlag

String getUserVisibleFlag()

Gets the flag that indicates if system administrators can view ProfileOptionValue at the user level.

Returns:

Flag that indicates if system administrators can view ProfileOptionValue at the user level.

See Also:

setUserVisibleFlag(java.lang.String)

setUserUpdateableFlag

void setUserUpdateableFlag(String userUpdateableFlag)

Sets the flag that indicates if system administrators can update ProfileOptionValue at the user level. If the value of UserVisibleFlag attribute is "Y", this attribute defaults to "Y". If the value of UserVisibleFlag attribute is "N", this attribute defaults to "N".

Parameters:

userUpdateableFlag - UserUpdateableFlag for this ProfileOption. The valid values are "Y" and "N". You cannot set UserUpdateableFlag to "Y" if UserVisibleFlag is set to "N".

See Also:

getUserUpdateableFlag()

getUserUpdateableFlag

String getUserUpdateableFlag()

Gets the flag that indicates if system administrators can update ProfileOptionValue at the user level.

Returns:

Flag that indicates if system administrators can update ProfileOptionValue at the user level.

See Also:

setUserUpdateableFlag(java.lang.String)

setSiteVisibleFlag

void setSiteVisibleFlag(String siteVisibleFlag)

Sets the flag that indicates if system administrators can view ProfileOptionValue at the site level. The default value of this attribute is "Y".

Parameters:

siteVisibleFlag - SiteVisibleFlag for this ProfileOption . The valid values are "Y" and "N".

See Also:

getSiteVisibleFlag()

getSiteVisibleFlag

String getSiteVisibleFlag()

Gets the flag that indicates if system administrators can view ProfileOptionValue at the site level.

Returns:

Flag that indicates if system administrators can view ProfileOptionValue at the site level.

See Also:

setSiteVisibleFlag(java.lang.String)

setSiteUpdateableFlag

void setSiteUpdateableFlag(String siteUpdateableFlag)

Sets the flag that indicates if system administrators can update ProfileOptionValue at the site level. If the value of SiteVisibleFlag attribute is "Y", this attribute defaults to "Y". If the value of SiteVisibleFlag attribute is "N", this attribute defaults to "N".

Parameters:

siteUpdateableFlag - SiteUpdateableFlag for this ProfileOption. The valid values are "Y" and "N". You cannot set SiteUpdateableFlag to "Y" if SiteVisibleFlag is set to "N".

See Also:

getSiteUpdateableFlag()

getSiteUpdateableFlag

String getSiteUpdateableFlag()

Gets the flag that indicates if system administrators can update ProfileOptionValue at the site level.

Returns:

Flag that indicates if system administrators can update ProfileOptionValue at the site level.

See Also:

setSiteUpdateableFlag(java.lang.String)

setEffectiveStartDate

void setEffectiveStartDate(Date effectiveStartDate)

Sets the date and time when the profile option becomes active.

Parameters:

effectiveStartDate - Date and time when the profile option becomes active.

See Also:

getEffectiveStartDate()

getEffectiveStartDate

Date getEffectiveStartDate()

Returns the date and time when the profile option becomes active.

Returns:

Date and time when the profile option becomes active.

See Also:

setEffectiveStartDate(java.util.Date)

setEffectiveEndDate

void setEffectiveEndDate(Date effectiveEndDate)

Sets the date and time when the profile option becomes inactive. This date and time must be later than EffectiveStartDate.

Parameters:

effectiveEndDate - Date and time when the profile option becomes inactive.

See Also:

getEffectiveEndDate()

getEffectiveEndDate

Date getEffectiveEndDate()

Gets the date and time when the profile option becomes inactive.

Returns:

Date and time when the profile option becomes inactive.

See Also:

setEffectiveEndDate(java.util.Date)

setConstraint1

void setConstraint1(String constraint1)

Sets the constraint on profile option based on the ValueTypeCode set.

• If ValueTypeCode is "LOOKUP", Constraint1 can contain any active concept lists with LOOKUPS_GROUP set to "LOOKUPS".

Parameters:

constraint1 - Constraint on profile option.

getConstraint1

String getConstraint1()

Gets the first constraint on profile option.

Returns:

First constraint on profile option.

See Also:

setConstraint1(java.lang.String)