|
Oracle Role Manager Java API Reference 10g (10.1.4) E12031-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.iam.rm.temporal.query.ColumnSetDef
public class ColumnSetDef
A structure to allow definition of how search result columns should be provided and how it should be sorted.
Nested Class Summary | |
---|---|
class |
ColumnSetDef.SortEntry A structure to allow description of how the results should be sorted. |
static class |
ColumnSetDef.SortOrder Static variables for sort order, asc or desc for ascending or descending sort order. |
Constructor Summary | |
---|---|
ColumnSetDef() Creates a ColumnSetDef instance. |
|
ColumnSetDef(boolean unique) Creates a ColumnSetDef instance where the results will be guaranteed unique by the database. |
Method Summary | |
---|---|
void |
addAggregateColumn(java.lang.String resultObjectKey, java.lang.String resultObjectAttributeKey, java.lang.String columnKey, ColumnDef.AggregateFunction aggregateFunction) Requests an attribute value to be included in the result set rows, the vaue of which is determined by an aggregate function. |
void |
addColumn(java.lang.String resultObjectKey, java.lang.String resultObjectAttributeKey) Requests an attribute value to be included in the result set rows. |
void |
addColumn(java.lang.String resultObjectKey, java.lang.String resultObjectAttributeKey, java.lang.String columnKey) Requests an attribute value to be included in the result set rows. |
void |
addSort(java.lang.String resultObjectKey, java.lang.String resultObjectAttributeKey, ColumnSetDef.SortOrder direction) Requests the results be sorted by a particular attribute's value. |
java.util.Map<java.lang.String,ColumnDef> |
getColumnMappings(java.lang.String resultObjectKey) Gets column definitions, keyed by the names of the returned columns for the result object specified. |
java.util.List<ColumnSetDef.SortEntry> |
getSortEntries() Gets the sort orderings specified for this ColumnSetDef . |
boolean |
isUnique() Determines whether the results returned should be "unique". |
void |
resetSort() Resets the sort orders, if secondary and additional sort orders were added. |
void |
setUnique(boolean unique) Sets whether the results returned should be "unique". |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ColumnSetDef()
ColumnSetDef
instance.public ColumnSetDef(boolean unique)
ColumnSetDef
instance where the results will be guaranteed unique by the database. Warning: This has performance impacts with large sets of results.
unique
- either true for the results to be guaraneed unique or false.Method Detail |
---|
public void addColumn(java.lang.String resultObjectKey, java.lang.String resultObjectAttributeKey)
resultObjectKey
- identifying key of the object from the query definition from which to extract the attributeresultObjectAttributeKey
- attribute key from the specified object to includepublic void addColumn(java.lang.String resultObjectKey, java.lang.String resultObjectAttributeKey, java.lang.String columnKey)
resultObjectKey
- identifying key of the object from the query definition from which to extract the attributeresultObjectAttributeKey
- attribute key from the specified object to includecolumnKey
- identifying key that the attribute value will be referred to in each result set rowpublic void addAggregateColumn(java.lang.String resultObjectKey, java.lang.String resultObjectAttributeKey, java.lang.String columnKey, ColumnDef.AggregateFunction aggregateFunction)
resultObjectKey
- identifying key of the object from the query definition form which to extract the attributeresultObjectAttributeKey
- attribute key from the specified object to includecolumnKey
- identifying key that the attribute value will be referred to in each result set rowaggregateFunction
- the aggregate function whose result will be in the column specifiedpublic void resetSort()
addSort(java.lang.String, java.lang.String, oracle.iam.rm.temporal.query.ColumnSetDef.SortOrder)
public void addSort(java.lang.String resultObjectKey, java.lang.String resultObjectAttributeKey, ColumnSetDef.SortOrder direction)
resetSort()
method.resultObjectKey
- identifying key of the object from the query definition from which to sort the attributeresultObjectAttributeKey
- attribute key from the specified object to sort ondirection
- sort order, either asc
or desc
resetSort()
public java.util.Map<java.lang.String,ColumnDef> getColumnMappings(java.lang.String resultObjectKey)
resultObjectKey
- the subject identifier in the result setColumnDef
s of a result subject, keyed by result columnpublic java.util.List<ColumnSetDef.SortEntry> getSortEntries()
ColumnSetDef
.ColumnSetDef
public boolean isUnique()
true
to return unique results, false
to allow repeatspublic void setUnique(boolean unique)
unique
- true
to return unique results, false
to allow repeats
|
Oracle Role Manager Java API Reference 10g (10.1.4) E12031-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |