|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.iam.configservice.vo.AttributeDefinition
public class AttributeDefinition
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.
Constructor Summary | |
---|---|
AttributeDefinition() Creates a new null value AttributeDefinition Object |
|
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 |
getEntityType() |
java.lang.String |
getLdapName() Gets the backend ldap-attribute name, if ldap-sync is enabled |
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.util.Set |
getSummaryAttrs() |
java.lang.String |
getSummaryAttrsStr() |
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 |
setDefaultValue(java.lang.String defaultValue) Set the default value for the attribute with String Parameter |
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 |
setEncryption(java.lang.String encryption) Set the encryption to use for the attribute. |
void |
setEntityType(java.lang.String etype) |
void |
setLdapName(java.lang.String m_ldapName) Sets the backend ldap-attribute name if ldap-sync is enabled. |
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 |
setName(java.lang.String name) Set the attribute name. |
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 |
setSummaryAttrs(java.util.Set attrs) |
void |
setSummaryAttrs(java.lang.String attrStr) |
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 |
---|
public AttributeDefinition()
public AttributeDefinition(java.lang.String name)
name
- the frontend name of the attribute definition being createdMethod Detail |
---|
public void setName(java.lang.String name)
public java.lang.String getName()
public java.lang.String getDisplayName()
public java.lang.String getDisplayName(java.util.ResourceBundle bundle)
bundle
- the resource bundle which contains the translation for the attribute name. If none is found, the attribute name itself is returnedpublic java.lang.String getBackendName()
public void setBackendName(java.lang.String backendName)
backendName
- name of the attribute as created in the backendpublic java.lang.String getType()
public void setType(java.lang.String type)
type
- data type of the attribute Valid data types are { "string", "number", "double", "date" }public java.lang.String getBackendType()
public void setBackendType(java.lang.String type)
type
- data type of the attribute Valid data types are { "string", "number", "double", "date" }public java.lang.String getDisplayType()
public void setDisplayType(java.lang.String type)
type
- data type of the attribute for the UI Valid data types are { TEXT, NUMBER, DOUBLE, TEXTAREA, BOOLEAN, DATE_ONLY, SECRET, TIME_ZONE, LOV }public void setEntityType(java.lang.String etype)
public java.lang.String getEntityType()
public void setSummaryAttrs(java.lang.String attrStr)
public void setSummaryAttrs(java.util.Set attrs)
public java.util.Set getSummaryAttrs()
public java.lang.String getSummaryAttrsStr()
public java.lang.String getDescription()
public void setDescription(java.lang.String desc)
desc
- description of the attributepublic boolean isRequired()
public void setRequired(boolean required)
required
- true if the attribute is required, false otherwisepublic boolean isBackendRequired()
public void setBackendRequired(boolean required)
required
- true if the attribute is required in the backend, false otherwisepublic boolean isSearchable()
public void setSearchable(boolean searchable)
searchable
- true if the attribute is searchable, false otherwisepublic boolean isUserSearchable()
public void setUserSearchable(boolean searchable)
searchable
- true if the attribute is searchable by the user, false otherwisepublic java.lang.Object getDefaultValue()
public void setDefaultValue(java.lang.Object defaultValue)
defaultValue
- default value for the attributepublic void setDefaultValue(java.lang.String defaultValue)
defaultValue
- default value for the attributepublic java.lang.String getCategory()
public void setCategory(java.lang.String category)
category
- the attribute's categorypublic boolean isBulkUpdatable()
public void setBulkUpdatable(boolean bulkUpdatable)
bulkUpdatable
- true if the attribute is bulk-modifiable, false otherwisepublic boolean isReadOnly()
public void setReadOnly(boolean readOnly)
readOnly
- true if the attribute is unmodifiable, false otherwisepublic boolean isMultiValued()
public void setMultiValued(boolean multiValued)
multiValued
- true if the attribute is multi-valued, false otherwisepublic boolean isSystemControlled()
public void setSystemControlled(boolean systemControlled)
systemControlled
- true if the value should only be set and controlled by the system.public java.lang.String getEncryption()
public void setEncryption(java.lang.String encryption)
encryption
- an enum for which encryption to use - clear or encrypt (reversible encryption)public void setEncryption(Constants.Encryption encryption)
encryption
- an enum for which encryption to use - clear or encrypt (reversible encryption)public java.lang.Integer getMaxSize()
public void setMaxSize(java.lang.Integer size)
size
- max size possible for the attribute valuepublic java.util.Map getPossibleValues()
public java.lang.String getLookupCode()
public void setLookupCode(java.lang.String m_lookupCode)
public void setPossibleValues(java.lang.String code, java.util.Map values)
code
- is the List Of Values code to represent the valuesvalues
- values containing encoded and decoded (descriptive) valuespublic java.lang.String getLookupQuery()
public void setLookupQuery(java.lang.String query)
public java.lang.String getLookupQueryDisplayColumn()
public void setLookupQueryDisplayColumn(java.lang.String queryDisplayColumn)
public java.lang.String getLookupQuerySaveColumn()
public void setLookupQuerySaveColumn(java.lang.String querySaveColumn)
public boolean isCustomAttribute()
public void setCustomAttribute(boolean custom)
custom
- true for user defined fields, false for OOTB attributepublic boolean isMLS()
public void setMLS(boolean multilingual)
multilingual
-public boolean isVisible()
public void setVisible(boolean visible)
visible
-public java.lang.String toString()
toString
in class java.lang.Object
public int compareTo(java.lang.Object ob1)
compareTo
in interface java.lang.Comparable
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone
in class java.lang.Object
java.lang.CloneNotSupportedException
public boolean isMultiRepresented()
public void setMultiRepresented(boolean multiRepresented)
public void setLdapName(java.lang.String m_ldapName)
m_ldapName
-public java.lang.String getLdapName()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |