public interface IFilter
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.
|
String getFilterEditURL(IFilterEnvironment env, String loginname, String filterIdentifier, FTValList filterArguments) throws com.openmarket.basic.interfaces.AssetException
env
- filter environmentloginname
- a loginnamefilterIdentifier
- a filter idfilterArguments
- a filter parameterscom.openmarket.basic.interfaces.AssetException
- an AssetException.void filterAsset(IFilterEnvironment env, String filterIdentifier, FTValList filterArguments, IFilterableAssetInstance instance) throws com.openmarket.basic.interfaces.AssetException
env
- filter environmentfilterIdentifier
- filter idfilterArguments
- filter parametersinstance
- filterable asset instancecom.openmarket.basic.interfaces.AssetException
- an AssetException.void describeDerivedAttributes(IFilterEnvironment env, String filterIdentifier, FTValList filterArguments, String defTypeName, String groupDefTypeName, IFilterDescription descriptionObject) throws com.openmarket.basic.interfaces.AssetException
env
- filter environmentfilterIdentifier
- filter idfilterArguments
- filter parametersdefTypeName
- flex definition typegroupDefTypeName
- flex parent definition typedescriptionObject
- filter descriptioncom.openmarket.basic.interfaces.AssetException
- an AssetException.void getDependencies(IFilterEnvironment env, String filterIdentifier, FTValList filterArguments, String assetTypeName, String groupTypeName, IFilterDependencies filterdeps) throws com.openmarket.basic.interfaces.AssetException
env
- filter environmentfilterIdentifier
- filter idfilterArguments
- filter parametersassetTypeName
- flex asset typegroupTypeName
- flex parent typefilterdeps
- filter dependenciescom.openmarket.basic.interfaces.AssetException
- an AssetException.FTValList getLegalArguments(IFilterEnvironment env, String filterIdentifier) throws com.openmarket.basic.interfaces.AssetException
env
- filter environmentfilterIdentifier
- filter idcom.openmarket.basic.interfaces.AssetException
- an AssetException.String[] getArgumentLegalValues(IFilterEnvironment env, String filterIdentifier, String argumentName) throws com.openmarket.basic.interfaces.AssetException
env
- filter environmentfilterIdentifier
- filter idargumentName
- filter argumentcom.openmarket.basic.interfaces.AssetException
- an AssetException.FTValList replicateArguments(IFilterEnvironment env, String filterIdentifier, FTValList filterArguments, IReplicate replicateObject) throws com.openmarket.basic.interfaces.AssetException
env
- filter environmentfilterIdentifier
- filter idfilterArguments
- filter parametersreplicateObject
- contains mapping structurecom.openmarket.basic.interfaces.AssetException
- an AssetException.void checkArguments(IFilterEnvironment env, String filterIdentifier, FTValList filterArguments, IReplicate replicateObject) throws com.openmarket.basic.interfaces.AssetException
env
- filter environmentfilterIdentifier
- filter idfilterArguments
- filter parametersreplicateObject
- contains mapping structurecom.openmarket.basic.interfaces.AssetException
- an AssetException.