Package com.axemble.vdoc.sdk.impl

Class LibrarySubscription

java.lang.Object

com.axemble.vdoc.sdk.impl.LibrarySubscription

All Implemented Interfaces:

IElement, ILibrarySubscription, IProtocolSupport, Serializable

public class LibrarySubscription
extends Object
implements ILibrarySubscription

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
LibrarySubscription(ILibraryElement libraryElement, Boolean isSubscriptionRecursive)

Method Summary

Modifier and Type	Method	Description
IStorageKey	getId()	Gets the identifier object.
ILibraryElement	getLibraryElement()	get the subscribed element
IModule	getModule()	Allows to retrieve the current module.
Object	getNativeObject()	Gets the native object underneath.
String	getPath()	Gets the path of the object.
String	getProtocolURI()
String	getProtocolURI(boolean useNames)
Boolean	isSubscriptionRecursive()	is subscription recursive
boolean	save(IContext context)	Saves or updates the element.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

LibrarySubscription

public LibrarySubscription(ILibraryElement libraryElement,
 Boolean isSubscriptionRecursive)

Method Details

getLibraryElement

public ILibraryElement getLibraryElement()

Description copied from interface: ILibrarySubscription

get the subscribed element

Specified by:

getLibraryElement in interface ILibrarySubscription

Returns:

ILibraryElement

isSubscriptionRecursive

public Boolean isSubscriptionRecursive()

Description copied from interface: ILibrarySubscription

is subscription recursive

Specified by:

isSubscriptionRecursive in interface ILibrarySubscription

Returns:

true if the sub elements are subscribed

getId

public IStorageKey getId()

Description copied from interface: IElement

Gets the identifier object.

Specified by:

getId in interface IElement

Returns:

a IStorageKey object.

getPath

public String getPath()

Description copied from interface: IElement

Gets the path of the object.

Specified by:

getPath in interface IElement

Returns:

a string representing the path of the object.

getNativeObject

public Object getNativeObject()

Description copied from interface: IElement

Gets the native object underneath.

Specified by:

getNativeObject in interface IElement

Returns:

an object.

getModule

public IModule getModule()

Description copied from interface: IElement

Allows to retrieve the current module.

Specified by:

getModule in interface IElement

Returns:

a IModule object.

save

public boolean save(IContext context)

Description copied from interface: IElement

Saves or updates the element.

Specified by:

save in interface IElement

Parameters:

context - The Execution context.

Returns:

return true if succeeded, false otherwise.

getProtocolURI

public String getProtocolURI()

Specified by:

getProtocolURI in interface IProtocolSupport

getProtocolURI

public String getProtocolURI(boolean useNames)

Specified by:

getProtocolURI in interface IProtocolSupport