Skip navigation links

waggle.common.modules.opensocial
Interface XOSModule.Server

All Superinterfaces:

XAPIInterface, XAPIInterface.Server

Enclosing interface:

XOSModule

public static interface XOSModule.Server

extends XAPIInterface.Server

Server interface for the OpenSocial Module API.

Nested Class Summary

Nested classes/interfaces inherited from interface waggle.core.api.XAPIInterface

XAPIInterface.Client, XAPIInterface.Server

Method Summary

XObjectID	createFeature(String featureName, String featureVersion) Upload a Feature file.
XObjectID	createFeatureFile(XObjectID featureID, String name, XAPIInputStream inputStream, String mimeType, long length) Add a new Feature File.
XObjectID	createGadget(String gadgetName, XAPIInputStream inputStream, String mimeType, long length, XUpdater updater) Create a Gadget.
void	deleteFeature(XObjectID featureID) Delete a Feature.
void	deleteFeatureFile(XObjectID featureFileID) Delete a Feature File.
void	deleteGadget(XObjectID gadgetID) Delete a Gadget.
List<XOSGadgetInfo>	getAllAvailableGadgets() Get all available Gadgets.
List<XDocumentInfo>	getAllFeatureFiles(XObjectID featureID) Get all Feature Files in order for a Feature.
List<XOSFeatureInfo>	getAllFeatures() Get all defined Features.
List<XOSGadgetInfo>	getAllGadgets() Get all defined Gadgets.
XOSFeatureInfo	getFeature(XObjectID featureID) Get a Feature.
XOSGadgetInfo	getGadget(XObjectID gadgetID) Get a Gadget.
List<XOSUserPrefInfo>	getGadgetUserPrefs(XObjectID gadgetID) Get UserPrefs for a Gadget.
void	moveFeatureFileDown(XObjectID featureFileID) Move a Feature File down one slot.
void	moveFeatureFileUp(XObjectID featureFileID) Move a Feature File up one slot.
void	setFeatureFileName(XObjectID featureFileID, String name) Set a Feature File name.
void	setFeatureName(XObjectID featureID, String featureName) Set a Feature's name.
void	setFeatureVersion(XObjectID featureID, String featureVersion) Set a Feature's version.
void	setGadgetName(XObjectID gadgetID, String gadgetName) Set a Gadget's name.
void	updateFeatureFile(XObjectID featureFileID, String name, XAPIInputStream inputStream, String mimeType, long length) Upload a new Feature File version.
void	updateGadget(XObjectID gadgetID, XUpdater updater) Update a Gadget.
void	uploadGadget(XObjectID gadgetID, XAPIInputStream inputStream, String mimeType, long length) Upload a new Gadget file version.

Method Detail

createGadget

XObjectID createGadget(String gadgetName,
                       XAPIInputStream inputStream,
                       String mimeType,
                       long length,
                       XUpdater updater)

Create a Gadget.

Parameters:

gadgetName - The Gadget name.

inputStream - The input stream.

mimeType - The mime type.

length - The length.

updater - An updater.

Returns:

The Gadget ID.

updateGadget

void updateGadget(XObjectID gadgetID,
                  XUpdater updater)

Update a Gadget.

Parameters:

gadgetID - The Gadget.

updater - The updater.

uploadGadget

void uploadGadget(XObjectID gadgetID,
                  XAPIInputStream inputStream,
                  String mimeType,
                  long length)

Upload a new Gadget file version.

Parameters:

gadgetID - The Gadget.

inputStream - The input stream.

mimeType - The mime type.

length - The length.

deleteGadget

void deleteGadget(XObjectID gadgetID)

Delete a Gadget.

Parameters:

gadgetID - The Gadget.

getGadget

XOSGadgetInfo getGadget(XObjectID gadgetID)

Get a Gadget.

Parameters:

gadgetID - The Gadget.

Returns:

The Gadget info.

getAllGadgets

List<XOSGadgetInfo> getAllGadgets()

Get all defined Gadgets.

Returns:

All defined Gadget infos.

getAllAvailableGadgets

List<XOSGadgetInfo> getAllAvailableGadgets()

Get all available Gadgets.

Returns:

All available Gadget infos.

setGadgetName

void setGadgetName(XObjectID gadgetID,
                   String gadgetName)

Set a Gadget's name.

Parameters:

gadgetID - The Gadget.

gadgetName - The Gadget's name.

getGadgetUserPrefs

List<XOSUserPrefInfo> getGadgetUserPrefs(XObjectID gadgetID)

Get UserPrefs for a Gadget.

Parameters:

gadgetID - The Gadget.

Returns:

The user preferences.

createFeature

XObjectID createFeature(String featureName,
                        String featureVersion)

Upload a Feature file.

Parameters:

featureName - The Feature name.

featureVersion - The Feature version.

Returns:

The Feature ID.

getFeature

XOSFeatureInfo getFeature(XObjectID featureID)

Get a Feature.

Parameters:

featureID - The Feature.

Returns:

The Feature info.

getAllFeatures

List<XOSFeatureInfo> getAllFeatures()

Get all defined Features.

Returns:

All Feature infos.

setFeatureName

void setFeatureName(XObjectID featureID,
                    String featureName)

Set a Feature's name.

Parameters:

featureID - The Feature.

featureName - The Feature's name.

setFeatureVersion

void setFeatureVersion(XObjectID featureID,
                       String featureVersion)

Set a Feature's version.

Parameters:

featureID - The Feature.

featureVersion - The Feature's version.

deleteFeature

void deleteFeature(XObjectID featureID)

Delete a Feature.

Parameters:

featureID - The Feature.

createFeatureFile

XObjectID createFeatureFile(XObjectID featureID,
                            String name,
                            XAPIInputStream inputStream,
                            String mimeType,
                            long length)

Add a new Feature File.

Parameters:

featureID - The Feature.

name - The file name.

inputStream - The input stream.

mimeType - The mime type.

length - The length.

Returns:

The Feature File ID.

updateFeatureFile

void updateFeatureFile(XObjectID featureFileID,
                       String name,
                       XAPIInputStream inputStream,
                       String mimeType,
                       long length)

Upload a new Feature File version.

Parameters:

featureFileID - The Feature File.

name - The file name.

inputStream - The input stream.

mimeType - The mime type.

length - The length.

setFeatureFileName

void setFeatureFileName(XObjectID featureFileID,
                        String name)

Set a Feature File name.

Parameters:

featureFileID - The Feature File.

name - The new name.

moveFeatureFileUp

void moveFeatureFileUp(XObjectID featureFileID)

Move a Feature File up one slot.

Parameters:

featureFileID - The Feature File.

moveFeatureFileDown

void moveFeatureFileDown(XObjectID featureFileID)

Move a Feature File down one slot.

Parameters:

featureFileID - The Feature File.

getAllFeatureFiles

List<XDocumentInfo> getAllFeatureFiles(XObjectID featureID)

Get all Feature Files in order for a Feature.

Parameters:

featureID - The Feature.

Returns:

The Feature Files in order.

deleteFeatureFile

void deleteFeatureFile(XObjectID featureFileID)

Delete a Feature File.

Parameters:

featureFileID - The Feature File.

Skip navigation links