|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IFilter
This class implements the core functionality of 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 AssetException
AssetException
void filterAsset(IFilterEnvironment env, java.lang.String filterIdentifier, FTValList filterArguments, IFilterableAssetInstance instance) throws AssetException
env
- filter environmentfilterIdentifier
- filter idfilterArguments
- filter parametersinstance
- filterable asset instance
AssetException
void describeDerivedAttributes(IFilterEnvironment env, java.lang.String filterIdentifier, FTValList filterArguments, java.lang.String defTypeName, java.lang.String groupDefTypeName, IFilterDescription descriptionObject) throws AssetException
env
- filter environmentfilterIdentifier
- filter idfilterArguments
- filter parametersdefTypeName
- flex definition typegroupDefTypeName
- flex parent definition typedescriptionObject
- filter description
AssetException
void getDependencies(IFilterEnvironment env, java.lang.String filterIdentifier, FTValList filterArguments, java.lang.String assetTypeName, java.lang.String groupTypeName, IFilterDependencies filterdeps) throws AssetException
env
- filter environmentfilterIdentifier
- filter idfilterArguments
- filter parametersassetTypeName
- flex asset typegroupTypeName
- flex parent typefilterdeps
- filter dependencies
AssetException
FTValList getLegalArguments(IFilterEnvironment env, java.lang.String filterIdentifier) throws AssetException
env
- filter environmentfilterIdentifier
- filter id
AssetException
java.lang.String[] getArgumentLegalValues(IFilterEnvironment env, java.lang.String filterIdentifier, java.lang.String argumentName) throws AssetException
env
- filter environmentfilterIdentifier
- filter idargumentName
- filter argument
AssetException
FTValList replicateArguments(IFilterEnvironment env, java.lang.String filterIdentifier, FTValList filterArguments, IReplicate replicateObject) throws AssetException
env
- filter environmentfilterIdentifier
- filter idfilterArguments
- filter parametersreplicateObject
- contains mapping structure
AssetException
void checkArguments(IFilterEnvironment env, java.lang.String filterIdentifier, FTValList filterArguments, IReplicate replicateObject) throws AssetException
env
- filter environmentfilterIdentifier
- filter idfilterArguments
- filter parametersreplicateObject
- contains mapping structure
AssetException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |