|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.ifs.beans.LibraryObject | +--oracle.ifs.beans.TieLibraryObject | +--oracle.ifs.beans.SchemaObject | +--oracle.ifs.beans.TieSchemaObject | +--oracle.ifs.beans.ValueDomain
A ValueDomain describes a validation that can be applied to an Attribute to ensure that LibraryObjects' values for that Attribute lie within a set of acceptable values.
Field Summary | |
static java.lang.String |
CLASS_NAME
This class name for this class. |
static java.lang.String |
DESCRIPTION_ATTRIBUTE
A textual description of this ValueDomain. |
static java.lang.String |
UNIQUENAME_ATTRIBUTE
A system-set attribute used to ensure each ValueDomain has a unique name. |
static java.lang.String |
VALUEDOMAINPROPERTYBUNDLE_ATTRIBUTE
The PropertyBundle that defines values for this object. |
static int |
VALUEDOMAINTYPE_ENUMERATED
The acceptable values for the ValueDomain are enumerated. |
static int |
VALUEDOMAINTYPE_EXCLUSIVE_MAXIMUM
The acceptable values for the ValueDomain are such that value < maximum. |
static int |
VALUEDOMAINTYPE_EXCLUSIVE_MINIMUM
The acceptable values for the ValueDomain are such that value > minimum. |
static int |
VALUEDOMAINTYPE_EXCLUSIVE_RANGE
The acceptable values for the ValueDomain are such that minimum < value < maximum. |
static int |
VALUEDOMAINTYPE_MAXIMUM
The acceptable values for the ValueDomain are such that value <= maximum. |
static int |
VALUEDOMAINTYPE_MINIMUM
The acceptable values for the ValueDomain are such that value >= minimum. |
static int |
VALUEDOMAINTYPE_RANGE
The acceptable values for the ValueDomain are such that minimum <= value <= maximum. |
Fields inherited from class oracle.ifs.beans.SchemaObject |
ACTIVE_ATTRIBUTE, NAME_ATTRIBUTE, POLICYBUNDLE_ATTRIBUTE, PROPERTYBUNDLE_ATTRIBUTE |
Method Summary | |
java.lang.String |
getDescription()
Gets the description of this ValueDomain. |
AttributeValue |
getPropertyValue()
Gets the value of the ValueDomainPropertyBundle of this ValueDomain. |
ValueDomainPropertyBundle |
getValueDomainPropertyBundle()
Gets the ValueDomainPropertyBundle of this ValueDomain. |
void |
setDescription(java.lang.String description)
Sets the description of this ValueDomain. |
void |
setValueDomainPropertyBundle(ValueDomainPropertyBundle bundle)
Sets the ValueDomainPropertyBundle of this ValueDomain. |
static java.lang.String |
toValueDomainTypeLabel(int valueDomainType)
Converts the specified ValueDomainType constant to a localized label. |
static java.lang.String |
toValueDomainTypeLabel(int valueDomainType,
LibrarySession session)
Converts the specified ValueDomainType constant to a localized label, using the Localizer from the specified LibrarySession. |
static java.lang.String |
toValueDomainTypeLabel(int valueDomainType,
Localizer localizer)
Converts the specified ValueDomainType constant to a localized label, using the specified Localizer. |
static java.lang.String |
valueDomainTypeName(int valueDomainType,
Localizer localizer)
Deprecated. use toValueDomainTypeLabel() |
static java.lang.String |
valueDomainTypeResourceBundleKey(int valueDomainType)
Gets resource bundle key for the specified ValueDomain type. |
Methods inherited from class oracle.ifs.beans.SchemaObject |
getPolicyBundle, getPropertyBundle, hasNameAttribute, isActive, putPolicy, putProperty, putProperty, removeAllPolicies, removeAllProperties, removePolicy, removePolicy, removeProperty, setActive, setPolicyBundle, setPropertyBundle |
Methods inherited from class oracle.ifs.beans.LibraryObject |
equals, free, free, getAttribute, getAttributeByUpperCaseName, getAttributes, getAttributesByUpperCaseNames, getClassId, getClassObject, getDefinition, getId, getLabel, getName, getSession, handleEvent, invokeServerMethod, isInstanceOf, isTraced, lookupInstanceLabel, postEvent, postEvent, renderAsReader, renderAsStream, setAttribute, setAttribute, setAttributes, setAttributes, setName, toString, trace, update |
Methods inherited from interface oracle.ifs.common.LibraryObjectInterface |
getId |
Methods inherited from interface oracle.ifs.common.Traceable |
getTraceLogger, isTraced, trace |
Field Detail |
public static final java.lang.String CLASS_NAME
public static final java.lang.String DESCRIPTION_ATTRIBUTE
public static final java.lang.String VALUEDOMAINPROPERTYBUNDLE_ATTRIBUTE
public static final java.lang.String UNIQUENAME_ATTRIBUTE
public static final int VALUEDOMAINTYPE_ENUMERATED
A ValueDomain can have this domain type if its data type is INTEGER, LONG, STRING, DATE, SCHEMAOBJECT, SYSTEMOBJECT, PUBLICOBJECT, or DIRECTORYOBJECT.
public static final int VALUEDOMAINTYPE_RANGE
A ValueDomain can have this domain type if its data type is INTEGER, LONG, DOUBLE, or DATE.
public static final int VALUEDOMAINTYPE_MINIMUM
A ValueDomain can have this domain type if its data type is INTEGER, LONG, DOUBLE, or DATE.
public static final int VALUEDOMAINTYPE_MAXIMUM
A ValueDomain can have this domain type if its data type is INTEGER, LONG, DOUBLE, or DATE.
public static final int VALUEDOMAINTYPE_EXCLUSIVE_RANGE
A ValueDomain can have this domain type if its data type is INTEGER, LONG, DOUBLE, or DATE.
public static final int VALUEDOMAINTYPE_EXCLUSIVE_MINIMUM
A ValueDomain can have this domain type if its data type is INTEGER, LONG, DOUBLE, or DATE.
public static final int VALUEDOMAINTYPE_EXCLUSIVE_MAXIMUM
A ValueDomain can have this domain type if its data type is INTEGER, LONG, DOUBLE, or DATE.
Method Detail |
public final void setDescription(java.lang.String description) throws IfsException
description
- the descriptionIfsException
- if the operation failspublic final java.lang.String getDescription() throws IfsException
IfsException
- if the operation failspublic final void setValueDomainPropertyBundle(ValueDomainPropertyBundle bundle) throws IfsException
bundle
- the ValueDomainPropertyBundleIfsException
- if the operation failspublic final ValueDomainPropertyBundle getValueDomainPropertyBundle() throws IfsException
IfsException
- if the operation failspublic final AttributeValue getPropertyValue() throws IfsException
This method returns an array-type AttributeValue the represents the values allowed for this ValueDomain.
The number of elements in the array-type AttributeValue depends on the domain type of the ValueDomainPropertyBundle:
VALUEDOMAINTYPE_ENUMERATED
:
one element for each allowed value
VALUEDOMAINTYPE_RANGE
or VALUEDOMAINTYPE_ENUMERATED_RANGE
:
two elements; [0] is the minimum and [1] is the maximum value
VALUEDOMAINTYPE_MINIMUM
or VALUEDOMAINTYPE_ENUMERATED_MINIMUM
:
one element; [0] is the minimum value
VALUEDOMAINTYPE_MAXIMUM
or VALUEDOMAINTYPE_ENUMERATED_MAXIMUM
:
one element; [0] is the maximum value
IfsException
- if the operation failspublic static final java.lang.String valueDomainTypeResourceBundleKey(int valueDomainType) throws IfsException
Call LibrarySession.getResourceString
with the returned
value to get a localized name for the specified ValueDomain type.
valueDomainType
- the ValueDomain typeIfsException
- (IFS-31400) if valueDomainType is invalidpublic static final java.lang.String valueDomainTypeName(int valueDomainType, Localizer localizer) throws IfsException
valueDomainType
- the ValueDomain typelocalizer
- the Localizer to useIfsException
- if operation failspublic static java.lang.String toValueDomainTypeLabel(int valueDomainType) throws IfsException
valueDomainType
- the ValueDomainType constant.IfsException
- if operation fails.public static java.lang.String toValueDomainTypeLabel(int valueDomainType, LibrarySession session) throws IfsException
valueDomainType
- the ValueDomainType constantsession
- the LibrarySession, whose current
Localizer will be used for the conversionIfsException
- if operation fails.public static java.lang.String toValueDomainTypeLabel(int valueDomainType, Localizer localizer) throws IfsException
valueDomainType
- the ValueDomainType constant.localizer
- the Localizer that performs the conversionIfsException
- if operation fails.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |