public abstract class WGConfigurableTypeDesignProvider extends java.lang.Object implements WGDesignProvider
initProviderTypes(List)
should be called after the configuration for provided types has been received,
but before the provider is used.Constructor and Description |
---|
WGConfigurableTypeDesignProvider() |
Modifier and Type | Method and Description |
---|---|
abstract void |
addDesignChangeListener(WGDesignChangeListener changeListener)
Adds a listener for design change events, issued by this design provider
If the design provider does not support this then
WGDesignProvider.isNotifying() should return false |
abstract WGDocumentCore |
createDesignDocument(int type,
java.lang.String name,
java.lang.String mediaKey)
Creates the core for a new design document
|
abstract void |
dispose()
Prepares this object to be discarded, giving it the opportunity to clean up resources, references.
|
abstract WGDocumentCore |
getDesignObject(int type,
java.lang.String name,
java.lang.String strMediaKey)
Retrieves a design object by it's doc class and unique name.
|
abstract java.util.List |
getDesignObjects(int type)
Retrieves all design objects of the given doc class.
|
abstract java.lang.String |
getName()
Displays a descriptive name of the type and purpose of this provider, to be displayed in error messages
|
abstract boolean |
isNotifying()
Determines if this design provider notifies it's design change listeners about design changes
|
abstract boolean |
isProviderCore(WGDocumentCore core)
Should determine if the given document core was served by this type of provider.
|
boolean |
providesType(int type)
Determines if this design provider provides designs of this type
|
abstract void |
removeDesignChangeListener(WGDesignChangeListener changeListener)
Removes a listener for design change events
|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
closeSession, designHashCode, getFileEncoding, isSynchronizeAccess, openSession
public abstract java.util.List getDesignObjects(int type) throws WGAPIException
WGDesignProvider
getDesignObjects
in interface WGDesignProvider
type
- The doc class. See constants WGDocument.FDC_...WGAPIException
public abstract WGDocumentCore getDesignObject(int type, java.lang.String name, java.lang.String strMediaKey) throws WGAPIException
WGDesignProvider
getDesignObject
in interface WGDesignProvider
type
- The doc class of the design object. See Constants under WGDocument.FDC_...name
- The unique name of the designstrMediaKey
- For media key specific design objects (e.g. WebTML-Modules), the media key of the design object to be retrievedWGAPIException
public boolean providesType(int type)
WGDesignProvider
providesType
in interface WGDesignProvider
type
- The type. A constant WGDocument.TYPE_...public abstract boolean isProviderCore(WGDocumentCore core)
WGDesignProvider
isProviderCore
in interface WGDesignProvider
core
- The core to testpublic abstract java.lang.String getName()
WGDesignProvider
getName
in interface WGDesignProvider
public abstract WGDocumentCore createDesignDocument(int type, java.lang.String name, java.lang.String mediaKey) throws WGAuthorisationException, WGCreationException
WGDesignProvider
createDesignDocument
in interface WGDesignProvider
type
- Type of document. Constant of WGDocument.TYPE_...name
- Name of new designmediaKey
- Mediakey of new design (for tml modules only. Otherwise provide null)WGAuthorisationException
WGCreationException
public abstract void addDesignChangeListener(WGDesignChangeListener changeListener)
WGDesignProvider
WGDesignProvider.isNotifying()
should return falseaddDesignChangeListener
in interface WGDesignProvider
changeListener
- The listener to addpublic abstract void removeDesignChangeListener(WGDesignChangeListener changeListener)
WGDesignProvider
removeDesignChangeListener
in interface WGDesignProvider
changeListener
- The listener to removepublic abstract void dispose()
WGDesignProvider
dispose
in interface WGDesignProvider
public abstract boolean isNotifying()
WGDesignProvider
isNotifying
in interface WGDesignProvider