de.innovationgate.webgate.api

Class WGConfigurableTypeDesignProvider

java.lang.Object

de.innovationgate.webgate.api.WGConfigurableTypeDesignProvider

All Implemented Interfaces:

WGDesignProvider

public abstract class WGConfigurableTypeDesignProvider
extends java.lang.Object
implements WGDesignProvider

A base class for design providers with internal management of provided document types. Method initProviderTypes(List) should be called after the configuration for provided types has been received, but before the provider is used.

Constructor Summary

Constructors

Constructor and Description
WGConfigurableTypeDesignProvider()

Method Summary

Methods

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.innovationgate.webgate.api.WGDesignProvider

closeSession, designHashCode, getFileEncoding, isSynchronizeAccess, openSession

Constructor Detail

WGConfigurableTypeDesignProvider

public WGConfigurableTypeDesignProvider()

Method Detail

getDesignObjects

public abstract java.util.List getDesignObjects(int type)
                                         throws WGAPIException

Description copied from interface: WGDesignProvider

Retrieves all design objects of the given doc class.

Specified by:

getDesignObjects in interface WGDesignProvider

Parameters:

type - The doc class. See constants WGDocument.FDC_...

Returns:

An unordered list of all design objects for this doc class. An empty list if there are no design objects of that class.

Throws:

WGAPIException

getDesignObject

public abstract WGDocumentCore getDesignObject(int type,
                             java.lang.String name,
                             java.lang.String strMediaKey)
                                        throws WGAPIException

Description copied from interface: WGDesignProvider

Retrieves a design object by it's doc class and unique name.

Specified by:

getDesignObject in interface WGDesignProvider

Parameters:

type - The doc class of the design object. See Constants under WGDocument.FDC_...

name - The unique name of the design

strMediaKey - For media key specific design objects (e.g. WebTML-Modules), the media key of the design object to be retrieved

Returns:

The retrieved design object.

Throws:

WGAPIException

providesType

public boolean providesType(int type)

Description copied from interface: WGDesignProvider

Determines if this design provider provides designs of this type

Specified by:

providesType in interface WGDesignProvider

Parameters:

type - The type. A constant WGDocument.TYPE_...

Returns:

true if the type is provided

isProviderCore

public abstract boolean isProviderCore(WGDocumentCore core)

Description copied from interface: WGDesignProvider

Should determine if the given document core was served by this type of provider. If not determinable this method should return false.

Specified by:

isProviderCore in interface WGDesignProvider

Parameters:

core - The core to test

Returns:

true, if the core was provided by this provider, false if not or not sure

getName

public abstract java.lang.String getName()

Description copied from interface: WGDesignProvider

Displays a descriptive name of the type and purpose of this provider, to be displayed in error messages

Specified by:

getName in interface WGDesignProvider

createDesignDocument

public abstract WGDocumentCore createDesignDocument(int type,
                                  java.lang.String name,
                                  java.lang.String mediaKey)
                                             throws WGAuthorisationException,
                                                    WGCreationException

Description copied from interface: WGDesignProvider

Creates the core for a new design document

Specified by:

createDesignDocument in interface WGDesignProvider

Parameters:

type - Type of document. Constant of WGDocument.TYPE_...

name - Name of new design

mediaKey - Mediakey of new design (for tml modules only. Otherwise provide null)

Throws:

WGAuthorisationException

WGCreationException

addDesignChangeListener

public abstract void addDesignChangeListener(WGDesignChangeListener changeListener)

Description copied from interface: WGDesignProvider

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

Specified by:

addDesignChangeListener in interface WGDesignProvider

Parameters:

changeListener - The listener to add

removeDesignChangeListener

public abstract void removeDesignChangeListener(WGDesignChangeListener changeListener)

Description copied from interface: WGDesignProvider

Removes a listener for design change events

Specified by:

removeDesignChangeListener in interface WGDesignProvider

Parameters:

changeListener - The listener to remove

dispose

public abstract void dispose()

Description copied from interface: WGDesignProvider

Prepares this object to be discarded, giving it the opportunity to clean up resources, references.

Specified by:

dispose in interface WGDesignProvider

isNotifying

public abstract boolean isNotifying()

Description copied from interface: WGDesignProvider

Determines if this design provider notifies it's design change listeners about design changes

Specified by:

isNotifying in interface WGDesignProvider