oracle.ifs.beans

Class Attribute

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.SchemaObject

oracle.ifs.beans.TieSchemaObject

oracle.ifs.beans.Attribute

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, SchemaObjectInterface, Traceable

public class Attribute
extends TieSchemaObject

An Attribute describes an atomic unit of data in a ClassObject instance.

Each Attribute is defined by exactly one ClassObject. A ClassObject may define one or more Attributes. Subclasses will inherit all attributes from its super class. This object describes an Attribute of a ClassObject. This object is not used for manipulating the attributes of instances of ClassObjects, but rather the ClassObject itself.

Version:

1.0

Author:

David Pitfield

(Published)

Field Summary

Fields

Modifier and Type	Field and Description
static int	ATTRIBUTEDATATYPE_BOOLEAN The data type of boolean attributes.
static int	ATTRIBUTEDATATYPE_BOOLEAN_ARRAY The data type of array-type boolean attributes.
static int	ATTRIBUTEDATATYPE_DATE The data type of date attributes.
static int	ATTRIBUTEDATATYPE_DATE_ARRAY The data type of array-type date attributes.
static int	ATTRIBUTEDATATYPE_DIRECTORYOBJECT The data type of DirectoryObject attributes.
static int	ATTRIBUTEDATATYPE_DIRECTORYOBJECT_ARRAY The data type of array-type DirectoryObject attributes.
static int	ATTRIBUTEDATATYPE_DOUBLE The data type of double attributes.
static int	ATTRIBUTEDATATYPE_DOUBLE_ARRAY The data type of array-type double attributes.
static int	ATTRIBUTEDATATYPE_INTEGER The data type of integer attributes.
static int	ATTRIBUTEDATATYPE_INTEGER_ARRAY The data type of array-type integer attributes.
static int	ATTRIBUTEDATATYPE_LONG The data type of long attributes.
static int	ATTRIBUTEDATATYPE_LONG_ARRAY The data type of array-type long attributes.
static int	ATTRIBUTEDATATYPE_LONGDOUBLE_MAP The data type of Long-Double Map attributes.
static int	ATTRIBUTEDATATYPE_LONGLO_MAP The data type of Long-LibraryObject Map attributes.
static int	ATTRIBUTEDATATYPE_LONGLONG_MAP The data type of Long-Long Map attributes.
static int	ATTRIBUTEDATATYPE_LONGSTRING_MAP The data type of Long-String Map attributes.
static int	ATTRIBUTEDATATYPE_OBJECTREFERENCE The data type of Serializable Object reference attributes.
static int	ATTRIBUTEDATATYPE_PUBLICOBJECT The data type of PublicObject attributes.
static int	ATTRIBUTEDATATYPE_PUBLICOBJECT_ARRAY The data type of array-type PublicObject attributes.
static int	ATTRIBUTEDATATYPE_SCHEMAOBJECT The data type of SchemaObject attributes.
static int	ATTRIBUTEDATATYPE_SCHEMAOBJECT_ARRAY The data type of array-type SchemaObject attributes.
static int	ATTRIBUTEDATATYPE_SIMPLEOBJECT The data type of SimpleObject attributes.
static int	ATTRIBUTEDATATYPE_SIMPLEOBJECT_ARRAY The data type of array-type SimpleObject attributes.
static int	ATTRIBUTEDATATYPE_STRING The data type of string attributes.
static int	ATTRIBUTEDATATYPE_STRING_ARRAY The data type of array-type string attributes.
static int	ATTRIBUTEDATATYPE_STRINGDOUBLE_MAP The data type of String-Double Map attributes.
static int	ATTRIBUTEDATATYPE_STRINGLO_MAP The data type of String-LibraryObject Map attributes.
static int	ATTRIBUTEDATATYPE_STRINGLONG_MAP The data type of String-Long Map attributes.
static int	ATTRIBUTEDATATYPE_STRINGSTRING_MAP The data type of String-String Map attributes.
static int	ATTRIBUTEDATATYPE_SYSTEMOBJECT The data type of SystemObject attributes.
static int	ATTRIBUTEDATATYPE_SYSTEMOBJECT_ARRAY The data type of array-type SystemObject attributes.
static int	ATTRIBUTEDATATYPE_UNKNOWN An unknown data type.
static String	CLASS_ATTRIBUTE The Class to which this Attribute belongs.
static String	CLASS_CLASSNAME_OPTION The Classname of the Class to which this Attribute belongs.
static String	CLASS_NAME The name of the Attribute.
static String	CLASSDOMAIN_ATTRIBUTE The ClassDomain applied to this object-type Attribute to restrict the objects to which it refers by their ClassObject.
static String	DATABASEOBJECTNAME_ATTRIBUTE The name of the column for this Attribute in the database table for the ClassObject.
static String	DATALENGTH_ATTRIBUTE The maximum size of this Attribute.
static String	DATASCALE_ATTRIBUTE The Datascale attribute is reserved for future use.
static String	DATATYPE_ATTRIBUTE The datatype of this Attribute- either scalar or array of integer, long, double, string, boolean, date, DirectoryObject, PublicObject, SchemaObject, SystemObject, or SimpleObject.
static String	DBMS_HIDDENCOLUMN_PREFIX Prefix used for hidden database columns.
static String	DESCRIPTION_ATTRIBUTE A textual description of the Attribute.
static String	INDEXED_ATTRIBUTE An indicator of whether the database table that stores data for instances of the ClassObject has an index on this Attribute.
static String	REFERENTIALINTEGRITYRULE_ATTRIBUTE The referential integrity behavior (clear, restrict) of this Attribute.
static String	REQUIRED_ATTRIBUTE An indicator of whether each instance of the ClassObject must have a value for this Attribute.
static int	RIRULE_BEANEXTENSIONS Represents the "BEANEXTENSIONS" referential integrity rule.
static int	RIRULE_CLEAR Represents the "CLEAR" referential integrity rule.
static int	RIRULE_RESTRICT Represents the "RESTRICT" referential integrity rule.
static String	SETTABLE_ATTRIBUTE An indicator of whether this Attribute can be set using the repository SDK when creating new instances of the ClassObject.
static String	UNIQUE_ATTRIBUTE An indicator of whether each instance of the ClassObject must have a unique value for this Attribute (if not null).
static String	UPDATEABLE_ATTRIBUTE An indicator of whether this Attribute can be updated using the repository SDK for existing instances of the ClassObject.
static String	VALUEDEFAULT_ATTRIBUTE The default value of this Attribute in new instances of the ClassObject.
static String	VALUEDOMAIN_ATTRIBUTE The ValueDomain applied to this Attribute to restrict its values to a list of pre-specified allowed values for instances of the ClassObject.
static String	VALUEDOMAINVALIDATED_ATTRIBUTE An indicator of whether the ValueDomain is enforced or merely a guideline.

Fields inherited from class oracle.ifs.beans.SchemaObject

ACTIVE_ATTRIBUTE, NAME_ATTRIBUTE, POLICYBUNDLE_ATTRIBUTE, POLICYLISTS_ATTRIBUTE, PROPERTYBUNDLE_ATTRIBUTE

Fields inherited from class oracle.ifs.beans.LibraryObject

DOMAIN_UNIQUENAME_DEFAULT_DELIMITER, m_ClassId, m_Id, m_Session

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Attribute(LibrarySession session, Long id, Long classId, S_AttributeData data) Internal use only: Constructs an Attribute.
protected	Attribute(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) Internal use only: Constructs an Attribute.

Method Summary

Modifier and Type	Method and Description
static String	attributeDataTypeArrayPrefix(int attributeDataType) Gets the character prefix to use in generating the custom array table for the specified data type.
static String	attributeDataTypeArrayTypeDatabaseObjectName(int attributeDataType) Gets the default database object name for the attribute array tables for the specified array attribute data type.
static String	attributeDataTypeBaseClassName(int dataType) Gets the common name of the base Class representing the data type specified.
static int	attributeDataTypeDefaultDataLength(int attributeDataType) Gets the default data length of the specified Attribute data type.
static int	attributeDataTypeDefaultDataScale(int attributeDataType) Gets the default data scale of the specified Attribute data type.
static boolean	attributeDataTypeIsArrayType(int attributeDataType) Gets whether the specified Attribute data type is an array type.
static boolean	attributeDataTypeIsMapType(int attributeDataType) Gets whether the specified Attribute data type is a map type.
static boolean	attributeDataTypeIsObjectType(int attributeDataType) Gets whether the specified Attribute data type is an object type.
static int	attributeDataTypeJdbcType(int attributeDataType) Gets the JDBC type for the specified Attribute data type.
static String	attributeDataTypeLabel(int attributeDataType) Gets the generic String representation (label) for the specified Attribute data type.
static String	attributeDataTypeLabel(int attributeDataType, int dataLength) Gets the generic String representation (label) for the specified Attribute data type.
static String	attributeDataTypeLabel(int attributeDataType, int dataLength, int dataScale) Gets the generic String representation (label) for the specified Attribute data type.
static String	attributeDataTypeMapTypeDatabaseObjectName(int attributeDataType) Gets the default database object name for the attribute map tables for the specified map attribute data type.
static String	attributeDataTypeRdbmsType(int attributeDataType) Gets the RDBMS type for the specified Attribute data type.
static String	attributeDataTypeRdbmsType(int attributeDataType, int dataLength) Gets the RDBMS type for the specified Attribute data type.
static String	attributeDataTypeRdbmsType(int attributeDataType, int dataLength, int dataScale) Gets the RDBMS type for the specified Attribute data type.
static String	attributeDataTypeRdbmsTypeOracle(int attributeDataType, int dataLength, int dataScale) Gets the RDBMS type for the specified Attribute data type, for Oracle database.
static String	attributeDataTypeRdbmsTypePostgres(int attributeDataType, int dataLength, int dataScale) Gets the RDBMS type for the specified Attribute data type, for Oracle database.
static String	attributeDataTypeResourceBundleKey(int attributeDataType) Deprecated. 9.2.5.0: use toDataTypeLabel
protected static Attribute	constructAttribute(LibrarySession session, S_LibraryObjectData data) Internal use only: Constructs an Attribute for the specified data.
void	free() Permanently removes this Attribute.
ClassDomain	getClassDomain() Gets the ClassDomain of this Attribute.
String	getCommonName() Returns the common Name of the Attribute, preferably in the original mixed case that was used to create it.
String	getDatabaseObjectName() get the database object name corresponding to this attribute.
int	getDataLength() Get the length of the attribute.
int	getDataScale() Get the Data Scale of this Attribute.
int	getDataType() Get the data type of the attribute.
String	getDataTypeLabel() Gets the localized String label for the data type set for this instance.
String	getDefiningClass() Returns the CLASS of which this is an attribute.
ClassObject	getDefiningClassObject() Returns the ClassObject that defines this attribute.
String	getDefinitionSettingPolicy() Returns the policy in effect for applying a definition setting for the Attribute.
String	getDescription() Returns the description of an Attribute.
int	getEffectiveDatalength() Gets the effective data length for the Attribute.
String	getLabel() returns the Label for this Attribute, based on the Attribute's name and class.
static String	getMultiValueTableCreateString(int dataType, int dataLength, int dataScale, String tableName) Gets the CREATE TABLE string for multi-value tables for the specified type and specified table name.
String	getMultiValueTableName() Gets the table name to use for storing multi-valued attribute values (maps or arrays).
static String	getMultiValueTableName(int dataType, String suffix) Gets the table name to use for storing multi-valued attribute values (maps or arrays), based on the specified data type and optional custom suffix.
String	getMultiValueTableSuffix() Returns the custom table suffix used to derive the table for the map or array values used for this Attribute.
int	getReferentialIntegrityRule() Gets the Referential Integrity Rule associated with this Attribute.
String	getReferentialIntegrityRuleLabel() Gets the localized String label for the ReferentialIntegrityRule set for this instance.
ValueDefault	getValueDefault() Gets the ValueDefault of this Attribute.
ValueDomain	getValueDomain() Gets the ValueDomain of this Attribute.
boolean	isIndexed() Determine if the current attribute is indexed.
static boolean	isLegalDataType(int attributeDataType) Gets whether the specified Attribute data type is legal.
boolean	isRequired() Determine if the current attribute is required.
boolean	isSettable() Determine if the current attribute is Settable.
boolean	isStandardSimplePropertyArray() Returns identication as to whether the Attribute should implement "standard" semantics for a SimpleProperty array.
boolean	isUnique() Determine if the current attribute is unique.
boolean	isUpdateable() Determine if the current attribute is Updateable.
boolean	isValueDomainValidated() Determines if the attribute's value domain has been validated.
void	setClassDomain(ClassDomain cd) Sets the ClassDomain of this Attribute.
void	setDescription(String description) Sets the description of this Attribute.
void	setReferentialIntegrityRule(int rule) Sets the referential Integrity rule associated with this Attribute.
void	setValueDefault(ValueDefault vde) Sets the ValueDefault of this Attribute.
void	setValueDomain(ValueDomain vd) Sets the ValueDomain of this Attribute.
void	setValueDomainValidated(boolean value) Marks the attribute as ValueDomainValidated.
static int	toDataType(String stype) Gets the integer data type value for the specified data type label.
static String	toDataTypeLabel(int dataType) Converts the specified data type constant to a localized label.
static String	toDataTypeLabel(int dataType, LibrarySession session) Converts the specified data type constant to a localized label, using the Localizer from the specified LibrarySession.
static String	toDataTypeLabel(int dataType, Localizer localizer) Converts the specified data type constant to a localized label, using the specified Localizer.
static int	toReferentialIntegrityRule(String label) Gets the integer referential integrity rule value for the specified referential integrity rule label.
static String	toReferentialIntegrityRuleLabel(int riRule) Converts the specified ReferentialIntegrityRule constant to a localized label.
static String	toReferentialIntegrityRuleLabel(int riRule, LibrarySession session) Converts the specified ReferentialIntegrityRule constant to a localized label, using the Localizer from the specified LibrarySession.
static String	toReferentialIntegrityRuleLabel(int riRule, Localizer localizer) Converts the specified ReferentialIntegrityRule constant to a localized label, using the specified Localizer.

Methods inherited from class oracle.ifs.beans.SchemaObject

addCategory, constructSchemaObject, constructSchemaObjectVector, free, getCategories, getCategories, getCategories, getCategories, getPolicyBundle, getPolicyLists, handleCreate, hasNameAttribute, hasPropertyBundleAttribute, isActive, postCreate, postUpdate, putPolicy, removeAllPolicies, removePolicy, removePolicy, setActive, setPolicyBundle, setPolicyLists

Methods inherited from class oracle.ifs.beans.LibraryObject

added, addSimpleProperty, addSimpleProperty, applyProperties, auditCreated, auditUpdated, canPurge, checkIfPropertyBundleSupported, checkRequiredAttributeSet, clearCopyContext, clearFreeContext, clearUpdateContext, compareTo, constructIdArray, constructIdArray, constructLibraryObject, constructLibraryObjectVector, createDedicatedPropertyBundle, createInstance, deriveDomainUniqueName, dispose, equals, equals, freeAll, get, getAttribute, getAttributeByUpperCaseName, getAttributes, getAttributesByUpperCaseNames, getAuditDomainContext, getAuditEventFolderContext, getClassId, getClassname, getClassName, getClassObject, getCommonNameAndClass, getCopyContext, getCreateContext, getData, getDefinition, getDefinitionForSimplePropertyUpdates, getEffectivePolicyListElements, getEventualAttributeByUpperCaseName, getFreeContext, getId, getName, getObjectReferenceAttribute, getOperationActionSpecificationContext, getPropertyBundle, getPropertyValue, getPublicObjectAttribute, getResourceString, getResourceString, getSchemaObjectAttribute, getSession, getSessionInterface, getSharedStateFactory, getSimpleObjectAttribute, getSimpleProperties, getSimpleProperty, getSimplePropertyValue, getStringIdentifier, getSystemObjectAttribute, getTraceLogger, getUpdateContext, handleAdminModeChange, handleEvent, handleFree, handleUpdate, hashCode, invalidateState, invokeOperation, invokeOperation, invokeServerMethod, isConnected, isCoreEventPostingEnabled, isInstanceOf, isPersistent, isTraced, isValidEventType, lockRows, lookupInstanceLabel, performPostCreateExtensions, performPostFreeExtensions, performPostUpdateExtensions, performPreCreateExtensions, performPreFreeExtensions, performPreUpdateExtensions, postEvent, postEvent, postFree, preCreate, preFree, prePostAuditEvent, preUpdate, putProperty, putProperty, removeAllProperties, removeAllSimpleProperties, removeAllSimpleProperties, removed, removeProperty, removeSimpleProperty, removeSimpleProperty, renderAsRandomAccessContent, renderAsReader, renderAsStream, setAttribute, setAttribute, setAttributes, setAttributes, setCopyContext, setFreeContext, setId, setName, setPropertyBundle, setPropertyValue, setUpdateContext, toString, trace, trustHandleCreate, trustHandleCreateAsAdmin, trustHandleFree, trustHandleFreeAsAdmin, trustHandleUpdate, trustHandleUpdateAsAdmin, update, updateAndExposeDefinition, validatePropertyValues, vectorLibraryObjectElement, vectorToLibraryObjectArray, verifyAdministrationMode, verifyConnected, verifyPersistent, verifySystemUserAccess, verifyTargetObject

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.ifs.common.LibraryObjectInterface

getAttributeByUpperCaseName, getClassId, getId, getSessionInterface

Methods inherited from interface oracle.ifs.common.Traceable

getTraceLogger, isTraced, trace

Field Detail

CLASS_NAME

public static final String CLASS_NAME

The name of the Attribute.

See Also:

Constant Field Values

(Published)

CLASS_CLASSNAME_OPTION

public static final String CLASS_CLASSNAME_OPTION

The Classname of the Class to which this Attribute belongs.

See Also:

Constant Field Values

(Published)

CLASS_ATTRIBUTE

public static final String CLASS_ATTRIBUTE

The Class to which this Attribute belongs.

See Also:

Constant Field Values

(Published)

DESCRIPTION_ATTRIBUTE

public static final String DESCRIPTION_ATTRIBUTE

A textual description of the Attribute.

See Also:

Constant Field Values

(Published)

DATATYPE_ATTRIBUTE

public static final String DATATYPE_ATTRIBUTE

The datatype of this Attribute- either scalar or array of integer, long, double, string, boolean, date, DirectoryObject, PublicObject, SchemaObject, SystemObject, or SimpleObject.

See Also:

Constant Field Values

(Published)

DATALENGTH_ATTRIBUTE

public static final String DATALENGTH_ATTRIBUTE

The maximum size of this Attribute. For String attributes, this is the maximum string length in bytes. The Datalength attribute is ignored for non-String Attributes.

See Also:

Constant Field Values

(Published)

DATASCALE_ATTRIBUTE

public static final String DATASCALE_ATTRIBUTE

The Datascale attribute is reserved for future use.

See Also:

Constant Field Values

(Published)

UNIQUE_ATTRIBUTE

public static final String UNIQUE_ATTRIBUTE

An indicator of whether each instance of the ClassObject must have a unique value for this Attribute (if not null).

See Also:

Constant Field Values

(Published)

REQUIRED_ATTRIBUTE

public static final String REQUIRED_ATTRIBUTE

An indicator of whether each instance of the ClassObject must have a value for this Attribute.

See Also:

Constant Field Values

(Published)

INDEXED_ATTRIBUTE

public static final String INDEXED_ATTRIBUTE

An indicator of whether the database table that stores data for instances of the ClassObject has an index on this Attribute.

See Also:

Constant Field Values

(Published)

SETTABLE_ATTRIBUTE

public static final String SETTABLE_ATTRIBUTE

An indicator of whether this Attribute can be set using the repository SDK when creating new instances of the ClassObject. Non-settable Attributes can only be "system-set" by server extensibility code.

See Also:

Constant Field Values

(Published)

UPDATEABLE_ATTRIBUTE

public static final String UPDATEABLE_ATTRIBUTE

An indicator of whether this Attribute can be updated using the repository SDK for existing instances of the ClassObject. The values of non-updateable Attributes can only be changed by server extensibility code.

See Also:

Constant Field Values

(Published)

DATABASEOBJECTNAME_ATTRIBUTE

public static final String DATABASEOBJECTNAME_ATTRIBUTE

The name of the column for this Attribute in the database table for the ClassObject.

See Also:

Constant Field Values

(Published)

CLASSDOMAIN_ATTRIBUTE

public static final String CLASSDOMAIN_ATTRIBUTE

The ClassDomain applied to this object-type Attribute to restrict the objects to which it refers by their ClassObject. ClassDomain must be null for non object-type Attributes.

See Also:

Constant Field Values

(Published)

VALUEDOMAIN_ATTRIBUTE

public static final String VALUEDOMAIN_ATTRIBUTE

The ValueDomain applied to this Attribute to restrict its values to a list of pre-specified allowed values for instances of the ClassObject.

See Also:

Constant Field Values

(Published)

VALUEDEFAULT_ATTRIBUTE

public static final String VALUEDEFAULT_ATTRIBUTE

The default value of this Attribute in new instances of the ClassObject.

See Also:

Constant Field Values

(Published)

VALUEDOMAINVALIDATED_ATTRIBUTE

public static final String VALUEDOMAINVALIDATED_ATTRIBUTE

An indicator of whether the ValueDomain is enforced or merely a guideline.

See Also:

Constant Field Values

(Published)

REFERENTIALINTEGRITYRULE_ATTRIBUTE

public static final String REFERENTIALINTEGRITYRULE_ATTRIBUTE

The referential integrity behavior (clear, restrict) of this Attribute.

See Also:

Constant Field Values

(Published)

ATTRIBUTEDATATYPE_UNKNOWN

public static final int ATTRIBUTEDATATYPE_UNKNOWN

An unknown data type.

See Also:

Constant Field Values

(Published)

ATTRIBUTEDATATYPE_DATE

public static final int ATTRIBUTEDATATYPE_DATE

The data type of date attributes.

See Also:

Constant Field Values

(Published)

ATTRIBUTEDATATYPE_STRING

public static final int ATTRIBUTEDATATYPE_STRING

The data type of string attributes.

See Also:

Constant Field Values

(Published)

ATTRIBUTEDATATYPE_DOUBLE

public static final int ATTRIBUTEDATATYPE_DOUBLE

The data type of double attributes.

See Also:

Constant Field Values

(Published)

ATTRIBUTEDATATYPE_INTEGER

public static final int ATTRIBUTEDATATYPE_INTEGER

The data type of integer attributes.

See Also:

Constant Field Values

(Published)

ATTRIBUTEDATATYPE_BOOLEAN

public static final int ATTRIBUTEDATATYPE_BOOLEAN

The data type of boolean attributes.

See Also:

Constant Field Values

(Published)

ATTRIBUTEDATATYPE_DIRECTORYOBJECT

public static final int ATTRIBUTEDATATYPE_DIRECTORYOBJECT

The data type of DirectoryObject attributes.

See Also:

Constant Field Values

(Published)

ATTRIBUTEDATATYPE_LONG

public static final int ATTRIBUTEDATATYPE_LONG

The data type of long attributes.

See Also:

Constant Field Values

(Published)

ATTRIBUTEDATATYPE_SCHEMAOBJECT

public static final int ATTRIBUTEDATATYPE_SCHEMAOBJECT

The data type of SchemaObject attributes.

See Also:

Constant Field Values

(Published)

ATTRIBUTEDATATYPE_SYSTEMOBJECT

public static final int ATTRIBUTEDATATYPE_SYSTEMOBJECT

The data type of SystemObject attributes.

See Also:

Constant Field Values

(Published)

ATTRIBUTEDATATYPE_PUBLICOBJECT

public static final int ATTRIBUTEDATATYPE_PUBLICOBJECT

The data type of PublicObject attributes.

See Also:

Constant Field Values

(Published)

ATTRIBUTEDATATYPE_OBJECTREFERENCE

public static final int ATTRIBUTEDATATYPE_OBJECTREFERENCE

The data type of Serializable Object reference attributes.

See Also:

Constant Field Values

(Unpublished)

ATTRIBUTEDATATYPE_SIMPLEOBJECT

public static final int ATTRIBUTEDATATYPE_SIMPLEOBJECT

The data type of SimpleObject attributes.

See Also:

Constant Field Values

(Published)

ATTRIBUTEDATATYPE_DATE_ARRAY

public static final int ATTRIBUTEDATATYPE_DATE_ARRAY

The data type of array-type date attributes.

See Also:

Constant Field Values

(Published)

ATTRIBUTEDATATYPE_STRING_ARRAY

public static final int ATTRIBUTEDATATYPE_STRING_ARRAY

The data type of array-type string attributes.

See Also:

Constant Field Values

(Published)

ATTRIBUTEDATATYPE_DOUBLE_ARRAY

public static final int ATTRIBUTEDATATYPE_DOUBLE_ARRAY

The data type of array-type double attributes.

See Also:

Constant Field Values

(Published)

ATTRIBUTEDATATYPE_INTEGER_ARRAY

public static final int ATTRIBUTEDATATYPE_INTEGER_ARRAY

The data type of array-type integer attributes.

See Also:

Constant Field Values

(Published)

ATTRIBUTEDATATYPE_BOOLEAN_ARRAY

public static final int ATTRIBUTEDATATYPE_BOOLEAN_ARRAY

The data type of array-type boolean attributes.

See Also:

Constant Field Values

(Published)

ATTRIBUTEDATATYPE_DIRECTORYOBJECT_ARRAY

public static final int ATTRIBUTEDATATYPE_DIRECTORYOBJECT_ARRAY

The data type of array-type DirectoryObject attributes.

See Also:

Constant Field Values

(Published)

ATTRIBUTEDATATYPE_LONG_ARRAY

public static final int ATTRIBUTEDATATYPE_LONG_ARRAY

The data type of array-type long attributes.

See Also:

Constant Field Values

(Published)

ATTRIBUTEDATATYPE_SCHEMAOBJECT_ARRAY

public static final int ATTRIBUTEDATATYPE_SCHEMAOBJECT_ARRAY

The data type of array-type SchemaObject attributes.

See Also:

Constant Field Values

(Published)

ATTRIBUTEDATATYPE_SYSTEMOBJECT_ARRAY

public static final int ATTRIBUTEDATATYPE_SYSTEMOBJECT_ARRAY

The data type of array-type SystemObject attributes.

See Also:

Constant Field Values

(Published)

ATTRIBUTEDATATYPE_PUBLICOBJECT_ARRAY

public static final int ATTRIBUTEDATATYPE_PUBLICOBJECT_ARRAY

The data type of array-type PublicObject attributes.

See Also:

Constant Field Values

(Published)

ATTRIBUTEDATATYPE_SIMPLEOBJECT_ARRAY

public static final int ATTRIBUTEDATATYPE_SIMPLEOBJECT_ARRAY

The data type of array-type SimpleObject attributes.

See Also:

Constant Field Values

(Published)

ATTRIBUTEDATATYPE_STRINGSTRING_MAP

public static final int ATTRIBUTEDATATYPE_STRINGSTRING_MAP

The data type of String-String Map attributes.

See Also:

Constant Field Values

(Published)

ATTRIBUTEDATATYPE_STRINGLONG_MAP

public static final int ATTRIBUTEDATATYPE_STRINGLONG_MAP

The data type of String-Long Map attributes.

See Also:

Constant Field Values

(Published)

ATTRIBUTEDATATYPE_LONGSTRING_MAP

public static final int ATTRIBUTEDATATYPE_LONGSTRING_MAP

The data type of Long-String Map attributes.

See Also:

Constant Field Values

(Published)

ATTRIBUTEDATATYPE_LONGLONG_MAP

public static final int ATTRIBUTEDATATYPE_LONGLONG_MAP

The data type of Long-Long Map attributes.

See Also:

Constant Field Values

(Published)

ATTRIBUTEDATATYPE_STRINGDOUBLE_MAP

public static final int ATTRIBUTEDATATYPE_STRINGDOUBLE_MAP

The data type of String-Double Map attributes.

See Also:

Constant Field Values

(Published)

ATTRIBUTEDATATYPE_STRINGLO_MAP

public static final int ATTRIBUTEDATATYPE_STRINGLO_MAP

The data type of String-LibraryObject Map attributes.

See Also:

Constant Field Values

(Published)

ATTRIBUTEDATATYPE_LONGDOUBLE_MAP

public static final int ATTRIBUTEDATATYPE_LONGDOUBLE_MAP

The data type of Long-Double Map attributes.

See Also:

Constant Field Values

(Published)

ATTRIBUTEDATATYPE_LONGLO_MAP

public static final int ATTRIBUTEDATATYPE_LONGLO_MAP

The data type of Long-LibraryObject Map attributes.

See Also:

Constant Field Values

(Published)

RIRULE_CLEAR

public static final int RIRULE_CLEAR

Represents the "CLEAR" referential integrity rule.

If LibraryObject.free is invoked on an object referenced by a CLEAR-type Attribute, the CLEAR-type Attribute's value is set to null and the free is performed.

See Also:

Constant Field Values

(Published)

RIRULE_RESTRICT

public static final int RIRULE_RESTRICT

Represents the "RESTRICT" referential integrity rule.

If LibraryObject.free is invoked on an object referenced by a RESTRICT-type Attribute, the free is not performed and a IfsException is thrown.

See Also:

Constant Field Values

(Published)

RIRULE_BEANEXTENSIONS

public static final int RIRULE_BEANEXTENSIONS

Represents the "BEANEXTENSIONS" referential integrity rule.

If this option is set, custom referential processing will occur using Bean-side class extensions.

See Also:

Constant Field Values

(Published)

DBMS_HIDDENCOLUMN_PREFIX

public static final String DBMS_HIDDENCOLUMN_PREFIX

Prefix used for hidden database columns.

This prefix is prepended to the Attribute's databaseobject name for Attribute types that have hidden columns (e.g. for Date types).

See Also:

Constant Field Values

(Unpublished)

Constructor Detail

Attribute

protected Attribute(LibrarySession session,
                    Long id,
                    Long classId,
                    S_LibraryObjectData data)
             throws IfsException

Internal use only: Constructs an Attribute.

For internal use only. Do not use this method.

Parameters:

session - the session

id - the id

classId - the class id

data - the data

Throws:

IfsException - if the operation fails

(Unpublished)

Attribute

protected Attribute(LibrarySession session,
                    Long id,
                    Long classId,
                    S_AttributeData data)
             throws IfsException

Internal use only: Constructs an Attribute.

For internal use only. Do not use this method.

Parameters:

session - the session

id - the id

classId - the class id

data - the data

Throws:

IfsException - if the operation fails

(Unpublished)

Method Detail

getCommonName

public String getCommonName()
                     throws IfsException

Returns the common Name of the Attribute, preferably in the original mixed case that was used to create it.

Override the default implementation in LibraryObject.

Overrides:

getCommonName in class LibraryObject

Returns:

the common name of this object.

Throws:

IfsException - if operation fails.

(Published)

getMultiValueTableSuffix

public String getMultiValueTableSuffix()
                                throws IfsException

Returns the custom table suffix used to derive the table for the map or array values used for this Attribute.

If a custom value is not defined, this method returns null.

Returns:

the multivalue table name suffix, or null if not defined

Throws:

IfsException - if operation fails.

(Published)

getMultiValueTableName

public String getMultiValueTableName()
                              throws IfsException

Gets the table name to use for storing multi-valued attribute values (maps or arrays).

Returns:

the table name to use for the map or array values

Throws:

IfsException - if the operation fails

(Published)

isStandardSimplePropertyArray

public boolean isStandardSimplePropertyArray()
                                      throws IfsException

Returns identication as to whether the Attribute should implement "standard" semantics for a SimpleProperty array.

Returns:

true if implement SimpleProperty array semantics; false otherwise

Throws:

IfsException - if operation fails.

(Published)

getDefinitionSettingPolicy

public String getDefinitionSettingPolicy()
                                  throws IfsException

Returns the policy in effect for applying a definition setting for the Attribute.

Returns:

the policy name, or null if a policy is not defined

Throws:

IfsException - if operation fails.

(Published)

getEffectiveDatalength

public int getEffectiveDatalength()
                           throws IfsException

Gets the effective data length for the Attribute.

This is typically the same as the value of DATALENGTH attribute, except for String-array attributes, where the effective data length is the default max (1000) if a custom table is not used.

Returns:

the effective data length for the Attribute

Throws:

IfsException - if the operation fails

(Published)

getLabel

public String getLabel()
                throws IfsException

returns the Label for this Attribute, based on the Attribute's name and class. This overrides the method defined in LibraryObject so that the AttributeLabel resource strings can be checked instead of the InstanceLabels that are checked in LibraryObject. If no AttributeLabel is defined, return the Attribute's name.

Overrides:

getLabel in class LibraryObject

Returns:

the label for this object.

Throws:

IfsException - if operation fails.

(Published)

setClassDomain

public void setClassDomain(ClassDomain cd)
                    throws IfsException

Sets the ClassDomain of this Attribute.

Parameters:

cd - the ClassDomain

Throws:

IfsException - if the operation fails

(Published)

getClassDomain

public final ClassDomain getClassDomain()
                                 throws IfsException

Gets the ClassDomain of this Attribute.

Returns:

the ClassDomain

Throws:

IfsException - if the operation fails

(Published)

setValueDomain

public void setValueDomain(ValueDomain vd)
                    throws IfsException

Sets the ValueDomain of this Attribute.

Parameters:

vd - the ValueDomain

Throws:

IfsException - if the operation fails

(Published)

getValueDomain

public final ValueDomain getValueDomain()
                                 throws IfsException

Gets the ValueDomain of this Attribute.

Returns:

the ValueDomain

Throws:

IfsException - if the operation fails

(Published)

setValueDefault

public void setValueDefault(ValueDefault vde)
                     throws IfsException

Sets the ValueDefault of this Attribute.

Parameters:

vde - the ValueDefault

Throws:

IfsException - if the operation fails

(Published)

getValueDefault

public final ValueDefault getValueDefault()
                                   throws IfsException

Gets the ValueDefault of this Attribute.

Returns:

the ValueDefault

Throws:

IfsException - if the operation fails

(Published)

free

public void free()
          throws IfsException

Permanently removes this Attribute.

iFS does not allow Attributes to be removed from a ClassObject, so this method always throws IfsException.

Overrides:

free in class LibraryObject

Throws:

IfsException - upon every invocation

(Published)

getDefiningClassObject

public ClassObject getDefiningClassObject()
                                   throws IfsException

Returns the ClassObject that defines this attribute.

Returns:

the ClassObject that defines this attribute

Throws:

IfsException - if the operation fails

(Published)

getDefiningClass

public String getDefiningClass()
                        throws IfsException

Returns the CLASS of which this is an attribute.

Returns:

Name of the class which defines this attribute.

Throws:

IfsException - if the operation fails

(Published)

getDescription

public String getDescription()
                      throws IfsException

Returns the description of an Attribute.

Returns:

The description of the Attribute.

Throws:

IfsException - if the operation fails

(Published)

setDescription

public void setDescription(String description)
                    throws IfsException

Sets the description of this Attribute.

Parameters:

description - the description

Throws:

IfsException - if the operation fails

(Published)

getDataType

public int getDataType()
                throws IfsException

Get the data type of the attribute.

Returns:

Data type of the attribute.

Throws:

IfsException - if the operation fails.

(Published)

getDataLength

public int getDataLength()
                  throws IfsException

Get the length of the attribute.

Returns:

Length of the field that holds the attribute.

Throws:

IfsException - if the operation fails.

(Published)

getDataScale

public int getDataScale()
                 throws IfsException

Get the Data Scale of this Attribute.

Returns:

DataScale of this Attribute

Throws:

IfsException - if the operation fails

(Published)

isUnique

public boolean isUnique()
                 throws IfsException

Determine if the current attribute is unique. Mostly used for unique names.

Returns:

True if the Current Attribute is Unique.

Throws:

IfsException - if the operation fails.

(Published)

isRequired

public boolean isRequired()
                   throws IfsException

Determine if the current attribute is required.

Returns:

True if the Current Attribute is a Required attribute.

Throws:

IfsException - if the operation fails.

(Published)

isIndexed

public boolean isIndexed()
                  throws IfsException

Determine if the current attribute is indexed.

Returns:

True if the Current Attribute is a indexed attribute.

Throws:

IfsException - if the operation fails.

(Published)

isSettable

public boolean isSettable()
                   throws IfsException

Determine if the current attribute is Settable.

Returns:

True if the Current Attribute is a settable attribute.

Throws:

IfsException - if the operation fails.

(Published)

isUpdateable

public boolean isUpdateable()
                     throws IfsException

Determine if the current attribute is Updateable.

Returns:

True if the Current Attribute is a updateable attribute.

Throws:

IfsException - if the operation fails.

(Published)

getDatabaseObjectName

public String getDatabaseObjectName()
                             throws IfsException

get the database object name corresponding to this attribute.

Returns:

Name of the database object.

Throws:

IfsException - if the operation fails.

(Published)

isValueDomainValidated

public boolean isValueDomainValidated()
                               throws IfsException

Determines if the attribute's value domain has been validated.

Returns:

True if the value domain has been validated.

Throws:

IfsException - if the operation fails.

(Published)

setValueDomainValidated

public void setValueDomainValidated(boolean value)
                             throws IfsException

Marks the attribute as ValueDomainValidated.

Parameters:

value - Boolean true of False.

Throws:

IfsException - if the operation fails.

(Published)

getReferentialIntegrityRule

public int getReferentialIntegrityRule()
                                throws IfsException

Gets the Referential Integrity Rule associated with this Attribute.

Returns:

The Referential Integrity rule.

Throws:

IfsException

(Published)

getReferentialIntegrityRuleLabel

public String getReferentialIntegrityRuleLabel()
                                        throws IfsException

Gets the localized String label for the ReferentialIntegrityRule set for this instance.

Returns:

the label corresponding to the ReferentialIntegrityRule

Throws:

IfsException - if operation fails.

(Published)

toReferentialIntegrityRuleLabel

public static String toReferentialIntegrityRuleLabel(int riRule)
                                              throws IfsException

Converts the specified ReferentialIntegrityRule constant to a localized label. The default Localizer is used.

Parameters:

riRule - the ReferentialIntegrityRule constant.

Returns:

the label corresponding to the specified ReferentialIntegrityRule constant.

Throws:

IfsException - if operation fails.

(Published)

toReferentialIntegrityRuleLabel

public static String toReferentialIntegrityRuleLabel(int riRule,
                                                     LibrarySession session)
                                              throws IfsException

Converts the specified ReferentialIntegrityRule constant to a localized label, using the Localizer from the specified LibrarySession.

Parameters:

riRule - the ReferentialIntegrityRule constant

session - the LibrarySession, whose current Localizer will be used for the conversion

Returns:

the label corresponding to the specified ReferentialIntegrityRule constant

Throws:

IfsException - if operation fails.

(Published)

toReferentialIntegrityRuleLabel

public static String toReferentialIntegrityRuleLabel(int riRule,
                                                     Localizer localizer)
                                              throws IfsException

Converts the specified ReferentialIntegrityRule constant to a localized label, using the specified Localizer. If a null is specified for the Localizer, a temporary Localizer (constructed based on the default Locale) is used for the conversion.

Parameters:

riRule - the ReferentialIntegrityRule constant.

localizer - the Localizer that performs the conversion

Returns:

the label corresponding to the specified ReferentialIntegrityRule constant.

Throws:

IfsException - if operation fails.

(Published)

toReferentialIntegrityRule

public static final int toReferentialIntegrityRule(String label)
                                            throws IfsException

Gets the integer referential integrity rule value for the specified referential integrity rule label.

Parameters:

label - the referential integrity rule label

Returns:

the referential integrity rule value

Throws:

IfsException - if the operation fails

(Published)

setReferentialIntegrityRule

public void setReferentialIntegrityRule(int rule)
                                 throws IfsException

Sets the referential Integrity rule associated with this Attribute. Valid integer parameters are Attribute.RIRULE_CLEAR, Attribute.RIRULE_RESTRICT, and Attribute.RIRULE_BEANEXTENSIONS.

Parameters:

rule - integer representing a valid RI rule from Attribute.

Throws:

IfsException - if the operation fails.

(Published)

constructAttribute

protected static Attribute constructAttribute(LibrarySession session,
                                              S_LibraryObjectData data)
                                       throws IfsException

Internal use only: Constructs an Attribute for the specified data.

For internal use only. Do not use this method.

Parameters:

session - the session

data - the data

Returns:

the Attribute

Throws:

IfsException - if an error occurs

(Unpublished)

attributeDataTypeResourceBundleKey

@Deprecated
public static final String attributeDataTypeResourceBundleKey(int attributeDataType)
                                                                    throws IfsException

Deprecated. 9.2.5.0: use toDataTypeLabel

Gets the resource bundle key for the specified Attribute data type.

Call LibrarySession.getResourceString with the returned value to get a localized name for the specified Attribute data type.

Parameters:

attributeDataType - the Attribute data type

Returns:

the resource bundle key

Throws:

IfsException - if operation fails

(Published)

getDataTypeLabel

public String getDataTypeLabel()
                        throws IfsException

Gets the localized String label for the data type set for this instance.

Returns:

the label corresponding to the AttributeDataType

Throws:

IfsException - if operation fails.

(Published)

toDataTypeLabel

public static String toDataTypeLabel(int dataType)
                              throws IfsException

Converts the specified data type constant to a localized label. The default Localizer is used.

Parameters:

dataType - the data type constant.

Returns:

the label corresponding to the specified data type constant.

Throws:

IfsException - if operation fails.

(Published)

toDataTypeLabel

public static String toDataTypeLabel(int dataType,
                                     LibrarySession session)
                              throws IfsException

Converts the specified data type constant to a localized label, using the Localizer from the specified LibrarySession.

Parameters:

dataType - the data type constant

session - the LibrarySession, whose current Localizer will be used for the conversion

Returns:

the label corresponding to the specified data type constant

Throws:

IfsException - if operation fails.

(Published)

toDataTypeLabel

public static String toDataTypeLabel(int dataType,
                                     Localizer localizer)
                              throws IfsException

Converts the specified data type constant to a localized label, using the specified Localizer. If a null is specified for the Localizer, a temporary Localizer (constructed based on the default Locale) is used for the conversion.

Parameters:

dataType - the data type constant.

localizer - the Localizer that performs the conversion

Returns:

the label corresponding to the specified data type constant.

Throws:

IfsException - if operation fails.

(Published)

toDataType

public static final int toDataType(String stype)
                            throws IfsException

Gets the integer data type value for the specified data type label.

Parameters:

stype - the data type label

Returns:

the data type value

Throws:

IfsException - if the operation fails

(Published)

isLegalDataType

public static final boolean isLegalDataType(int attributeDataType)

Gets whether the specified Attribute data type is legal.

Parameters:

attributeDataType - the Attribute data type

Returns:

whether the data type is a legal type

(Published)

attributeDataTypeIsArrayType

public static final boolean attributeDataTypeIsArrayType(int attributeDataType)
                                                  throws IfsException

Gets whether the specified Attribute data type is an array type.

Parameters:

attributeDataType - the Attribute data type

Returns:

whether the data type is an array type

Throws:

IfsException - (IFS-10400) if attributeDataType is invalid

(Published)

attributeDataTypeIsMapType

public static final boolean attributeDataTypeIsMapType(int attributeDataType)
                                                throws IfsException

Gets whether the specified Attribute data type is a map type.

Parameters:

attributeDataType - the Attribute data type

Returns:

whether the data type is a map type

Throws:

IfsException - (IFS-10400) if attributeDataType is invalid

(Published)

getMultiValueTableName

public static String getMultiValueTableName(int dataType,
                                            String suffix)
                                     throws IfsException

Gets the table name to use for storing multi-valued attribute values (maps or arrays), based on the specified data type and optional custom suffix.

Returns:

the table name to use for the map or array values, or null if the specified type is not array/map type

Throws:

IfsException - if the operation fails

(Published)

attributeDataTypeArrayTypeDatabaseObjectName

public static final String attributeDataTypeArrayTypeDatabaseObjectName(int attributeDataType)
                                                                 throws IfsException

Gets the default database object name for the attribute array tables for the specified array attribute data type.

Parameters:

attributeDataType - the Attribute data type

Returns:

the default database object name that holds the array values for this data type

Throws:

IfsException - (IFS-10410) if attributeDataType is not an array type

(Unpublished)

attributeDataTypeArrayPrefix

public static final String attributeDataTypeArrayPrefix(int attributeDataType)
                                                 throws IfsException

Gets the character prefix to use in generating the custom array table for the specified data type.

The table name for custom array value tables are prefixed with a prefix that is unique by type. For example, a custom String-array table name for a custom suffix of "previousaddresses" will be "odmzlt_previousaddresses". The "t" in that name is generated in this method.

Parameters:

attributeDataType - the Attribute data type

Returns:

the character prefix to use in generating the array value table name

Throws:

IfsException - (IFS-10410) if attributeDataType is not an array type

(Unpublished)

attributeDataTypeMapTypeDatabaseObjectName

public static final String attributeDataTypeMapTypeDatabaseObjectName(int attributeDataType)
                                                               throws IfsException

Gets the default database object name for the attribute map tables for the specified map attribute data type.

Parameters:

attributeDataType - the Attribute data type

Returns:

the default database object name that holds the map values for this data type

Throws:

IfsException - (IFS-10410) if attributeDataType is not a map type

(Unpublished)

getMultiValueTableCreateString

public static final String getMultiValueTableCreateString(int dataType,
                                                          int dataLength,
                                                          int dataScale,
                                                          String tableName)
                                                   throws IfsException

Gets the CREATE TABLE string for multi-value tables for the specified type and specified table name.

Parameters:

dataType - the Attribute data type

dataLength - the Attribute data length

dataScale - the Attribute data scale

tableName - the name of the table being created

Returns:

the CREATE TABLE string

Throws:

IfsException - (IFS-10400) if the specified type is not valid

(Unpublished)

attributeDataTypeIsObjectType

public static final boolean attributeDataTypeIsObjectType(int attributeDataType)
                                                   throws IfsException

Gets whether the specified Attribute data type is an object type.

Parameters:

attributeDataType - the Attribute data type

Returns:

whether the data type is an object type

Throws:

IfsException - (IFS-10400) if attributeDataType is invalid

(Published)

attributeDataTypeJdbcType

public static int attributeDataTypeJdbcType(int attributeDataType)
                                     throws IfsException

Gets the JDBC type for the specified Attribute data type.

Parameters:

attributeDataType - the Attribute data type

Returns:

the JDBC type

Throws:

IfsException - (IFS-10400) if attributeDataType is invalid

(Published)

attributeDataTypeRdbmsType

public static String attributeDataTypeRdbmsType(int attributeDataType)
                                         throws IfsException

Gets the RDBMS type for the specified Attribute data type.

Parameters:

attributeDataType - the Attribute data type

Returns:

the string RDBMS type. If the RDBMS type requires the data length to be specified, the default data length is used. Similarly, if the RDBMS type requires the data scale to be specified, the default data scale is used.

Throws:

IfsException - (IFS-10400) if attributeDataType is invalid

(Published)

attributeDataTypeRdbmsType

public static String attributeDataTypeRdbmsType(int attributeDataType,
                                                int dataLength)
                                         throws IfsException

Gets the RDBMS type for the specified Attribute data type.

Parameters:

attributeDataType - the Attribute data type

dataLength - the total number of digits in a numeric data type or the number of bytes (not characters) in a string. If data length is not applicable for this Attribute data type, the value is ignored.

Returns:

the string RDBMS type. If the RDBMS type requires the data scale to be specified, the default data scale is used.

Throws:

IfsException - (IFS-10400) if attributeDataType is invalid

(Published)

attributeDataTypeRdbmsType

public static String attributeDataTypeRdbmsType(int attributeDataType,
                                                int dataLength,
                                                int dataScale)
                                         throws IfsException

Gets the RDBMS type for the specified Attribute data type.

Parameters:

attributeDataType - the Attribute data type

dataLength - the total number of digits in a numeric data type or the number of bytes (not characters) in a string. If data length is not applicable for this Attribute data type, the value is ignored.

dataScale - the number of digits to the right of the decimal point in a numeric data type. If data scale is not applicable for this Attribute data type, the value is ignored.

Returns:

the string RDBMS type

Throws:

IfsException - (IFS-10400) if attributeDataType is invalid

(Published)

attributeDataTypeLabel

public static String attributeDataTypeLabel(int attributeDataType)
                                     throws IfsException

Gets the generic String representation (label) for the specified Attribute data type.

Parameters:

attributeDataType - the Attribute data type

Returns:

the String representation (label)

Throws:

IfsException - if the operation fails

(Published)

attributeDataTypeLabel

public static String attributeDataTypeLabel(int attributeDataType,
                                            int dataLength)
                                     throws IfsException

Gets the generic String representation (label) for the specified Attribute data type.

Parameters:

attributeDataType - the Attribute data type

dataLength - the data length

Returns:

the String representation (label)

Throws:

IfsException - if the operation fails

(Published)

attributeDataTypeLabel

public static String attributeDataTypeLabel(int attributeDataType,
                                            int dataLength,
                                            int dataScale)
                                     throws IfsException

Gets the generic String representation (label) for the specified Attribute data type.

Parameters:

attributeDataType - the Attribute data type

dataLength - the data length

dataScale - the data scale

Returns:

the String representation (label)

Throws:

IfsException - if the operation fails

(Published)

attributeDataTypeRdbmsTypeOracle

public static String attributeDataTypeRdbmsTypeOracle(int attributeDataType,
                                                      int dataLength,
                                                      int dataScale)
                                               throws IfsException

Gets the RDBMS type for the specified Attribute data type, for Oracle database.

Parameters:

attributeDataType - the Attribute data type

dataLength - the total number of digits in a numeric data type or the number of bytes (not characters) in a string. If data length is not applicable for this Attribute data type, the value is ignored.

dataScale - the number of digits to the right of the decimal point in a numeric data type. If data scale is not applicable for this Attribute data type, the value is ignored.

Returns:

the string RDBMS type for Oracle

Throws:

IfsException - (IFS-10400) if attributeDataType is invalid

(Published)

attributeDataTypeRdbmsTypePostgres

public static String attributeDataTypeRdbmsTypePostgres(int attributeDataType,
                                                        int dataLength,
                                                        int dataScale)
                                                 throws IfsException

Gets the RDBMS type for the specified Attribute data type, for Oracle database.

Parameters:

attributeDataType - the Attribute data type

dataLength - the total number of digits in a numeric data type or the number of bytes (not characters) in a string. If data length is not applicable for this Attribute data type, the value is ignored.

dataScale - the number of digits to the right of the decimal point in a numeric data type. If data scale is not applicable for this Attribute data type, the value is ignored.

Returns:

the string RDBMS type for Oracle

Throws:

IfsException - (IFS-10400) if attributeDataType is invalid

(Published)

attributeDataTypeDefaultDataLength

public static int attributeDataTypeDefaultDataLength(int attributeDataType)
                                              throws IfsException

Gets the default data length of the specified Attribute data type.

Parameters:

attributeDataType - the Attribute data type.

Returns:

the default total number of digits in a numeric data type or the default number of bytes (not characters) in a string. Returns 1 if data length is not applicable for this Attribute data type.

Throws:

IfsException - (IFS-10400) if attributeDataType is invalid

(Published)

attributeDataTypeDefaultDataScale

public static int attributeDataTypeDefaultDataScale(int attributeDataType)
                                             throws IfsException

Gets the default data scale of the specified Attribute data type.

Parameters:

attributeDataType - the Attribute data type.

Returns:

the default number of digits to the right of the decimal point in a numeric data type. Returns 0 if data scale is not applicable for this Attribute data type.

Throws:

IfsException - (IFS-10400) if attributeDataType is invalid

(Published)

attributeDataTypeBaseClassName

public static String attributeDataTypeBaseClassName(int dataType)
                                             throws IfsException

Gets the common name of the base Class representing the data type specified.

The object type must be an object data type.

Parameters:

dataType - the Attribute data type

Returns:

the common name of the base class

Throws:

IfsException - if dataType is invalid

(Published)