Package ch.ivyteam.ivy.workflow

Class PropertyOrder<T extends IProperty>

java.lang.Object

ch.ivyteam.ivy.workflow.PropertyOrder<T>

Type Parameters:

T - the type of the property to use

public class PropertyOrder<T extends IProperty>
extends Object

Defines how to order a workflow object after a certain property

Since:

19.07.2007

API:

This is a public API.

Constructor Summary

Constructors

Constructor	Description
PropertyOrder(T property)	Constructor
PropertyOrder(T property, OrderDirection orderDirection)	Constructor

Method Summary

Modifier and Type	Method	Description
static <T extends IProperty> List<PropertyOrder<T>>	create(T property)	Creates a PropertyOrder list with one property
static <T extends IProperty> List<PropertyOrder<T>>	create(T... properties)	Creates a PropertyOrder list
static <T extends IProperty> List<PropertyOrder<T>>	create(T property, OrderDirection orderDirection)	Creates a PropertyOrder list with one property
static <T extends IProperty> List<PropertyOrder<T>>	create(T property1, OrderDirection orderDirection1, T property2, OrderDirection orderDirection2)	Creates a PropertyOrder list
static <T extends IProperty> List<PropertyOrder<T>>	create(T property1, OrderDirection orderDirection1, T property2, OrderDirection orderDirection2, T property3, OrderDirection orderDirection3)	Creates a PropertyOrder list
OrderDirection	getOrderDirection()	Gets the order direction
T	getProperty()	Gets the property

Constructor Details

PropertyOrder

public PropertyOrder(T property)

Constructor

Parameters:

property - the property to order after

API:

This public API is available in IvyScript and Java. It has the visibility ADVANCED.

PropertyOrder

public PropertyOrder(T property,
 OrderDirection orderDirection)

Constructor

Parameters:

property - the property to order after

orderDirection - the order direction

API:

This public API is available in IvyScript and Java. It has the visibility ADVANCED.

Method Details

create

public static <T extends IProperty>
List<PropertyOrder<T>> create(T property)

Creates a PropertyOrder list with one property

Type Parameters:

T - Type of the properties

Parameters:

property - Property

Returns:

List of PropertyOrder

API:

This public API is available in IvyScript and Java. It has the visibility ADVANCED.

create

public static <T extends IProperty>
List<PropertyOrder<T>> create(T property,
 OrderDirection orderDirection)

Creates a PropertyOrder list with one property

Type Parameters:

T - Type of the properties

Parameters:

property - Property

orderDirection - The order diection

Returns:

List of PropertyOrder

API:

This public API is available in IvyScript and Java. It has the visibility ADVANCED.

create

@SafeVarargs
public static <T extends IProperty>
List<PropertyOrder<T>> create(T... properties)

Creates a PropertyOrder list

Type Parameters:

T - Type of the properties

Parameters:

properties - The properties

Returns:

List of PropertyOrder

API:

This public API is available in IvyScript and Java. It has the visibility ADVANCED.

create

public static <T extends IProperty>
List<PropertyOrder<T>> create(T property1,
 OrderDirection orderDirection1,
 T property2,
 OrderDirection orderDirection2)

Creates a PropertyOrder list

Type Parameters:

T - Type of the properties

Parameters:

property1 - First property

orderDirection1 - Order direction for property1

property2 - Second property

orderDirection2 - Order direction for property2

Returns:

List of PropertyOrder

API:

This public API is available in IvyScript and Java. It has the visibility ADVANCED.

create

public static <T extends IProperty>
List<PropertyOrder<T>> create(T property1,
 OrderDirection orderDirection1,
 T property2,
 OrderDirection orderDirection2,
 T property3,
 OrderDirection orderDirection3)

Creates a PropertyOrder list

Type Parameters:

T - Type of the properties

Parameters:

property1 - First property

orderDirection1 - Order direction for property1

property2 - Second property

orderDirection2 - Order direction for property2

property3 - Third property

orderDirection3 - Order direction for property3

Returns:

List of PropertyOrder

API:

This public API is available in IvyScript and Java. It has the visibility ADVANCED.

getProperty

public T getProperty()

Gets the property

Returns:

the property

API:

This public API is available in IvyScript and Java. It has the visibility ADVANCED.

getOrderDirection

public OrderDirection getOrderDirection()

Gets the order direction

Returns:

the orderDirection

API:

This public API is available in IvyScript and Java. It has the visibility ADVANCED.