public interface WGDesignProvider
Modifier and Type | Method and Description |
---|---|
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
isNotifying() should return false |
void |
closeSession()
Notifies the design provider of a closed session session, giving it the opportunity to disconnect from backends, do maintenance operations etc.
|
WGDocumentCore |
createDesignDocument(int type,
java.lang.String name,
java.lang.String mediaKey)
Creates the core for a new design document
|
int |
designHashCode()
Provides a unique hashcode representing the design that is served by this provider for comparision purposes
|
void |
dispose()
Prepares this object to be discarded, giving it the opportunity to clean up resources, references.
|
WGDocumentCore |
getDesignObject(int type,
java.lang.String name,
java.lang.String strMediaKey)
Retrieves a design object by it's doc class and unique name.
|
java.util.List |
getDesignObjects(int type)
Retrieves all design objects of the given doc class.
|
java.lang.String |
getFileEncoding()
Returns the supposed text encoding of text files in this design.
|
java.lang.String |
getName()
Displays a descriptive name of the type and purpose of this provider, to be displayed in error messages
|
boolean |
isNotifying()
Determines if this design provider notifies it's design change listeners about design changes
|
boolean |
isProviderCore(WGDocumentCore core)
Should determine if the given document core was served by this type of provider.
|
boolean |
isSynchronizeAccess()
Returns if access to resources from this provider should be synchronized by WGAPI like regular backend accesses.
|
void |
openSession(WGSessionContext context)
Notifies the design provider of a new session, giving it the opportunity to connect to backends, do maintenance operations etc.
|
boolean |
providesType(int type)
Determines if this design provider provides designs of this type
|
void |
removeDesignChangeListener(WGDesignChangeListener changeListener)
Removes a listener for design change events
|
java.util.List getDesignObjects(int type) throws WGAPIException
type
- The doc class. See constants WGDocument.FDC_...WGAPIException
WGDocumentCore getDesignObject(int type, java.lang.String name, java.lang.String strMediaKey) throws WGAPIException
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
boolean providesType(int type)
type
- The type. A constant WGDocument.TYPE_...boolean isProviderCore(WGDocumentCore core)
core
- The core to testjava.lang.String getName()
WGDocumentCore createDesignDocument(int type, java.lang.String name, java.lang.String mediaKey) throws WGAuthorisationException, WGCreationException
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
void addDesignChangeListener(WGDesignChangeListener changeListener)
isNotifying()
should return falsechangeListener
- The listener to addvoid removeDesignChangeListener(WGDesignChangeListener changeListener)
changeListener
- The listener to removevoid dispose()
boolean isNotifying()
void openSession(WGSessionContext context) throws WGBackendException
context
- WGBackendException
void closeSession() throws WGBackendException
WGBackendException
int designHashCode()
boolean isSynchronizeAccess()
java.lang.String getFileEncoding()