Skip navigation links

oracle.iam.rm.temporal.query
Class ColumnDef

java.lang.Object
oracle.iam.rm.temporal.query.ColumnDef

public class ColumnDef

extends java.lang.Object

Class that represents a resultset column used by ColumnSetDefs to describe columns returned within search results.

Nested Class Summary

static class

ColumnDef.AggregateFunction Enumeration of types of supported aggregate functions.

Constructor Summary

ColumnDef(java.lang.String attributeKey)
Creates a ColumnDef instance with the provided attribute key and no aggregate function.

ColumnDef(java.lang.String attributeKey, ColumnDef.AggregateFunction aggregateFunction)
Creates a ColumnDef instance with the provided attribute key with a specified aggregate function.

Method Summary

ColumnDef.AggregateFunction	getAggregateFunction() Gets the aggregate function to apply when returning this column's value or null if none should be applied.
java.lang.String	getAttributeKey() Gets the attribute that should be returned as a populated column in the results.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ColumnDef

public ColumnDef(java.lang.String attributeKey)

Creates a ColumnDef instance with the provided attribute key and no aggregate function.

Parameters:

attributeKey - the attribute that should be returned as a populated column in the results

ColumnDef

public ColumnDef(java.lang.String attributeKey,
                 ColumnDef.AggregateFunction aggregateFunction)

Creates a ColumnDef instance with the provided attribute key with a specified aggregate function.

Parameters:

attributeKey - the attribute that should be returned as a populated column in the results

aggregateFunction - the aggregate function to apply when returning this column's value

Method Detail

getAggregateFunction

public ColumnDef.AggregateFunction getAggregateFunction()

Gets the aggregate function to apply when returning this column's value or null if none should be applied.

Returns:

the aggregate function to apply when returning this column's value

getAttributeKey

public java.lang.String getAttributeKey()

Gets the attribute that should be returned as a populated column in the results.

Returns:

the attribute that should be returned as a populated column in the results

Skip navigation links