|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 | |
---|---|
void |
checkArguments(IFilterEnvironment env, java.lang.String filterIdentifier, FTValList filterArguments, IReplicate replicateObject) Check validity of arguments for sharing of the asset, using the mapping structure provided. |
void |
describeDerivedAttributes(IFilterEnvironment env, java.lang.String filterIdentifier, FTValList filterArguments, java.lang.String defTypeName, java.lang.String groupDefTypeName, IFilterDescription descriptionObject) Describe all the potential derived attributes, group affinities, and recommendations the filter might set. |
void |
filterAsset(IFilterEnvironment env, java.lang.String filterIdentifier, FTValList filterArguments, IFilterableAssetInstance instance) Perform the filter operation. |
java.lang.String[] |
getArgumentLegalValues(IFilterEnvironment env, java.lang.String filterIdentifier, java.lang.String argumentName) Obtain legal values for a single filter argument. |
void |
getDependencies(IFilterEnvironment env, java.lang.String filterIdentifier, FTValList filterArguments, java.lang.String assetTypeName, java.lang.String groupTypeName, IFilterDependencies filterdeps) Describe the filter's asset dependencies. |
java.lang.String |
getFilterEditURL(IFilterEnvironment env, java.lang.String loginname, java.lang.String filterIdentifier, FTValList filterArguments) Deprecated. |
FTValList |
getLegalArguments(IFilterEnvironment env, java.lang.String filterIdentifier) Obtain the legal filter arguments. |
FTValList |
replicateArguments(IFilterEnvironment env, java.lang.String filterIdentifier, FTValList filterArguments, IReplicate replicateObject) Perform a copy of the arguments, using the mapping structure provided. |
Method Detail |
---|
java.lang.String getFilterEditURL(IFilterEnvironment env, java.lang.String loginname, java.lang.String filterIdentifier, FTValList filterArguments) throws com.openmarket.basic.interfaces.AssetException
com.openmarket.basic.interfaces.AssetException
void filterAsset(IFilterEnvironment env, java.lang.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
void describeDerivedAttributes(IFilterEnvironment env, java.lang.String filterIdentifier, FTValList filterArguments, java.lang.String defTypeName, java.lang.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
void getDependencies(IFilterEnvironment env, java.lang.String filterIdentifier, FTValList filterArguments, java.lang.String assetTypeName, java.lang.String groupTypeName, IFilterDependencies filterdeps) throws com.openmarket.basic.interfaces.AssetException
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.
env
- filter environmentfilterIdentifier
- filter idfilterArguments
- filter parametersassetTypeName
- flex asset typegroupTypeName
- flex parent typefilterdeps
- filter dependenciescom.openmarket.basic.interfaces.AssetException
FTValList getLegalArguments(IFilterEnvironment env, java.lang.String filterIdentifier) throws com.openmarket.basic.interfaces.AssetException
env
- filter environmentfilterIdentifier
- filter idcom.openmarket.basic.interfaces.AssetException
java.lang.String[] getArgumentLegalValues(IFilterEnvironment env, java.lang.String filterIdentifier, java.lang.String argumentName) throws com.openmarket.basic.interfaces.AssetException
env
- filter environmentfilterIdentifier
- filter idargumentName
- filter argumentcom.openmarket.basic.interfaces.AssetException
FTValList replicateArguments(IFilterEnvironment env, java.lang.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
void checkArguments(IFilterEnvironment env, java.lang.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
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.