|
|||||||||
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.ClassDomain
A ClassDomain describes a validation that can be applied to an object-type Attribute to ensure that LibraryObjects' values for that Attribute are instances of specified ClassObjects.
Field Summary | |
static java.lang.String |
CLASS_NAME
Class name for this class. |
static int |
CLASSDOMAINTYPE_ENUMERATED
The ClassDomain consists of the ClassObjects specified with setClasses . |
static int |
CLASSDOMAINTYPE_ENUMERATED_AND_SUBCLASSES
The ClassDomain consists of the ClassObjects specified with setClasses , and their subclasses. |
static java.lang.String |
CLASSES_ATTRIBUTE
The ClassObjects in this ClassDomain. |
static java.lang.String |
DESCRIPTION_ATTRIBUTE
A textual description of this ClassDomain. |
static java.lang.String |
DOMAINTYPE_ATTRIBUTE
An indicator whether the specific class or the class and its subclasses should be applied as the domain. |
static java.lang.String |
UNIQUENAME_ATTRIBUTE
A system-set attribute used to ensure each ClassDomain has an unique name. |
Fields inherited from class oracle.ifs.beans.SchemaObject |
ACTIVE_ATTRIBUTE, NAME_ATTRIBUTE, POLICYBUNDLE_ATTRIBUTE, PROPERTYBUNDLE_ATTRIBUTE |
Method Summary | |
static java.lang.String |
classDomainTypeName(int domainType,
Localizer localizer)
Deprecated. use toValueDomainTypeLabel() |
static java.lang.String |
classDomainTypeResourceBundleKey(int domainType)
Gets resource bundle key for the specified ClassDomain type. |
ClassObject[] |
getClasses()
Gets the classes in this ClassDomain. |
ClassObject |
getClasses(int index)
Gets the specified class in this ClassDomain. |
java.lang.String |
getDescription()
Gets the description of this ClassDomain. |
int |
getDomainType()
Gets the domain type of this ClassDomain. |
java.lang.String |
getDomainTypeLabel()
Gets the localized String label for the DomainType set for this instance. |
void |
setClasses(ClassObject[] cos)
Sets the classes in this ClassDomain. |
void |
setDescription(java.lang.String description)
Sets the description of this ClassDomain. |
void |
setDomainType(int domainType)
Sets the domain type of this ClassDomain. |
static java.lang.String |
toDomainTypeLabel(int domainType)
Converts the specified DomainType constant to a localized label. |
static java.lang.String |
toDomainTypeLabel(int domainType,
LibrarySession session)
Converts the specified DomainType constant to a localized label, using the Localizer from the specified LibrarySession. |
static java.lang.String |
toDomainTypeLabel(int domainType,
Localizer localizer)
Converts the specified DomainType constant to a localized label, using the specified Localizer. |
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 DOMAINTYPE_ATTRIBUTE
public static final java.lang.String CLASSES_ATTRIBUTE
public static final java.lang.String UNIQUENAME_ATTRIBUTE
public static final int CLASSDOMAINTYPE_ENUMERATED
setClasses
.public static final int CLASSDOMAINTYPE_ENUMERATED_AND_SUBCLASSES
setClasses
, and their subclasses.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 setDomainType(int domainType) throws IfsException
domainType
- the domain type; must be either
CLASSDOMAINTYPE_ENUMERATED
or
CLASSDOMAINTYPE_ENUMERATED_AND_SUBCLASSES
IfsException
- if the operation failspublic final int getDomainType() throws IfsException
IfsException
- if the operation failspublic final void setClasses(ClassObject[] cos) throws IfsException
cos
- the classesIfsException
- if the operation failspublic final ClassObject[] getClasses() throws IfsException
IfsException
- if the operation failspublic final ClassObject getClasses(int index) throws IfsException
index
- the zero-based indexIfsException
- if the operation failspublic static final java.lang.String classDomainTypeResourceBundleKey(int domainType) throws IfsException
Call LibrarySession.getResourceString
with the returned
value to get a localized name for the specified ClassDomain type.
domainType
- the ClassDomain typeIfsException
- (IFS-31200) if domainType is invalidpublic static final java.lang.String classDomainTypeName(int domainType, Localizer localizer) throws IfsException
domainType
- the ClassDomain typelocalizer
- the Localizer to useIfsException
- if operation failspublic java.lang.String getDomainTypeLabel() throws IfsException
IfsException
- if operation fails.public static java.lang.String toDomainTypeLabel(int domainType) throws IfsException
domainType
- the DomainType constant.IfsException
- if operation fails.public static java.lang.String toDomainTypeLabel(int domainType, LibrarySession session) throws IfsException
domainType
- the DomainType constantsession
- the LibrarySession, whose current
Localizer will be used for the conversionIfsException
- if operation fails.public static java.lang.String toDomainTypeLabel(int domainType, Localizer localizer) throws IfsException
domainType
- the DomainType 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 |