com.plumtree.server.xui
Interface IService


public interface IService

IService is used to connect to a remote web service, and get the editable properties. These properties are then put through an XSLT transformation for use in a Plumtree page. The most typicaly uses are with editors inside the administrative interface.

IServiceManager is used to create new IService objects.

Author:
danad, Akash Jain
See Also:
IServiceManager

Method Summary
 void Finalize(com.plumtree.openfoundation.util.IXPPropertyBag pPBagSettings)
          Finalize connects to the remote webservice, and finalizes the actions of the wizard.
 IServiceContent GetContent(int lPageNumber, com.plumtree.openfoundation.util.IXPPropertyBag pPBagSettings, java.lang.Object vsaXSLParameters)
          Returns an IServiceContent which can be used to retrieve the content for a particular page.
 java.lang.Object GetContentXML(int lPageNumber, com.plumtree.openfoundation.util.IXPPropertyBag pPBagSettings)
          Returns the content of a given page, without transforming it first.
 java.lang.String GetDescription()
          Get a description of the service.
 java.lang.String GetImageFile()
          Get the Service image file path.
 boolean GetInitialized()
          Set the Service image file path
 java.lang.String GetName()
          Get the name of the service.
 int GetPageCount()
          Services have a particular number of pages that they refer to.
 java.lang.String GetURI()
          Get the Service URI.
 java.lang.String GetWizardPageHelp(int lPageNumber)
          Returns the URI to the help for a particular wizard page.
 java.lang.String GetWizardPageImageFile(int lPageNumber)
          Given a page number, retrieves the image file of the wizard for that page.
 java.lang.String GetWizardPageInstructions(int lPageNumber)
          Retrieves the instructions for the specified page.
 java.lang.String GetWizardPageTitle(int lPageNumber)
          Given a page number, retrieves the title of the wizard for that page.
 java.lang.String GetXSLPath()
          Returns the path to the current XSL file being used for transformations of content.
 void Initialize(com.plumtree.openfoundation.util.IXPPropertyBag pPBagSettings, int lTimeoutSeconds)
          Connects to the remote web service, and initialized the connection.
 void SetDescription(java.lang.String Value)
          Set the description of the service.
 void SetName(java.lang.String Value)
          Set the name of the service.
 void SetURI(java.lang.String Value)
          Set the Service URI
 boolean Validate(int lPageNumber, com.plumtree.openfoundation.util.IXPPropertyBag pPBagSettings)
          Connects to the remote web service and validates the given settings.
 

Method Detail

GetName

java.lang.String GetName()
Get the name of the service.

Returns:
the name

SetName

void SetName(java.lang.String Value)
Set the name of the service.

Parameters:
Value - desired name of the service

GetDescription

java.lang.String GetDescription()
Get a description of the service.

Returns:
the description

SetDescription

void SetDescription(java.lang.String Value)
Set the description of the service.

Parameters:
Value - desired description of the service

GetURI

java.lang.String GetURI()
Get the Service URI.

Returns:
the URI

SetURI

void SetURI(java.lang.String Value)
Set the Service URI

Parameters:
Value - desired Service URI

GetImageFile

java.lang.String GetImageFile()
Get the Service image file path.

Returns:
image file path

GetInitialized

boolean GetInitialized()
Set the Service image file path

Returns:
desired image file path

GetPageCount

int GetPageCount()
Services have a particular number of pages that they refer to. The number of pages is determined when the service is initialized. When requesting content from the service, you must specify a page - if the requested page is outside the bounds of 1-GetPageCount(), the request will fail. In general, PageNumbers are 1-based indexes.

Returns:
total number of pages in the service refers to

GetWizardPageTitle

java.lang.String GetWizardPageTitle(int lPageNumber)
Given a page number, retrieves the title of the wizard for that page.

Parameters:
lPageNumber - page number to get info for
Returns:
String representing the wizard page title

GetWizardPageImageFile

java.lang.String GetWizardPageImageFile(int lPageNumber)
Given a page number, retrieves the image file of the wizard for that page.

Parameters:
lPageNumber - page number to get info for
Returns:
String of the image file's path

GetContent

IServiceContent GetContent(int lPageNumber,
                           com.plumtree.openfoundation.util.IXPPropertyBag pPBagSettings,
                           java.lang.Object vsaXSLParameters)
Returns an IServiceContent which can be used to retrieve the content for a particular page. The IServiceContent interface supports both SCI and Gatewayed HTML content.

Parameters:
lPageNumber - page number of the desired content
pPBagSettings - settings to be passed to the remote web service
vsaXSLParameters - parameters to be passed to the XSL transformer if required
Returns:
IServiceContent representing the content of this page

Validate

boolean Validate(int lPageNumber,
                 com.plumtree.openfoundation.util.IXPPropertyBag pPBagSettings)
Connects to the remote web service and validates the given settings.

Parameters:
lPageNumber - page number to validate settings for
pPBagSettings - settings to be validated
Returns:
true or false depending on the results of the validation

Initialize

void Initialize(com.plumtree.openfoundation.util.IXPPropertyBag pPBagSettings,
                int lTimeoutSeconds)
Connects to the remote web service, and initialized the connection.

Parameters:
pPBagSettings - settings to be passed to the remote web service
lTimeoutSeconds - timeout to connect to the remote web service

GetWizardPageInstructions

java.lang.String GetWizardPageInstructions(int lPageNumber)
Retrieves the instructions for the specified page.

Parameters:
lPageNumber - page number to retrieve instructions for
Returns:
String containing the instructions for the given page

Finalize

void Finalize(com.plumtree.openfoundation.util.IXPPropertyBag pPBagSettings)
Finalize connects to the remote webservice, and finalizes the actions of the wizard. The settings passed in contain the results of the finalize action.

Parameters:
pPBagSettings - settings that will be finalized

GetWizardPageHelp

java.lang.String GetWizardPageHelp(int lPageNumber)
Returns the URI to the help for a particular wizard page.

Parameters:
lPageNumber - page number we desire help for
Returns:
String containing the help URI

GetContentXML

java.lang.Object GetContentXML(int lPageNumber,
                               com.plumtree.openfoundation.util.IXPPropertyBag pPBagSettings)
Returns the content of a given page, without transforming it first. This also means any URL's that require'd being gatewayed were not gatewayed.

Parameters:
lPageNumber - desired page's number
pPBagSettings - settings to pass to the remote service
Returns:
a byte array of the content in XML

GetXSLPath

java.lang.String GetXSLPath()
Returns the path to the current XSL file being used for transformations of content.

Returns:
String with the URI of the XSL file.


Copyright © 2008 Plumtree Software Inc. All Rights Reserved.