planetj.dataengine.operation
Class OperationSet

java.lang.Object
  java.util.AbstractCollection
      java.util.AbstractList
          java.util.ArrayList
              planetj.dataengine.operation.OperationSet

All Implemented Interfaces:

java.lang.Cloneable, java.util.Collection, java.util.List, java.util.RandomAccess, java.io.Serializable

public class OperationSet

extends java.util.ArrayList

An OperationSet is a group of Operations which have been grouped together due to common attributes or qualities. Mostly used for display purposes.

See Also:

Serialized Form

Field Summary

static java.util.Comparator	DISPLAY_ORDER_COMPARATOR
static short	OPERATIONS Indicates that the OperationSet objects should contain Operations objects

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

OperationSet()

Method Summary

static OperationSet	getDisplayableOperations(Application application, java.lang.String opSetName, ExecutingContext ec) Get an OperationSet containing the applications displayable operations in the given operation set name.
static java.util.List	getDisplayableOperationSets(Application application, ExecutingContext ec) Get a List containing OperationSet objects.
static java.util.List	getDisplayableOperationSets(java.lang.String displayLocation, Application application, ExecutingContext ec) Get a List containing OperationSet objects.
java.lang.String	getName() Gets the name of this OperationSet
static java.util.List	getOperationSets(Application application) Get a List containing OperationSet objects.
static java.util.List	getOperationSets(java.lang.String displayLocation, Application application) Get a List containing OperationSet objects.
static java.util.List	getOperationSetsInternal(java.lang.String displayLocation, Application application, boolean onlyDisplayable, ExecutingContext ec) Get a List containing OperationSet objects.
boolean	isContainDisplayableOperation(ExecutingContext ec) Test to see if this OperationSet contains an Operation which may be displayable
boolean	isContainSQLOperation() Deprecated. no longer used
void	setName(java.lang.String name) Sets the name of this OperationSet

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, get, indexOf, isEmpty, lastIndexOf, remove, removeRange, set, size, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList

equals, hashCode, iterator, listIterator, listIterator, subList

Methods inherited from class java.util.AbstractCollection

containsAll, remove, removeAll, retainAll, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

containsAll, equals, hashCode, iterator, listIterator, listIterator, remove, removeAll, retainAll, subList

Field Detail

OPERATIONS

public static final short OPERATIONS

Indicates that the OperationSet objects should contain Operations objects

See Also:

Constant Field Values

DISPLAY_ORDER_COMPARATOR

public static final java.util.Comparator DISPLAY_ORDER_COMPARATOR

Constructor Detail

OperationSet

public OperationSet()

Method Detail

getName

public java.lang.String getName()

Gets the name of this OperationSet

getOperationSets

public static java.util.List getOperationSets(Application application)
                                       throws CMException

Get a List containing OperationSet objects. Each OperationSet object will contain the operations for the given Application.

Parameters:

application - Application to get Operations from.

Throws:

CMException

getOperationSets

public static java.util.List getOperationSets(java.lang.String displayLocation,
                                              Application application)
                                       throws CMException

Get a List containing OperationSet objects. Each OperationSet object will contain the operations for the given Application.

Parameters:

application - Application to get Operations from.

Throws:

CMException

getOperationSetsInternal

public static java.util.List getOperationSetsInternal(java.lang.String displayLocation,
                                                      Application application,
                                                      boolean onlyDisplayable,
                                                      ExecutingContext ec)
                                               throws CMException

Get a List containing OperationSet objects. Each OperationSet object will contain the operations for the given Application.

Parameters:

application - Application to get Operations from.

Throws:

CMException

isContainDisplayableOperation

public boolean isContainDisplayableOperation(ExecutingContext ec)

Test to see if this OperationSet contains an Operation which may be displayable

isContainSQLOperation

public boolean isContainSQLOperation()

Deprecated. no longer used

Test to see if this OperationSet contains an Operation with a type of SQL.

setName

public void setName(java.lang.String name)

Sets the name of this OperationSet

getDisplayableOperationSets

public static java.util.List getDisplayableOperationSets(Application application,
                                                         ExecutingContext ec)
                                                  throws CMException

Get a List containing OperationSet objects. Each OperationSet object will contain the operations for the given Application.

Parameters:

application - Application to get Operations from.

Throws:

CMException

getDisplayableOperationSets

public static java.util.List getDisplayableOperationSets(java.lang.String displayLocation,
                                                         Application application,
                                                         ExecutingContext ec)
                                                  throws CMException

Get a List containing OperationSet objects. Each OperationSet object will contain the operations for the given Application.

Parameters:

application - Application to get Operations from.

Throws:

CMException

getDisplayableOperations

public static OperationSet getDisplayableOperations(Application application,
                                                    java.lang.String opSetName,
                                                    ExecutingContext ec)
                                             throws CMException

Get an OperationSet containing the applications displayable operations in the given operation set name.

Parameters:

application - Application to get Operations from.

opSetName - name of operation set to check for displayable operations

ec - current context in which code is being executed

Returns:

OperationSet containing displayable operations

Throws:

CMException