|
Oracle Fusion Middleware extensions for Applications Core API Reference 11g Release 1 (11.1.1.6) E22562-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.jbo.server.RowImpl oracle.jbo.server.ViewRowImpl oracle.apps.fnd.applcore.oaext.model.OAViewRowImpl
public class OAViewRowImpl
Provides access to a view object row. The view object row can refer one or more entity object's rows in addition to derived attributes such as calculated columns. An object of this class is instantiated for each record that is returned by the row's view object query.
Example:
The code in this example creates a new row and initializes the
Name
attribute before adding it to the view object.
// search for view object in application module
OAViewObject viewObjectInstance = (OAViewObject)
am.findViewObject("SampleViewObject");
// create a new instance
OAViewRowImpl sampleRow = (OAViewRowImpl) viewObjectInstance.createRow();
// Set or initialize attribute
sampleRow.setAttribute("Name", "XYZ");
// add it to the view object
viewObjectInstance.insertRow(sampleRow);
Nested Class Summary |
---|
Nested classes/interfaces inherited from class oracle.jbo.server.ViewRowImpl |
---|
oracle.jbo.server.ViewRowImpl.PostState |
Field Summary | |
---|---|
static java.lang.String |
JAXB_CONTEXT_PATH
|
static java.lang.String |
RCS_ID
Oracle Applications internal source control identifier. |
Fields inherited from class oracle.jbo.server.ViewRowImpl |
---|
CURRENT_VERSION, ORIGINAL_VERSION, XML_POSTSTATE_REMOVE, XML_POSTSTATE_TAG |
Fields inherited from interface oracle.jbo.JboReservedVarNames |
---|
RESERVED_VAR_AGG_AVG, RESERVED_VAR_AGG_COUNT, RESERVED_VAR_AGG_MAX, RESERVED_VAR_AGG_MIN, RESERVED_VAR_AGG_SUM, RESERVED_VAR_AGGVAL_PREFIX, RESERVED_VAR_STRUCTURE_DEF |
Fields inherited from interface oracle.jbo.expr.JIReservedVarNames |
---|
RESERVED_VAR_VALUE |
Fields inherited from interface oracle.jbo.Row |
---|
EFFDT_DELETE_FUTURE_CHANGE_MODE, EFFDT_DELETE_MODE, EFFDT_DELETE_NEXT_CHANGE_MODE, EFFDT_DELETE_THIS_CHANGE_MODE, EFFDT_DELETE_ZAP_MODE, EFFDT_EXPERT_MODE, EFFDT_NONE_MODE, EFFDT_UPDATE_CHANGE_INSERT_MODE, EFFDT_UPDATE_CORRECTION, EFFDT_UPDATE_MODE, EFFDT_UPDATE_NEW_EARLIEST_CHANGE_MODE, EFFDT_UPDATE_OVERRIDE_MODE, REFRESH_CONTAINEES, REFRESH_FORGET_NEW_ROWS, REFRESH_REMOVE_NEW_ROWS, REFRESH_UNDO_CHANGES, REFRESH_WITH_DB_FORGET_CHANGES, REFRESH_WITH_DB_ONLY_IF_UNCHANGED, STATUS_INITIALIZED |
Fields inherited from interface oracle.jbo.XMLInterface |
---|
XML_IGNORE_DEPTH_COUNT, XML_OPT_ALL_ROWS, XML_OPT_ASSOC_CONSISTENT, XML_OPT_CHANGES_ONLY, XML_OPT_LIMIT_RANGE, XML_PASSIVATION_USE |
Constructor Summary | |
---|---|
OAViewRowImpl()
|
Method Summary | |
---|---|
protected void |
create(oracle.jbo.AttributeList nvp)
Creates a row based on an attribute list. |
protected oracle.jbo.RowSet |
createViewAccessorRS(java.lang.String p1)
This method is used for processing KeyFlexField Filters. |
java.lang.Object |
findDiscriminatorForFilterRow(oracle.jbo.AttributeDef filterDef)
|
PreferencesBean |
getApplCorePrefs()
Allows for groovy access to applcore preferences - see bug 9655121 |
java.lang.Object |
getAttribute(int baseIndex,
java.lang.String lang)
Returns the value of the attribute sepecified by baseIndex in
the translation sepcified by language code lang . |
java.lang.Object |
getAttribute(java.lang.String attrName,
java.lang.String lang)
Returns the value of the attribute sepecified by attrName in
the translation sepcified by language code lang . |
java.lang.Object |
getDisplay(java.lang.String viewAccessorName,
java.lang.String displayAttrName,
boolean returnNull)
Gets the display for a value through a view accessor. |
oracle.jbo.server.EntityImpl[] |
getEntities()
Returns the array of entities on which this view row is based. |
java.lang.String |
getKeyFlexfieldCombination(java.lang.String viewLinkAccessorName)
Gets a key flexfield combination (concatenated values) in this row. |
java.lang.Long |
getKeyFlexfieldCombinationID(java.lang.String accessorName,
java.lang.String combo)
Gets the ID of a key flexfield combination. |
oracle.jbo.server.ViewDefImpl |
getKeyFlexfieldViewDefImpl(java.lang.String accessorName)
Internal use only. |
KFFViewObjectImpl |
getKeyFlexfieldViewObjectForQuery(java.lang.String accessorName)
For Internal Use Only. Gets a key flexfield view object for querying the combinations. |
java.lang.Long |
getSetId(java.lang.String foreinKeyAttribute)
Returns the Set Id value to be used for the references specified by its foreign key attribute name. |
java.lang.String[] |
getTranslatedLanguages()
gets a list of all languages for which translations exist for any OAEntityImpl objects refered to by this OAViewRowImpl
. . |
protected boolean |
isRefreshRequired(oracle.jbo.server.ViewAccessorDef va,
java.lang.String[] attrNames,
java.lang.Object[] attrValues)
Check if a view accessor should be refreshed when a list of attribute get changed. |
boolean |
isTranslatable()
Returns true if this view row is based on at least on translatable entity. |
boolean |
isTranslatableAttribute(int baseIndex)
Indicates if the attribute is a translatable attribute. |
boolean |
isTranslated()
Returns true if there is at least on translated language other than the base language for any of the entities on which this view row is based on. |
java.lang.Boolean |
populteFilterMap(oracle.jbo.domain.ClobDomain xmlClob,
FndFilterTypeImpl fcimpl)
|
protected void |
refreshViewAccessor(oracle.jbo.server.ViewAccessorDef va,
java.util.Map attrNameValues,
oracle.jbo.RowSet rs)
|
void |
remove()
Deletes the row. |
void |
setAttribute(int index,
java.lang.Object val)
Sets the value of an attribute. |
void |
setAttribute(int baseIndex,
java.lang.String lang,
java.lang.Object value)
Sets the attribute translation for the sepecified by baseIndex in language code sepcified by lang . |
void |
setAttribute(java.lang.String attrName,
java.lang.String lang,
java.lang.Object value)
Sets the attribute translation for the sepecified by baseIndex in language code sepcified by lang . |
protected void |
setAttributeInternal(int index,
java.lang.Object value)
|
void |
setKeyFlexfieldCombinationID(java.lang.String viewLinkAccessorName,
java.lang.String combo)
Sets the key flexfield combination ID. |
protected boolean |
skipFilterListOnKeyAttributes(oracle.jbo.server.ListBinding lb,
java.util.Map valuesMap)
|
void |
validate()
Validates the view object row. |
boolean |
validateKeyFlexfieldCombinationID(java.lang.String accessorName,
java.lang.Long ccid)
Validates a key flexfield combination ID. |
Methods inherited from class oracle.jbo.server.ViewRowImpl |
---|
_internal_dbg_debug_data, appendXMLElementNodes, appendXMLElementNodes, checkForOuterJoins, clearAttributeException, clearAttributeException, copyFrom, createEntities, createListBinding, createMissingEntitiesFromViewDef, createViewAccessorRS, createViewRowAttrHints, doAllowsOperation, doAutoClearAttribute, entityCacheAdd, equals, findAssociatedObjects, findAttributeDef, findListBindingName, findListBindingRSI, findOrCreateLocalViewObject, findOrCreateViewAccessorRS, findOrCreateViewAccessorRS, findRowSetForRow, findViewAccessorDef, getApplicationModule, getApplicationModuleForViewAccessor, getAttribute, getAttribute, getAttributeCount, getAttributeHints, getAttributeHints, getAttributeIndexOf, getAttributeInternal, getAttributeInternal, getAttributeNames, getAttributeValues, getAttrInvokeAccessor, getCtrlHints, getDBTransaction, getEffectiveDate, getElementTagName, getEntity, getEntityAttrForAttribute, getEntityCount, getEntityForAttribute, getEntityForListBinding, getExprVarVal, getHandle, getKey, getListBindingCount, getListBindingRSI, getListBindings, getLookupDescription, getNewRowState, getOriginalAttributeValue, getParentVariableManager, getPreferredListBindingRSI, getPrimaryEntityReference, getPrimaryPostState, getQueryCollection, getRowSet, getRowStorageInternal, getStructureDef, getViewDef, getViewLogicGroupDef, getViewObject, getXMLElementTag, handleListBindingMismatch, hasAttributeException, hasDeferredExceptions, hasExtendedViewDef, hashCode, hasListBindings, initDefaults, invokeMethod, isAttributeChanged, isAttributeUpdateable, isDead, isRefreshRequired, isSubclassRow, isViewAccessorAttribute, lock, lookupAttributeDef, markViewAccessorsDirty, populate, populateAttribute, populateAttributeAsChanged, readAttributeFromXMLElement, readXML, refresh, registerAttributeException, removeAndRetain, removeFromCollection, renderAttributeInXMLElement, renderAttributeInXMLElement, revert, revertRow, revertRowAndContainees, setAttribute, setAttributeValues, setAttrInvokeAccessor, setEffectiveDateMode, setEffectiveDateOnEntities, setEntities, setEntity, setNewRowState, setStateOnEntity, setTransientAttributeValue, shouldAddViewAccessorRSToRow, throwOnListBindingMismatch, toString, writeAsXml, writeAsXml, writeXML |
Methods inherited from class oracle.jbo.server.RowImpl |
---|
addListBindingsForAttribute, clearAllExceptions, clearRowExceptions, createXMLDefinition, ensureVariableManager, findAttrAndGetIndex, forceFilterListExecute, getAllExceptions, getAttributeInternal, getAttributeSecurityHints, getAttributeSecurityHints, getCombinedAttrNames, getEffectiveDateMode, getExprMethodVal, getGlobalScript, getHints, getMessageBundleClass, getMethodKind, getResourceBundleDef, getRowExceptions, getSecurityHints, getVariableManager, getViewAccessorResultIndex, hasAttributeException, hasVariables, isRefreshRequired, lookupListBinding, printXMLDefinition, readXML, refreshViewAccessor, refreshViewAccessor, registerRowException, setAttributeInternal, setExprVarVal, setInMultiSetter, variablesAdded, writeXML, writeXML, writeXML |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String RCS_ID
public static final java.lang.String JAXB_CONTEXT_PATH
Constructor Detail |
---|
public OAViewRowImpl()
Method Detail |
---|
public void setAttribute(int index, java.lang.Object val)
setAttribute
in interface oracle.jbo.AttributeList
setAttribute
in class oracle.jbo.server.ViewRowImpl
index
- the attribute's indexval
- the value to be assigned to the attributepublic java.lang.String getKeyFlexfieldCombination(java.lang.String viewLinkAccessorName)
viewLinkAccessorName
- the name of the view link accessor to the
key flexfield
java.lang.IllegalArgumentException
- if the given view link accessor name
is nullprotected void setAttributeInternal(int index, java.lang.Object value)
setAttributeInternal
in class oracle.jbo.server.ViewRowImpl
public void setKeyFlexfieldCombinationID(java.lang.String viewLinkAccessorName, java.lang.String combo)
viewLinkAccessorName
- the name of the view link accessor to the
key flexfieldcombo
- the combination
java.lang.IllegalArgumentException
- if the given view link accessor name
is null or the combination is null
java.lang.UnsupportedOperationException
- if this view row is not a key
flexfield view row, or the flexfield model does not support
this operation
oracle.jbo.AttrSetValException
- if the given combination is invalid
oracle.jbo.JboException
- if an error occurs during the operationpublic java.lang.Long getKeyFlexfieldCombinationID(java.lang.String accessorName, java.lang.String combo)
null
is
returned. All combination constraints are applied when searching for
the ID.
accessorName
- the name ofo the view link accessor to the key flexfieldcombo
- the combination
java.lang.UnsupportedOperationException
- if this view row is not a key
flexfield master row.
oracle.jbo.JboException
- if the given view link accessor is not
found, or the root application module does not include an
instance of the key flexfield application modulepublic boolean validateKeyFlexfieldCombinationID(java.lang.String accessorName, java.lang.Long ccid)
accessorName
- the name of the view link accessor to the key flexfieldccid
- the combination ID
oracle.jbo.JboException
- if the given view link accessor is not
found, or the root application module does not include an
instance of the key flexfield application modulepublic KFFViewObjectImpl getKeyFlexfieldViewObjectForQuery(java.lang.String accessorName)
accessorName
- the view link accessor name
java.lang.IllegalArgumentException
- if the given view link accessor is not
found, or it is linked to a key flexfield model
oracle.jbo.JboException
- if the key flexfield application module cannot be
foundpublic oracle.jbo.server.ViewDefImpl getKeyFlexfieldViewDefImpl(java.lang.String accessorName)
Gets the key flexfield view definition of this row.
accessorName
- the name of the accessor to the key flexfield
public void validate()
validate
in interface oracle.jbo.Row
validate
in class oracle.jbo.server.ViewRowImpl
protected void create(oracle.jbo.AttributeList nvp)
You can throw the exception OAAttrValException or OARowValException. These exceptions are caught and displayed in a message box on the page. See OA Framework Developer Guide: Error Handling for further details.
create
in class oracle.jbo.server.ViewRowImpl
nvp
- the list of attributes to be used in the creation of the row
//see #setAttributepublic void remove()
You can throw the exception OAAttrValException or OARowValException. These exceptions are caught and displayed in a message box on the page. See OA Framework Developer Guide: Error Handling for further details.
remove
in interface oracle.jbo.Row
remove
in class oracle.jbo.server.ViewRowImpl
public oracle.jbo.server.EntityImpl[] getEntities()
getEntities
in class oracle.jbo.server.ViewRowImpl
public boolean isTranslated()
getTranslatedLanguages()
public boolean isTranslatable()
isTranslatableAttribute(int)
public java.lang.String[] getTranslatedLanguages()
OAEntityImpl
objects refered to by this OAViewRowImpl
. .
The base language will always be reported as a translated language.
Note also that an OAViewRowImpl
may contain
OAEntityImpl
objects which have translations for differing
langauges (With US as base language, one contains no translations,
another for JA 'Japanese' and D 'German', and a third for D 'German'
and F 'French'). In this case, this method returns the union of all
translated langauges (US, JA, D, F).
public java.lang.Object getAttribute(int baseIndex, java.lang.String lang)
baseIndex
in
the translation sepcified by language code lang
.
If the attribute is not translated, then the base language value will be
returned.
baseIndex
- attribute index.lang
- langauge code (one of "US", "JP", ...).
isTranslatableAttribute(int)
,
setAttribute(int, java.lang.String, java.lang.Object)
public java.lang.Object getAttribute(java.lang.String attrName, java.lang.String lang)
attrName
in
the translation sepcified by language code lang
.
If the attribute is not translated, then the base language value will be
returned.
attrName
- attribute name.lang
- the langauge code (one of "US", "JP", ...).
isTranslatableAttribute(int)
,
setAttribute(java.lang.String, java.lang.String, java.lang.Object)
public void setAttribute(int baseIndex, java.lang.String lang, java.lang.Object value)
baseIndex
in language code sepcified by lang
.
If the attribute is not translated, then the base language value will
be set.
baseIndex
- attribute index.lang
- langauge code (one of "US", "JP", ...).value
- of Object type
isTranslatableAttribute(int)
,
getAttribute(int, String)
public void setAttribute(java.lang.String attrName, java.lang.String lang, java.lang.Object value)
baseIndex
in language code sepcified by lang
.
If the attribute is not translated, then the base language value will
be set.
attrName
- attribute name.lang
- langauge code (one of "US", "JP", ...).value
- of Object type
isTranslatableAttribute(int)
,
getAttribute(String, String)
public boolean isTranslatableAttribute(int baseIndex)
baseIndex
- specifies which attribute.
isTranslated()
public java.lang.Long getSetId(java.lang.String foreinKeyAttribute)
null
will be returned.
foreinKeyAttribute
- the foreign key attribute name.
-1
if the reference is not Set Id enabled.protected void refreshViewAccessor(oracle.jbo.server.ViewAccessorDef va, java.util.Map attrNameValues, oracle.jbo.RowSet rs)
refreshViewAccessor
in class oracle.jbo.server.ViewRowImpl
protected boolean isRefreshRequired(oracle.jbo.server.ViewAccessorDef va, java.lang.String[] attrNames, java.lang.Object[] attrValues)
isRefreshRequired
in class oracle.jbo.server.RowImpl
va
- The View Accessor to be checked.attrNames
- The array of changed attribute.attrValues
- The array of values for the changed attribute if values are not in the current row.
public java.lang.Boolean populteFilterMap(oracle.jbo.domain.ClobDomain xmlClob, FndFilterTypeImpl fcimpl)
public java.lang.Object findDiscriminatorForFilterRow(oracle.jbo.AttributeDef filterDef)
protected oracle.jbo.RowSet createViewAccessorRS(java.lang.String p1)
createViewAccessorRS
in class oracle.jbo.server.ViewRowImpl
p1
- - Name of the View Accessor
protected boolean skipFilterListOnKeyAttributes(oracle.jbo.server.ListBinding lb, java.util.Map valuesMap)
skipFilterListOnKeyAttributes
in class oracle.jbo.server.RowImpl
public PreferencesBean getApplCorePrefs()
public java.lang.Object getDisplay(java.lang.String viewAccessorName, java.lang.String displayAttrName, boolean returnNull)
returnNull
to true. If the view accessor row set contains
more than one row, the attribute value from the first row is returned.
viewAccessorName
- the name of the view accessordisplayAttrName
- the view attribute name of the displayreturnNull
- true if this method should return null immediately
java.lang.IllegalArgumentException
- if the given view accessor name or
display attribute name is null
FlexfieldJboException
- if the view accessor row set cannot be
found
|
Oracle Fusion Middleware extensions for Applications Core API Reference 11g Release 1 (11.1.1.6) E22562-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |