com.openmarket.gator.interfaces

Interface IFilter

All Known Implementing Classes:

AbstractFlexFilter

public interface IFilter

Provides core functionality for a Flex Filter. Implementations are required to have a single-argument public constructor that expects a COM.FutureTense.Interfaces.FTValList object. The FTValList provided by the caller is the full set of configuration arguments that were registered when the Filter was instantiated through the UI. Any implementation must be thread-safe.

Method Summary

Modifier and Type	Method and Description
void	checkArguments(IFilterEnvironment env, String filterIdentifier, FTValList filterArguments, IReplicate replicateObject) Check validity of arguments for sharing of the asset, using the mapping structure provided.
void	describeDerivedAttributes(IFilterEnvironment env, String filterIdentifier, FTValList filterArguments, String defTypeName, String groupDefTypeName, IFilterDescription descriptionObject) Describe all the potential derived attributes, group affinities, and recommendations the filter might set.
void	filterAsset(IFilterEnvironment env, String filterIdentifier, FTValList filterArguments, IFilterableAssetInstance instance) Perform the filter operation.
String[]	getArgumentLegalValues(IFilterEnvironment env, String filterIdentifier, String argumentName) Obtain legal values for a single filter argument.
void	getDependencies(IFilterEnvironment env, String filterIdentifier, FTValList filterArguments, String assetTypeName, String groupTypeName, IFilterDependencies filterdeps) Describe the filter's asset dependencies.
String	getFilterEditURL(IFilterEnvironment env, String loginname, String filterIdentifier, FTValList filterArguments) Deprecated.
FTValList	getLegalArguments(IFilterEnvironment env, String filterIdentifier) Obtain the legal filter arguments.
FTValList	replicateArguments(IFilterEnvironment env, String filterIdentifier, FTValList filterArguments, IReplicate replicateObject) Perform a copy of the arguments, using the mapping structure provided.

Method Detail

getFilterEditURL

String getFilterEditURL(IFilterEnvironment env,
                        String loginname,
                        String filterIdentifier,
                        FTValList filterArguments)
                 throws com.openmarket.basic.interfaces.AssetException

Deprecated.

This deprecated method should be implemented to return null.

Parameters:

env - filter environment

loginname - a loginname

filterIdentifier - a filter id

filterArguments - a filter parameters

Returns:

a null value

Throws:

com.openmarket.basic.interfaces.AssetException - an AssetException.

filterAsset

void filterAsset(IFilterEnvironment env,
                 String filterIdentifier,
                 FTValList filterArguments,
                 IFilterableAssetInstance instance)
          throws com.openmarket.basic.interfaces.AssetException

Perform the filter operation. All changes should occur to the filterable asset instance.

Parameters:

env - filter environment

filterIdentifier - filter id

filterArguments - filter parameters

instance - filterable asset instance

Throws:

com.openmarket.basic.interfaces.AssetException - an AssetException.

describeDerivedAttributes

void describeDerivedAttributes(IFilterEnvironment env,
                               String filterIdentifier,
                               FTValList filterArguments,
                               String defTypeName,
                               String groupDefTypeName,
                               IFilterDescription descriptionObject)
                        throws com.openmarket.basic.interfaces.AssetException

Describe all the potential derived attributes, group affinities, and recommendations the filter might set.

Parameters:

env - filter environment

filterIdentifier - filter id

filterArguments - filter parameters

defTypeName - flex definition type

groupDefTypeName - flex parent definition type

descriptionObject - filter description

Throws:

com.openmarket.basic.interfaces.AssetException - an AssetException.

getDependencies

void getDependencies(IFilterEnvironment env,
                     String filterIdentifier,
                     FTValList filterArguments,
                     String assetTypeName,
                     String groupTypeName,
                     IFilterDependencies filterdeps)
              throws com.openmarket.basic.interfaces.AssetException

Describe the filter's asset dependencies. NOTE: This method is meant for static sorts of dependencies only. For example, dependencies should be logged on all attributes that are looked up by name or id - these are essentially references to the attribute. Dependencies that are logged here are logged against the asset instance that would be filtered, rather than the filter asset. This permits the dependencies to be localized by assetTypeName and groupTypeName.

Parameters:

env - filter environment

filterIdentifier - filter id

filterArguments - filter parameters

assetTypeName - flex asset type

groupTypeName - flex parent type

filterdeps - filter dependencies

Throws:

com.openmarket.basic.interfaces.AssetException - an AssetException.

getLegalArguments

FTValList getLegalArguments(IFilterEnvironment env,
                            String filterIdentifier)
                     throws com.openmarket.basic.interfaces.AssetException

Obtain the legal filter arguments.

Parameters:

env - filter environment

filterIdentifier - filter id

Returns:

legal filter arugments

Throws:

com.openmarket.basic.interfaces.AssetException - an AssetException.

getArgumentLegalValues

String[] getArgumentLegalValues(IFilterEnvironment env,
                                String filterIdentifier,
                                String argumentName)
                         throws com.openmarket.basic.interfaces.AssetException

Obtain legal values for a single filter argument. A null return indicates that any value is legal.

Parameters:

env - filter environment

filterIdentifier - filter id

argumentName - filter argument

Returns:

valid values for the argument

Throws:

com.openmarket.basic.interfaces.AssetException - an AssetException.

replicateArguments

FTValList replicateArguments(IFilterEnvironment env,
                             String filterIdentifier,
                             FTValList filterArguments,
                             IReplicate replicateObject)
                      throws com.openmarket.basic.interfaces.AssetException

Perform a copy of the arguments, using the mapping structure provided.

Parameters:

env - filter environment

filterIdentifier - filter id

filterArguments - filter parameters

replicateObject - contains mapping structure

Returns:

new arguments after replication

Throws:

com.openmarket.basic.interfaces.AssetException - an AssetException.

checkArguments

void checkArguments(IFilterEnvironment env,
                    String filterIdentifier,
                    FTValList filterArguments,
                    IReplicate replicateObject)
             throws com.openmarket.basic.interfaces.AssetException

Check validity of arguments for sharing of the asset, using the mapping structure provided.

Parameters:

env - filter environment

filterIdentifier - filter id

filterArguments - filter parameters

replicateObject - contains mapping structure

Throws:

com.openmarket.basic.interfaces.AssetException - an AssetException.