com.tle.core.payment.scripting.objects
Interface CatalogueScriptObject
Declaration: public interface CatalogueScriptObject extends ScriptObject
All Superinterfaces: ScriptObject, java.io.Serializable

 

Available in scripts as the 'catalogue' variable

 

 

Fields Summary
static java.lang.String DEFAULT_VARIABLE
    

 

 

Methods Summary
abstract void addToBlacklist(CatalogueScriptType catalogue)
     Add the current item to the blacklist of the supplied catalogue
abstract void addToWhitelist(CatalogueScriptType catalogue)
     Add the current item to the whitelist of the supplied catalogue
abstract CatalogueScriptType getCatalogueByUuid(java.lang.String uuid)
     Get a catalogue by UUID
abstract java.util.List<CatalogueScriptType> listAllCatalogues()
     Return all catalogues in the system (enabled or otherwise)
abstract java.util.List<CatalogueScriptType> listBlacklistCatalogues()
     The list of catalogues this item appears in due to being added to the blacklist
abstract java.util.List<CatalogueScriptType> listDynamicCatalogues()
     The list of catalogues this item appears in due to being found in the associated dynamic collection
abstract java.util.List<CatalogueScriptType> listWhitelistCatalogues()
     The list of catalogues this item appears in due to being added to the whitelist
abstract void removeFromBlacklist(CatalogueScriptType catalogue)
     Remove the current item from the whitelist of the supplied catalogue
abstract void removeFromWhitelist(CatalogueScriptType catalogue)
     Remove the current item from the whitelist of the supplied catalogue.

 

Methods inherited from interface: com.tle.common.scripting.ScriptObject
scriptEnter, scriptExit

 

 

 

 

DEFAULT_VARIABLE

 

public static final java.lang.String DEFAULT_VARIABLE

 

See also: Constants

 

 

 

 

listAllCatalogues

 

public abstract java.util.List<CatalogueScriptType> listAllCatalogues( )

 

Return all catalogues in the system (enabled or otherwise)

 

 

 

listWhitelistCatalogues

 

public abstract java.util.List<CatalogueScriptType> listWhitelistCatalogues( )

 

The list of catalogues this item appears in due to being added to the whitelist

 

 

 

listBlacklistCatalogues

 

public abstract java.util.List<CatalogueScriptType> listBlacklistCatalogues( )

 

The list of catalogues this item appears in due to being added to the blacklist

 

 

 

listDynamicCatalogues

 

public abstract java.util.List<CatalogueScriptType> listDynamicCatalogues( )

 

The list of catalogues this item appears in due to being found in the associated dynamic collection

 

 

 

addToWhitelist

 

public abstract void addToWhitelist( CatalogueScriptType catalogue)

 

Add the current item to the whitelist of the supplied catalogue

 

Parameters:
catalogue-
The catalogue to add to

 

 

 

addToBlacklist

 

public abstract void addToBlacklist( CatalogueScriptType catalogue)

 

Add the current item to the blacklist of the supplied catalogue

 

Parameters:
catalogue-
The catalogue to exclude from

 

 

 

removeFromWhitelist

 

public abstract void removeFromWhitelist( CatalogueScriptType catalogue)

 

Remove the current item from the whitelist of the supplied catalogue. Note that the item may still appear in the catalogue if it matches the dynamic collection of the catalogue. Use addToBlacklist to exclude from the catalogue.

 

Parameters:
catalogue-
The catalogue to remove from manual additions

 

 

 

removeFromBlacklist

 

public abstract void removeFromBlacklist( CatalogueScriptType catalogue)

 

Remove the current item from the whitelist of the supplied catalogue

 

Parameters:
catalogue-
The catalogue to un-exclude from

 

 

 

getCatalogueByUuid

 

public abstract CatalogueScriptType getCatalogueByUuid( java.lang.String uuid)

 

Get a catalogue by UUID

 

Parameters:
uuid-
The UUID of the catalogue to obtain
Returns:
The catalogue with the UUID of uuid, or null if no match