Skip navigation links

com.openmarket.gator.interfaces
Interface IFilterableAssetInstance

All Superinterfaces:

com.fatwire.cache.Cacheable, com.openmarket.framework.interfaces.IAbstractBase, com.openmarket.framework.interfaces.IAbstractObject, com.openmarket.xcelerate.interfaces.IAsset

public interface IFilterableAssetInstance

extends com.openmarket.xcelerate.interfaces.IAsset

Interface that provides methods to obtain information about the Flex asset that is the subject of the Flex asset filter. It also contains methods to set derived attributes that are associated with the asset.

Field Summary

Fields inherited from interface com.openmarket.xcelerate.interfaces.IAsset

ACTION_ADD, ACTION_CHANGE, ACTION_MOVETO, ACTION_REMOVE, ALL, ASSETEVENTSTOEXECUTE, CREATEDBY, CREATEDDATE, DESCRIPTION, DOCTYPE, ENDDATE, FILENAME, FWTAGS, LOAD_EDITABLE, LOAD_READONLY, LOAD_READONLY_COMPLETE, LOCALFIELDS, LOCKKEY, m_sStatusCreated, m_sStatusEdited, m_sStatusExpired, m_sStatusPublished, m_sStatusReceived, m_sStatusUpgrade, m_sStatusVoided, NAME, NAMEDASSOCIATION, PATH, PUBLIST, STARTDATE, STATUS, SUBTYPE, TEMPLATE, UID, UNNAMEDASSOCIATION, UPDATEDBY, UPDATEDDATE, URLDOC, URLXMLDOC

Fields inherited from interface com.openmarket.framework.interfaces.IAbstractObject

m_aClassCheckOut1, m_aClassDeleteRevision, m_aClassRollBack1, m_aClassTrack1, m_aClassTrack2, m_aClassUntrack1, m_aClassUntrack2, m_sCheckOutMethod, m_sDeleteRevisionMethod, m_sRollBackMethod, m_sTrackMethod, m_sUntrackMethod

Fields inherited from interface com.openmarket.framework.interfaces.IAbstractBase

m_aClassCreate1, m_aClassCreate2, m_aClassCreate3, m_aClassDeinstall1, m_aClassDeinstall2, m_aClassDeinstall3, m_aClassInstall1, m_aClassInstall2, m_aClassInstall3, m_aClassList1, m_aClassList2, m_aClassList3, m_aClassLoad1, m_aClassLoad10, m_aClassLoad11, m_aClassLoad12, m_aClassLoad13, m_aClassLoad14, m_aClassLoad15, m_aClassLoad16, m_aClassLoad17, m_aClassLoad18, m_aClassLoad19, m_aClassLoad2, m_aClassLoad20, m_aClassLoad21, m_aClassLoad22, m_aClassLoad23, m_aClassLoad24, m_aClassLoad3, m_aClassLoad4, m_aClassLoad5, m_aClassLoad6, m_aClassLoad7, m_aClassLoad8, m_aClassLoad9, m_sCreateMethod, m_sDeinstallMethod, m_sInstallMethod, m_sListMethod, m_sLoadMethod, m_sPrefixSeparator

Method Summary

void	addDerivedDataValue(java.lang.String filterID, java.lang.String attributeID, java.lang.String value) Add a derived data value.
void	addDerivedDataValue(java.lang.String filterID, java.lang.String attributeID, java.lang.String file, byte[] value) Add a derived data value from binary data.
void	addDerivedDataValue(java.lang.String filterID, java.lang.String attributeID, java.lang.String file, FTVAL value) Add a derived data value.
void	addDerivedDataValue(java.lang.String filterID, java.lang.String attributeID, java.lang.String value, java.lang.String ordinal) Add a derived data value with order.
void	addDerivedDataValue(java.lang.String filterID, java.lang.String attributeID, java.lang.String file, java.lang.String ordinal, byte[] value, java.lang.String folder) Add a derived data value from binary data with specified folder.
void	addDerivedDataValue(java.lang.String filterID, java.lang.String attributeID, java.lang.String file, java.lang.String ordinal, FTVAL value, java.lang.String folder) Add a derived data value from binary data with specified folder.
void	addDerivedGroupParent(java.lang.String filterID, java.lang.String groupAssetID) Add a derived group parent.
void	addDerivedRelationship(java.lang.String filterID, java.lang.String relID, java.lang.String assetType, java.lang.String assetID, double confidence) Add a derived relationship for local recommendations (related items).
java.lang.String	get(java.lang.String attr) Returns attribute value.
java.lang.String	getAssetID() Returns the asset's unique identifier.
java.lang.String	getAssetTypeName() Returns the asset's type name.
com.openmarket.basic.interfaces.IListBasic	getAttribute(java.lang.String attributeID) Returns the values for an attribute.
com.openmarket.basic.interfaces.IListBasic	getAttribute(java.lang.String filterID, java.lang.String attributeAssetID) Returns derived attributes from a specific filter only This method is meant to be used by filter code, and returns data in an IList form consistent with the data type of the attribute.
java.lang.String	getGroupTypeName() Returns the corresponding parent type name.
com.openmarket.basic.interfaces.IListBasic	getMergedAttribute(java.lang.String attributeAssetID) Returns the merged attributes - all the values for the attribute, both derived and intrinsic.
java.lang.String	getName() Returns the asset's name.
IList	getParentAssetIDs() Returns a list of the current parent group asset IDs.

Methods inherited from interface com.openmarket.xcelerate.interfaces.IAsset

addChild, addChild, AddMembers, AddSite, AddToAssetPublication, CanBeAssetChild, CanEdit, canTakeAction, ChangeRef, childGather, Children, Cleanup, clearChildren, CopyFixAssetData, CopyFrom, Export, ExportInLists, ExportInXSDSchema, Gather, getAssetAssociationDefs, GetAssetAssociations, getAssetType, getAttributeDefs, GetExportPath, GetExportPath, GetFileName, GetFileName, getLoadOption, GetLockNamesOfRelations, getPubDependencies, getPubDeps, getSiteNames, getSubtype, GetTemplateForTarget, GetTemplatePageName, getUndoCheckOut, Import, isSharedAnySite, LegalChildTypes, LoadAllChildren, LoadAssetPub, mirror, newObject, Read, Read, Read, Read, readBinaryObject, readBinaryObject, ReadRevision, ReferencedBy, removeChild, RemoveMembers, RemoveSite, Reorder, Save, Save, Scatter, SetAssetPubLoaded, SetChildrenLoaded, SetDefaultFolderVariables, SetParent, SetSubtype, setUndoCheckOut, Share, ShareFixAssetData, touch, trackCachedDependencies, TrackDependencies, UpdateAssetPublication, Void, Void, writeBinaryObject, writeBinaryObject

Methods inherited from interface com.openmarket.framework.interfaces.IAbstractObject

CheckIn, GetObjectId, GetObjectType, GetObjectVersion, Read, Read, Read, Read, touch, UndoCheckOut

Methods inherited from interface com.openmarket.framework.interfaces.IAbstractBase

Allocate, Allocate, Delete, Gather, Get, GetBinary, GetByte, GetDouble, GetFloat, GetInteger, GetLong, GetShort, IsEmpty, Scatter, Set, Set, Set

Methods inherited from interface com.fatwire.cache.Cacheable

getCreatedTime, getDeps, getExpireTime

Method Detail

getAssetTypeName

java.lang.String getAssetTypeName()

Returns the asset's type name.

Returns:

asset type

getAssetID

java.lang.String getAssetID()

Returns the asset's unique identifier.

Returns:

asset identifier

getName

java.lang.String getName()

Returns the asset's name.

Returns:

asset name

get

java.lang.String get(java.lang.String attr)

Returns attribute value. Use this method to get standard attributes from the filtered asset.

Parameters:

attr - attribute name

Returns:

attribute value

getGroupTypeName

java.lang.String getGroupTypeName()

Returns the corresponding parent type name.

Returns:

asset type

getAttribute

com.openmarket.basic.interfaces.IListBasic getAttribute(java.lang.String attributeID)

Returns the values for an attribute. This method is meant to be used by filter code, and returns data in an IList form consistent with the data type of the attribute. For instance, String, Integer, Float, and AssetReference attribute types will return the data in the 'value' column, while Blobs and URL columns will return the data in indirect form in a 'urlvalue' column. This ONLY gets non-derived attribute values!

Parameters:

attributeID - attribute id

Returns:

IListBasic of attributes

getAttribute

com.openmarket.basic.interfaces.IListBasic getAttribute(java.lang.String filterID,
                                                        java.lang.String attributeAssetID)

Returns derived attributes from a specific filter only This method is meant to be used by filter code, and returns data in an IList form consistent with the data type of the attribute. For instance, String, Integer, Float, and AssetReference attribute types will return the data in the 'value' column, while Blobs and URL columns will return the data in indirect form in a 'urlvalue' column.

Parameters:

filterID - filter identifier

attributeAssetID - attribute id

Returns:

IListBasic of attributes

getMergedAttribute

com.openmarket.basic.interfaces.IListBasic getMergedAttribute(java.lang.String attributeAssetID)

Returns the merged attributes - all the values for the attribute, both derived and intrinsic.

Parameters:

attributeAssetID - attribute id

Returns:

IListBasic of attributes

getParentAssetIDs

IList getParentAssetIDs()

Returns a list of the current parent group asset IDs.

Returns:

list of parent group asset IDs.

addDerivedGroupParent

void addDerivedGroupParent(java.lang.String filterID,
                           java.lang.String groupAssetID)

Add a derived group parent.

Parameters:

filterID - filter identifier

groupAssetID - asset id of parent

addDerivedDataValue

void addDerivedDataValue(java.lang.String filterID,
                         java.lang.String attributeID,
                         java.lang.String value)

Add a derived data value.

Parameters:

filterID - filter identifier

attributeID - attribute id

value - data

addDerivedDataValue

void addDerivedDataValue(java.lang.String filterID,
                         java.lang.String attributeID,
                         java.lang.String value,
                         java.lang.String ordinal)

Add a derived data value with order.

Parameters:

filterID - filter identifier

attributeID - attribute id

value - data

ordinal - index of position

addDerivedDataValue

void addDerivedDataValue(java.lang.String filterID,
                         java.lang.String attributeID,
                         java.lang.String file,
                         byte[] value)

Add a derived data value from binary data.

Parameters:

filterID - filter identifier

attributeID - attribute id

file - filename

value - data

addDerivedDataValue

void addDerivedDataValue(java.lang.String filterID,
                         java.lang.String attributeID,
                         java.lang.String file,
                         FTVAL value)

Add a derived data value.

Parameters:

filterID - filter identifier

attributeID - attribute id

file - filename

value - data

addDerivedDataValue

void addDerivedDataValue(java.lang.String filterID,
                         java.lang.String attributeID,
                         java.lang.String file,
                         java.lang.String ordinal,
                         byte[] value,
                         java.lang.String folder)

Add a derived data value from binary data with specified folder.

Parameters:

filterID - filter identifier

attributeID - attribute id

file - filename

ordinal - index of position

value - data

folder - folder name

addDerivedDataValue

void addDerivedDataValue(java.lang.String filterID,
                         java.lang.String attributeID,
                         java.lang.String file,
                         java.lang.String ordinal,
                         FTVAL value,
                         java.lang.String folder)

Add a derived data value from binary data with specified folder.

Parameters:

filterID - filter identifier

attributeID - attribute id

file - filename

ordinal - index of position

value - data

folder - folder name

addDerivedRelationship

void addDerivedRelationship(java.lang.String filterID,
                            java.lang.String relID,
                            java.lang.String assetType,
                            java.lang.String assetID,
                            double confidence)

Add a derived relationship for local recommendations (related items).

Parameters:

filterID - filter identifier

relID - recommendation identifier

assetType - asset type for the recommendation

assetID - asset id for the recommendation

confidence - confidence for the recommendation

Skip navigation links