Skip navigation links

oracle.iam.configservice.vo
Class AttributeDefinition

java.lang.Object
oracle.iam.configservice.vo.AttributeDefinition

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable

public class AttributeDefinition

extends java.lang.Object

implements java.io.Serializable, java.lang.Comparable, java.lang.Cloneable

This class represents an attribute definition in the entity xml. The definition contains the front end attribute properties and backend attribute details. This class along with the CategoryDefinition can be used to render the UI.

See Also:

Serialized Form

Constructor Summary

AttributeDefinition(java.lang.String name)
Creates a new AttributeDefinition object with the specified name

Method Summary

java.lang.Object	clone()
int	compareTo(java.lang.Object ob1) Get the sorted list of advanced search attributes list for advanced search operation of user
java.lang.String	getBackendName() Get the name of the attribute in the backend.
java.lang.String	getBackendType() Get the backend schema data type of the attribute.
java.lang.String	getCategory() Get the category of the attribute.
java.lang.Object	getDefaultValue() Get the default value of the attribute.
java.lang.String	getDescription() Get the description of the attribute.
java.lang.String	getDisplayName() Get the display name of the attribute, that is, the name displayed on the UI.
java.lang.String	getDisplayName(java.util.ResourceBundle bundle) Get the display name of the attribute, that is, the name displayed on the UI, getting the translation from the passed bundle
java.lang.String	getDisplayType() Get the data type of the attribute for the UI.
java.lang.String	getEncryption() Get the encryption to use for the attribute - clear/encrypt.
java.lang.String	getLookupCode() Get the lookupCode for this attributes list of possible values
java.lang.String	getLookupQuery() Get the lookupQuery for this attribute
java.lang.String	getLookupQueryDisplayColumn() Get the lookup Query display Column for this attribute
java.lang.String	getLookupQuerySaveColumn() Get the lookup Query save Column for this attribute
java.lang.Integer	getMaxSize() Get the max size possible for the attribute value.
java.lang.String	getName() Get the attribute name.
java.util.Map	getPossibleValues() Get the list of possible values that this attribute can take - used if its an LOV.
java.lang.String	getType() Get the front end data type of the attribute.
boolean	isBackendRequired() Check if the attribute if required.
boolean	isBulkUpdatable() Checks if the attribute can be modified in bulk.
boolean	isCustomAttribute() Check if the attribute is custom attribute or OOTB.
boolean	isMLS() Returns if the attribute has multi-lingual support
boolean	isMultiRepresented() Returns true if the attribute has multi-represented support, false otherwise
boolean	isMultiValued() Checks if the attribute is single-valued or multi-valued.
boolean	isReadOnly() Checks if the attribute is read-only.
boolean	isRequired() Check if the attribute if required.
boolean	isSearchable() Check if the attribute is searchable.
boolean	isSystemControlled() Checks if the value can be only set by system.
boolean	isUserSearchable() Check if the attribute is searchable by the user.
boolean	isVisible() Returns the visibility of the attribute
void	setBackendName(java.lang.String backendName) Set the name to be used while creating the attribute in the backend.
void	setBackendRequired(boolean required) Set the attribute as a required attribute in the backend.
void	setBackendType(java.lang.String type) Set the data type of the attribute.
void	setBulkUpdatable(boolean bulkUpdatable) Set whether the attribute is bulk modifiable or not.
void	setCategory(java.lang.String category) Set the category to which the attribute belongs.
void	setCustomAttribute(boolean custom) Set true if this is a custom attribute, false for OOTB.
void	setDefaultValue(java.lang.Object defaultValue) Set the default value for the attribute
void	setDescription(java.lang.String desc) Set the description of the attribute.
void	setDisplayType(java.lang.String type) Set the data type of the attribute for the UI.
void	setEncryption(Constants.Encryption encryption) Set the encryption to use for the attribute.
void	setLookupCode(java.lang.String m_lookupCode) Set the lookupCode for this attributes list of possible values
void	setLookupQuery(java.lang.String query) Set the lookupQuery for this attribute
void	setLookupQueryDisplayColumn(java.lang.String queryDisplayColumn) Set the lookup Query Display Column for this attribute
void	setLookupQuerySaveColumn(java.lang.String querySaveColumn) Set the lookup Query save column for this attribute
void	setMaxSize(java.lang.Integer size) Set the max size possible for the attribute value.
void	setMLS(boolean multilingual) Sets m_MLS value
void	setMultiRepresented(boolean multiRepresented) Sets if the attribute has multi-represented support
void	setMultiValued(boolean multiValued) Set the attribute as multi-valued attribute.
void	setPossibleValues(java.lang.String code, java.util.Map values) Set the list of possible values this attribute value can take from.
void	setReadOnly(boolean readOnly) Set whether the attribute is read-only.
void	setRequired(boolean required) Set the attribute as a required attribute.
void	setSearchable(boolean searchable) Set the attribute to be searchable.
void	setSystemControlled(boolean systemControlled) Set the attribute as system controlled, that is, the value can only be set and controlled by the system.
void	setType(java.lang.String type) Set the data type of the attribute.
void	setUserSearchable(boolean searchable) Set the attribute to be searchable by the user.
void	setVisible(boolean visible) Sets visibliity for this attribute
java.lang.String	toString() Get the string representation of the attribute

Methods inherited from class java.lang.Object

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

Constructor Detail

AttributeDefinition

public AttributeDefinition(java.lang.String name)

Creates a new AttributeDefinition object with the specified name

Parameters:

name - the frontend name of the attribute definition being created

Method Detail

getName

public java.lang.String getName()

Get the attribute name.

Returns:

attribute name

getDisplayName

public java.lang.String getDisplayName()

Get the display name of the attribute, that is, the name displayed on the UI. If the display name is not set, it will return the attribute name

Returns:

display name of the attribute, that is, the name displayed on the UI, or the attribute name, if the display name isn't set.

getDisplayName

public java.lang.String getDisplayName(java.util.ResourceBundle bundle)

Get the display name of the attribute, that is, the name displayed on the UI, getting the translation from the passed bundle

Parameters:

bundle - the resource bundle which contains the translation for the attribute name. If none is found, the attribute name itself is returned

Returns:

display name of the attribute, that is, the name displayed on the UI

getBackendName

public java.lang.String getBackendName()

Get the name of the attribute in the backend.

Returns:

the backend name of the attribute

setBackendName

public void setBackendName(java.lang.String backendName)

Set the name to be used while creating the attribute in the backend. This can not be edited for existing attribute.

Parameters:

backendName - name of the attribute as created in the backend

getType

public java.lang.String getType()

Get the front end data type of the attribute.

Returns:

front end data type of the attribute Value is one of { "string", "number", "double", "date" }

setType

public void setType(java.lang.String type)

Set the data type of the attribute.

Parameters:

type - data type of the attribute Valid data types are { "string", "number", "double", "date" }

getBackendType

public java.lang.String getBackendType()

Get the backend schema data type of the attribute.

Returns:

backend schema data type of the attribute Value is one of { "string", "number", "double", "date" }

setBackendType

public void setBackendType(java.lang.String type)

Set the data type of the attribute.

Parameters:

type - data type of the attribute Valid data types are { "string", "number", "double", "date" }

getDisplayType

public java.lang.String getDisplayType()

Get the data type of the attribute for the UI.

Returns:

data type of the attribute for the UI. Value returned is one of { TEXT, NUMBER, DOUBLE, TEXTAREA, BOOLEAN, DATE_ONLY, SECRET, TIME_ZONE, LOV }

setDisplayType

public void setDisplayType(java.lang.String type)

Set the data type of the attribute for the UI.

Parameters:

type - data type of the attribute for the UI Valid data types are { TEXT, NUMBER, DOUBLE, TEXTAREA, BOOLEAN, DATE_ONLY, SECRET, TIME_ZONE, LOV }

getDescription

public java.lang.String getDescription()

Get the description of the attribute.

Returns:

description of the attribute

setDescription

public void setDescription(java.lang.String desc)

Set the description of the attribute.

Parameters:

desc - description of the attribute

isRequired

public boolean isRequired()

Check if the attribute if required.

Returns:

true if the attribute is required, false otherwise

setRequired

public void setRequired(boolean required)

Set the attribute as a required attribute.

Parameters:

required - true if the attribute is required, false otherwise

isBackendRequired

public boolean isBackendRequired()

Check if the attribute if required.

Returns:

true if the attribute is required, false otherwise

setBackendRequired

public void setBackendRequired(boolean required)

Set the attribute as a required attribute in the backend.

Parameters:

required - true if the attribute is required in the backend, false otherwise

isSearchable

public boolean isSearchable()

Check if the attribute is searchable.

Returns:

true if the attribute is searchable, false otherwise

setSearchable

public void setSearchable(boolean searchable)

Set the attribute to be searchable.

Parameters:

searchable - true if the attribute is searchable, false otherwise

isUserSearchable

public boolean isUserSearchable()

Check if the attribute is searchable by the user.

Returns:

true if the attribute is searchable by the user, false otherwise

setUserSearchable

public void setUserSearchable(boolean searchable)

Set the attribute to be searchable by the user.

Parameters:

searchable - true if the attribute is searchable by the user, false otherwise

getDefaultValue

public java.lang.Object getDefaultValue()

Get the default value of the attribute.

Returns:

default value of the attribute

setDefaultValue

public void setDefaultValue(java.lang.Object defaultValue)

Set the default value for the attribute

Parameters:

defaultValue - default value for the attribute

getCategory

public java.lang.String getCategory()

Get the category of the attribute.

Returns:

category of the attribute

setCategory

public void setCategory(java.lang.String category)

Set the category to which the attribute belongs.

Parameters:

category - the attribute's category

isBulkUpdatable

public boolean isBulkUpdatable()

Checks if the attribute can be modified in bulk.

Returns:

true if the attribute can be modified in bulk, false otherwise

setBulkUpdatable

public void setBulkUpdatable(boolean bulkUpdatable)

Set whether the attribute is bulk modifiable or not.

Parameters:

bulkUpdatable - true if the attribute is bulk-modifiable, false otherwise

isReadOnly

public boolean isReadOnly()

Checks if the attribute is read-only.

Returns:

true if the attribute is read-only, false otherwise

setReadOnly

public void setReadOnly(boolean readOnly)

Set whether the attribute is read-only.

Parameters:

readOnly - true if the attribute is unmodifiable, false otherwise

isMultiValued

public boolean isMultiValued()

Checks if the attribute is single-valued or multi-valued.

Returns:

true if the attribute is multi-valued, false otherwise.

setMultiValued

public void setMultiValued(boolean multiValued)

Set the attribute as multi-valued attribute.

Parameters:

multiValued - true if the attribute is multi-valued, false otherwise

isSystemControlled

public boolean isSystemControlled()

Checks if the value can be only set by system.

Returns:

true if the attribute is system controlled, false otherwise

setSystemControlled

public void setSystemControlled(boolean systemControlled)

Set the attribute as system controlled, that is, the value can only be set and controlled by the system.

Parameters:

systemControlled - true if the value should only be set and controlled by the system.

getEncryption

public java.lang.String getEncryption()

Get the encryption to use for the attribute - clear/encrypt.

Returns:

encryption to use for the attribute - clear/encrypt

setEncryption

public void setEncryption(Constants.Encryption encryption)

Set the encryption to use for the attribute.

Parameters:

encryption - an enum for which encryption to use - clear or encrypt (reversible encryption)

getMaxSize

public java.lang.Integer getMaxSize()

Get the max size possible for the attribute value.

Returns:

max size possible for the attribute value

setMaxSize

public void setMaxSize(java.lang.Integer size)

Set the max size possible for the attribute value.

Parameters:

size - max size possible for the attribute value

getPossibleValues

public java.util.Map getPossibleValues()

Get the list of possible values that this attribute can take - used if its an LOV.

Returns:

list of possible values that this attribute can take

getLookupCode

public java.lang.String getLookupCode()

Get the lookupCode for this attributes list of possible values

Returns:

lookupCode for this attributes list of possible values

setLookupCode

public void setLookupCode(java.lang.String m_lookupCode)

Set the lookupCode for this attributes list of possible values

setPossibleValues

public void setPossibleValues(java.lang.String code,
                              java.util.Map values)

Set the list of possible values this attribute value can take from.

Parameters:

code - is the List Of Values code to represent the values

values - values containing encoded and decoded (descriptive) values

getLookupQuery

public java.lang.String getLookupQuery()

Get the lookupQuery for this attribute

Returns:

lookupQuery for this attribute

setLookupQuery

public void setLookupQuery(java.lang.String query)

Set the lookupQuery for this attribute

getLookupQueryDisplayColumn

public java.lang.String getLookupQueryDisplayColumn()

Get the lookup Query display Column for this attribute

Returns:

lookup Query Display Column for this attribute

setLookupQueryDisplayColumn

public void setLookupQueryDisplayColumn(java.lang.String queryDisplayColumn)

Set the lookup Query Display Column for this attribute

getLookupQuerySaveColumn

public java.lang.String getLookupQuerySaveColumn()

Get the lookup Query save Column for this attribute

Returns:

lookup Query save Column for this attribute

setLookupQuerySaveColumn

public void setLookupQuerySaveColumn(java.lang.String querySaveColumn)

Set the lookup Query save column for this attribute

isCustomAttribute

public boolean isCustomAttribute()

Check if the attribute is custom attribute or OOTB.

Returns:

true if the user has defined this attribute, false if its OOTB

setCustomAttribute

public void setCustomAttribute(boolean custom)

Set true if this is a custom attribute, false for OOTB.

Parameters:

custom - true for user defined fields, false for OOTB attribute

isMLS

public boolean isMLS()

Returns if the attribute has multi-lingual support

Returns:

true if has multilingual support else false

setMLS

public void setMLS(boolean multilingual)

Sets m_MLS value

Parameters:

multilingual -

isVisible

public boolean isVisible()

Returns the visibility of the attribute

Returns:

true if this attribute should be visible

setVisible

public void setVisible(boolean visible)

Sets visibliity for this attribute

Parameters:

visible -

toString

public java.lang.String toString()

Get the string representation of the attribute

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(java.lang.Object ob1)

Get the sorted list of advanced search attributes list for advanced search operation of user

Specified by:

compareTo in interface java.lang.Comparable

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

isMultiRepresented

public boolean isMultiRepresented()

Returns true if the attribute has multi-represented support, false otherwise

Returns:

true if has multirepresented support else false

setMultiRepresented

public void setMultiRepresented(boolean multiRepresented)

Sets if the attribute has multi-represented support

Skip navigation links