de.innovationgate.webgate.api

Interface WGExtensionDataContainer

All Known Subinterfaces:

WGDocumentCore

All Known Implementing Classes:

BeanFolder, BeanWrapper, MapWrapper, WGArea, WGContent, WGContentType, WGCSSJSModule, WGDatabase, WGDesignDocument, WGDesignResourceDocument, WGDocument, WGDocumentCoreWrapper, WGDocumentImpl, WGDocumentImplRSS1, WGDummyContent, WGFakeArea, WGFakeContentType, WGFakeDocument, WGFakeLanguage, WGFakeStructEntry, WGFakeTML, WGFakeUserProfile, WGFileContainer, WGFileDerivateMetaData, WGFileMetaData, WGLanguage, WGSchemaDocument, WGScriptModule, WGStructEntry, WGTMLModule, WGUserProfile, WrappedKey

public interface WGExtensionDataContainer

Interface for all entities that may hold extension data fields

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	getExtensionData(java.lang.String strName) Returns the value of an extension data field.
java.util.List<java.lang.String>	getExtensionDataNames() Returns the names of all extension data fields on this entity
void	removeExtensionData(java.lang.String strName) Removes an extension data field from this entity
void	writeExtensionData(java.lang.String strName, java.lang.Object value) Sets the value of an extension data field.

Method Detail

getExtensionData

java.lang.Object getExtensionData(java.lang.String strName)
                                  throws WGAPIException

Returns the value of an extension data field.

Parameters:

strName - Name of the requested field.

Returns:

Object

Throws:

WGAPIException

writeExtensionData

void writeExtensionData(java.lang.String strName,
                      java.lang.Object value)
                        throws WGAPIException

Sets the value of an extension data field.

Parameters:

strName - Name of the requested field.

value - The value of the field

Throws:

WGAPIException

getExtensionDataNames

java.util.List<java.lang.String> getExtensionDataNames()
                                                       throws WGAPIException

Returns the names of all extension data fields on this entity

Throws:

WGBackendException

WGAPIException

removeExtensionData

void removeExtensionData(java.lang.String strName)
                         throws WGAPIException

Removes an extension data field from this entity

Parameters:

strName - Name of the field to remove.

Throws:

WGAPIException