public abstract class AbstractFlexFilter extends Object implements IFilter
IFilter
interface should be used instead.Constructor and Description |
---|
AbstractFlexFilter(FTValList ftvallist)
Implementations are required to have a single-argument public constructor that expects a COM.FutureTense.Interfaces.FTValList object.
|
Modifier and Type | Method and Description |
---|---|
void |
checkArguments(IFilterEnvironment env, String filterIdentifier, FTValList filterArguments, IReplicate replicateObject)
Check validity of arguments for share, using the mapping structure provided.
|
void |
describeDerivedAttributes(IFilterEnvironment env, String filterIdentifier, FTValList filterArguments, String defTypeName, String parentDefTypeName, IFilterDescription descriptionObject)
Describe all the potential derived attributes, parent affinities, and recommendations the filter might set.
|
abstract 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.
|
String |
getAttrID(IFilterEnvironment ifilterenvironment, FTValList ftValList, String argname)
This is a helper to return the attribute asset ID for a specific attribute that was passed to the filter as an attribute argument.
|
void |
getDependencies(IFilterEnvironment env, String filterIdentifier, FTValList filterArguments, String assetTypeName, String parentTypeName, IFilterDependencies filterdeps)
Describe the filter's asset dependencies.
|
String |
getFilterEditURL(IFilterEnvironment env, String loginname, String filterIdentifier, FTValList filterArguments)
This method is depreciated and is implemented to return null.
|
abstract 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.
|
public AbstractFlexFilter(FTValList ftvallist)
ftvallist
- a ftvallistpublic String getFilterEditURL(IFilterEnvironment env, String loginname, String filterIdentifier, FTValList filterArguments) throws com.openmarket.basic.interfaces.AssetException
getFilterEditURL
in interface IFilter
env
- filter environmentloginname
- a loginnamefilterIdentifier
- filter idfilterArguments
- filter parameterscom.openmarket.basic.interfaces.AssetException
- an AssetException.public abstract void filterAsset(IFilterEnvironment env, String filterIdentifier, FTValList filterArguments, IFilterableAssetInstance instance) throws com.openmarket.basic.interfaces.AssetException
filterAsset
in interface IFilter
env
- filter environmentinstance
- filterable asset instancefilterIdentifier
- filter idfilterArguments
- filter parameterscom.openmarket.basic.interfaces.AssetException
- an AssetException.public void describeDerivedAttributes(IFilterEnvironment env, String filterIdentifier, FTValList filterArguments, String defTypeName, String parentDefTypeName, IFilterDescription descriptionObject) throws com.openmarket.basic.interfaces.AssetException
describeDerivedAttributes
in interface IFilter
env
- filter environmentdefTypeName
- flex definition typefilterIdentifier
- filter idfilterArguments
- filter parametersparentDefTypeName
- a filterArgumentsdescriptionObject
- filter descriptioncom.openmarket.basic.interfaces.AssetException
- an AssetException.public void getDependencies(IFilterEnvironment env, String filterIdentifier, FTValList filterArguments, String assetTypeName, String parentTypeName, IFilterDependencies filterdeps) throws com.openmarket.basic.interfaces.AssetException
getDependencies
in interface IFilter
env
- filter environmentassetTypeName
- flex asset typefilterIdentifier
- filter idfilterArguments
- filter parametersparentTypeName
- a parentTypeNamefilterdeps
- filter dependenciescom.openmarket.basic.interfaces.AssetException
- an AssetException.public abstract FTValList getLegalArguments(IFilterEnvironment env, String filterIdentifier) throws com.openmarket.basic.interfaces.AssetException
getLegalArguments
in interface IFilter
env
- filter environmentfilterIdentifier
- filter idcom.openmarket.basic.interfaces.AssetException
- an AssetException.public String[] getArgumentLegalValues(IFilterEnvironment env, String filterIdentifier, String argumentName) throws com.openmarket.basic.interfaces.AssetException
getArgumentLegalValues
in interface IFilter
env
- filter environmentfilterIdentifier
- filter idargumentName
- argument namecom.openmarket.basic.interfaces.AssetException
- an AssetException.public FTValList replicateArguments(IFilterEnvironment env, String filterIdentifier, FTValList filterArguments, IReplicate replicateObject) throws com.openmarket.basic.interfaces.AssetException
replicateArguments
in interface IFilter
env
- filter environmentfilterIdentifier
- filter idfilterArguments
- filter parametersreplicateObject
- contains mapping structurecom.openmarket.basic.interfaces.AssetException
- an AssetException.public void checkArguments(IFilterEnvironment env, String filterIdentifier, FTValList filterArguments, IReplicate replicateObject) throws com.openmarket.basic.interfaces.AssetException
checkArguments
in interface IFilter
env
- filter environmentfilterIdentifier
- filter idfilterArguments
- filter parametersreplicateObject
- contains mapping structurecom.openmarket.basic.interfaces.AssetException
- an AssetException.public String getAttrID(IFilterEnvironment ifilterenvironment, FTValList ftValList, String argname) throws com.openmarket.basic.interfaces.AssetException
ifilterenvironment
- a ifilterenvironmentftValList
- a ftValListargname
- argnamecom.openmarket.basic.interfaces.AssetException
- on exception