Package com.biglybt.core.subs
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 int
ADD_TYPE_CREATE
static int
ADD_TYPE_IMPORT
static int
ADD_TYPE_LOOKUP
static int
AZ_VERSION
static int
VO_FULL
static int
VO_HIDE_HEADER
static java.lang.Object
VUZE_FILE_COMPONENT_SUBSCRIPTION_KEY
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addAssociation(byte[] hash)
void
addListener(SubscriptionListener l)
void
addPotentialAssociation(java.lang.String result_id, java.lang.String key)
Subscription
cloneWithNewEngine(Engine engine)
long
getAddTime()
int
getAddType()
int
getAssociationCount()
int
getAZVersion()
long
getCachedPopularity()
java.lang.String
getCategory()
java.lang.String
getCreatorRef()
Engine
getEngine()
SubscriptionResultFilter
getFilters()
int
getHighestVersion()
SubscriptionHistory
getHistory()
java.lang.String
getID()
java.lang.String
getJSON()
SubscriptionManager
getManager()
java.lang.String
getName()
Returns local name if setjava.lang.String
getName(boolean use_local)
java.lang.String
getNameEx()
java.lang.String
getParent()
void
getPopularity(SubscriptionPopularityListener listener)
byte[]
getPublicKey()
java.lang.String
getQueryKey()
java.lang.String
getReferer()
SubscriptionResult[]
getResults(boolean include_deleted)
shortcut to help plugin interfaceVuzeFile
getSearchTemplateVuzeFile()
java.lang.String
getString()
long
getTagID()
Tag UIDjava.lang.String
getURI()
java.lang.Object
getUserData(java.lang.Object key)
int
getVersion()
int
getViewOptions()
VuzeFile
getVuzeFile()
boolean
hasAssociation(byte[] hash)
boolean
isAnonymous()
boolean
isAutoDownloadSupported()
boolean
isMine()
boolean
isPublic()
boolean
isSearchTemplate()
boolean
isSearchTemplateImportable()
boolean
isShareable()
boolean
isSubscribed()
boolean
isUpdateable()
void
remove()
void
removeListener(SubscriptionListener l)
void
requestAttention()
void
reset()
void
resetHighestVersion()
void
setCategory(java.lang.String category)
void
setCreatorRef(java.lang.String str)
boolean
setDetails(java.lang.String name, boolean is_public, java.lang.String json)
boolean
setJSON(java.lang.String json)
void
setLocalName(java.lang.String str)
void
setName(java.lang.String str)
void
setParent(java.lang.String parent)
void
setPublic(boolean is_public)
void
setSubscribed(boolean subscribed)
void
setTagID(long tag_id)
void
setUserData(java.lang.Object key, java.lang.Object data)
void
setViewOptions(int options)
-
-
-
Field Detail
-
AZ_VERSION
static final int AZ_VERSION
- See Also:
- Constant Field Values
-
VUZE_FILE_COMPONENT_SUBSCRIPTION_KEY
static final java.lang.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 Detail
-
getName
java.lang.String getName()
Returns local name if set- Specified by:
getName
in interfaceUtilitiesImpl.PluginSubscription
- Returns:
-
getName
java.lang.String getName(boolean use_local)
-
setLocalName
void setLocalName(java.lang.String str)
-
setName
void setName(java.lang.String str) throws SubscriptionException
- Throws:
SubscriptionException
-
getNameEx
java.lang.String getNameEx()
-
getQueryKey
java.lang.String getQueryKey()
-
getID
java.lang.String getID()
- Specified by:
getID
in interfaceUtilitiesImpl.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()
-
isSearchTemplate
boolean isSearchTemplate()
- Specified by:
isSearchTemplate
in interfaceUtilitiesImpl.PluginSubscription
-
isSearchTemplateImportable
boolean isSearchTemplateImportable()
-
getSearchTemplateVuzeFile
VuzeFile getSearchTemplateVuzeFile()
-
getJSON
java.lang.String getJSON() throws SubscriptionException
- Throws:
SubscriptionException
-
setJSON
boolean setJSON(java.lang.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(java.lang.String name, boolean is_public, java.lang.String json) throws SubscriptionException
- Throws:
SubscriptionException
-
getReferer
java.lang.String getReferer()
-
getCachedPopularity
long getCachedPopularity()
-
addAssociation
void addAssociation(byte[] hash)
-
addPotentialAssociation
void addPotentialAssociation(java.lang.String result_id, java.lang.String key)
-
getAssociationCount
int getAssociationCount()
-
hasAssociation
boolean hasAssociation(byte[] hash)
-
getCategory
java.lang.String getCategory()
-
setCategory
void setCategory(java.lang.String category)
-
getTagID
long getTagID()
Tag UID
-
setTagID
void setTagID(long tag_id)
-
getViewOptions
int getViewOptions()
-
setViewOptions
void setViewOptions(int options)
-
getParent
java.lang.String getParent()
-
setParent
void setParent(java.lang.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(java.lang.String str)
-
getCreatorRef
java.lang.String getCreatorRef()
-
reset
void reset()
-
remove
void remove()
-
getManager
SubscriptionManager getManager()
-
getHistory
SubscriptionHistory getHistory()
-
getResults
SubscriptionResult[] getResults(boolean include_deleted)
shortcut to help plugin interface- Specified by:
getResults
in interfaceUtilitiesImpl.PluginSubscription
- Parameters:
l
-
-
getURI
java.lang.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(java.lang.Object key, java.lang.Object data)
-
getUserData
java.lang.Object getUserData(java.lang.Object key)
-
getString
java.lang.String getString()
-
-