Class ResourceTemplate

java.lang.Object
  |
  +--ResourceTemplate

public class ResourceTemplate

extends java.lang.Object

When a plugin wants to publish a resource it needs to create a ResourceTemplate object and then pass it to the framework.

The framework provides a method to create a ResourceTemplate, so most of the time it should not be necessary to handle ResourceTemplate objects

For example:

Vector resources = new Vector();
resources.add(clientInstance.CreateResourceTemplate(PluginID, 0, 10, "O's and X's", "Game Player"));

Constructor Summary

ResourceTemplate(int resourceid, int mediaid, int pluginid, java.lang.String name, java.lang.String description)

Method Summary

java.lang.String

toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ResourceTemplate

public ResourceTemplate(int resourceid,
int mediaid,
int pluginid,
java.lang.String name,
java.lang.String description)

Constructor for the ResourceTemplate class, where:

resourceid - represents the ID of the resource within the providing plugin
mediaid - represents the ID of the MediaType that this resource represents
pluginid - represents the ID of the plugin that is providing the resource
name - represents the name of the resource (e.g., filename)
description - represents a short description of the resource

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

This method returns the contents of the ResourceTemplate object as a flat string