Interface Subscription

All Superinterfaces:

UtilitiesImpl.PluginSubscription

All Known Implementing Classes:

SubscriptionImpl

public interface Subscription
extends UtilitiesImpl.PluginSubscription

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ADD_TYPE_CREATE
static final int	ADD_TYPE_IMPORT
static final int	ADD_TYPE_LOOKUP
static final int	AZ_VERSION
static final int	VO_FULL
static final int	VO_HIDE_HEADER
static final Object	VUZE_FILE_COMPONENT_SUBSCRIPTION_KEY

Method Summary

Modifier and Type	Method	Description
void	addAssociation(byte[] hash)
void	addListener(SubscriptionListener l)
void	addPotentialAssociation(String result_id, String key)
Subscription	cloneWithNewEngine(Engine engine)
long	getAddTime()
int	getAddType()
int	getAssociationCount()
int	getAZVersion()
long	getCachedPopularity()
String	getCategory()
String	getCreatorRef()
List<Subscription>	getDependsOn()
Engine	getEngine()
String	getExecuteOnNewResult()
SubscriptionResultFilter	getFilters()
int	getHighestVersion()
SubscriptionHistory	getHistory()
String	getID()
String	getJSON()
SubscriptionManager	getManager()
long	getMetadataMutationIndicator()
String	getName()	Returns local name if set
String	getName(boolean use_local)
String	getNameEx()
long	getNewestUnreadResultTime()
long	getNextUpdateTime()
String	getParent()
void	getPopularity(SubscriptionPopularityListener listener)
byte[]	getPublicKey()
String	getQueryKey()
String	getReferer()
SubscriptionResult[]	getResults(boolean include_deleted)	shortcut to help plugin interface
VuzeFile	getSearchTemplateVuzeFile()
String	getString()
long	getTagID()	Tag UID
String	getURI()
Object	getUserData(Object key)
int	getVersion()
int	getViewOptions()
VuzeFile	getVuzeFile()
boolean	hasAssociation(byte[] hash)
boolean	isAnonymous()
boolean	isAutoDownloadSupported()
boolean	isMine()
boolean	isPublic()
boolean	isRemoved()
boolean	isSearchTemplate()
boolean	isSearchTemplateImportable()
boolean	isShareable()
boolean	isSubscribed()
boolean	isSubscriptionTemplate()
boolean	isUpdateable()
void	remove()
void	removeListener(SubscriptionListener l)
void	requestAttention()
void	reset()
void	resetHighestVersion()
void	setCategory(String category)
void	setCreatorRef(String str)
void	setDependsOn(List<Subscription> subs)
boolean	setDetails(String name, boolean is_public, String json)
void	setExecuteOnNewResult(String str)
boolean	setJSON(String json)
void	setLocalName(String str)
void	setName(String str)
void	setParent(String parent)
void	setPublic(boolean is_public)
void	setSubscribed(boolean subscribed)
void	setTagID(long tag_id)
void	setUserData(Object key, Object data)
void	setViewOptions(int options)

Field Details

AZ_VERSION

static final int AZ_VERSION

See Also:

• Constant Field Values

VUZE_FILE_COMPONENT_SUBSCRIPTION_KEY

static final Object VUZE_FILE_COMPONENT_SUBSCRIPTION_KEY

ADD_TYPE_CREATE

static final int ADD_TYPE_CREATE

See Also:

• Constant Field Values

ADD_TYPE_IMPORT

static final int ADD_TYPE_IMPORT

See Also:

• Constant Field Values

ADD_TYPE_LOOKUP

static final int ADD_TYPE_LOOKUP

See Also:

• Constant Field Values

VO_FULL

static final int VO_FULL

See Also:

• Constant Field Values

VO_HIDE_HEADER

static final int VO_HIDE_HEADER

See Also:

• Constant Field Values

Method Details

getName

String getName()

Returns local name if set

Specified by:

getName in interface UtilitiesImpl.PluginSubscription

Returns:

getName

String getName(boolean use_local)

setLocalName

void setLocalName(String str)

setName

void setName(String str)
      throws SubscriptionException

Throws:

SubscriptionException

getNameEx

String getNameEx()

getQueryKey

String getQueryKey()

getID

String getID()

Specified by:

getID in interface UtilitiesImpl.PluginSubscription

getPublicKey

byte[] getPublicKey()

getVersion

int getVersion()

getAddTime

long getAddTime()

getAddType

int getAddType()

getHighestVersion

int getHighestVersion()

resetHighestVersion

void resetHighestVersion()

getAZVersion

int getAZVersion()

isMine

boolean isMine()

isPublic

boolean isPublic()

setPublic

void setPublic(boolean is_public)
        throws SubscriptionException

Throws:

SubscriptionException

isAnonymous

boolean isAnonymous()

isUpdateable

boolean isUpdateable()

isShareable

boolean isShareable()

isSubscriptionTemplate

boolean isSubscriptionTemplate()

getMetadataMutationIndicator

long getMetadataMutationIndicator()

getDependsOn

List<Subscription> getDependsOn()

setDependsOn

void setDependsOn(List<Subscription> subs)

getNewestUnreadResultTime

long getNewestUnreadResultTime()

getNextUpdateTime

long getNextUpdateTime()

getExecuteOnNewResult

String getExecuteOnNewResult()

setExecuteOnNewResult

void setExecuteOnNewResult(String str)

isSearchTemplate

boolean isSearchTemplate()

Specified by:

isSearchTemplate in interface UtilitiesImpl.PluginSubscription

isSearchTemplateImportable

boolean isSearchTemplateImportable()

getSearchTemplateVuzeFile

VuzeFile getSearchTemplateVuzeFile()

getJSON

String getJSON()
        throws SubscriptionException

Throws:

SubscriptionException

setJSON

boolean setJSON(String json)
         throws SubscriptionException

Throws:

SubscriptionException

isSubscribed

boolean isSubscribed()

setSubscribed

void setSubscribed(boolean subscribed)

getPopularity

void getPopularity(SubscriptionPopularityListener listener)
            throws SubscriptionException

Throws:

SubscriptionException

setDetails

boolean setDetails(String name,
 boolean is_public,
 String json)
            throws SubscriptionException

Throws:

SubscriptionException

getReferer

String getReferer()

getCachedPopularity

long getCachedPopularity()

addAssociation

void addAssociation(byte[] hash)

addPotentialAssociation

void addPotentialAssociation(String result_id,
 String key)

getAssociationCount

int getAssociationCount()

hasAssociation

boolean hasAssociation(byte[] hash)

getCategory

String getCategory()

setCategory

void setCategory(String category)

getTagID

long getTagID()

Tag UID

setTagID

void setTagID(long tag_id)

getViewOptions

int getViewOptions()

setViewOptions

void setViewOptions(int options)

getParent

String getParent()

setParent

void setParent(String parent)

getEngine

Engine getEngine()
          throws SubscriptionException

Throws:

SubscriptionException

cloneWithNewEngine

Subscription cloneWithNewEngine(Engine engine)
                         throws SubscriptionException

Throws:

SubscriptionException

isAutoDownloadSupported

boolean isAutoDownloadSupported()

getVuzeFile

VuzeFile getVuzeFile()
              throws SubscriptionException

Throws:

SubscriptionException

setCreatorRef

void setCreatorRef(String str)

getCreatorRef

String getCreatorRef()

reset

void reset()

remove

void remove()

isRemoved

boolean isRemoved()

getManager

SubscriptionManager getManager()

getHistory

SubscriptionHistory getHistory()

getResults

SubscriptionResult[] getResults(boolean include_deleted)

shortcut to help plugin interface

Specified by:

getResults in interface UtilitiesImpl.PluginSubscription

Parameters:

l -

getURI

String getURI()

getFilters

SubscriptionResultFilter getFilters()
                             throws SubscriptionException

Throws:

SubscriptionException

requestAttention

void requestAttention()

addListener

void addListener(SubscriptionListener l)

removeListener

void removeListener(SubscriptionListener l)

setUserData

void setUserData(Object key,
 Object data)

getUserData

Object getUserData(Object key)

getString

String getString()