|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
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 |
---|
java.lang.String GetName()
void SetName(java.lang.String Value)
Value
- desired name of the servicejava.lang.String GetDescription()
void SetDescription(java.lang.String Value)
Value
- desired description of the servicejava.lang.String GetURI()
void SetURI(java.lang.String Value)
Value
- desired Service URIjava.lang.String GetImageFile()
boolean GetInitialized()
int GetPageCount()
java.lang.String GetWizardPageTitle(int lPageNumber)
lPageNumber
- page number to get info for
java.lang.String GetWizardPageImageFile(int lPageNumber)
lPageNumber
- page number to get info for
IServiceContent GetContent(int lPageNumber, com.plumtree.openfoundation.util.IXPPropertyBag pPBagSettings, java.lang.Object vsaXSLParameters)
lPageNumber
- page number of the desired contentpPBagSettings
- settings to be passed to the remote web servicevsaXSLParameters
- parameters to be passed to the XSL transformer if required
boolean Validate(int lPageNumber, com.plumtree.openfoundation.util.IXPPropertyBag pPBagSettings)
lPageNumber
- page number to validate settings forpPBagSettings
- settings to be validated
void Initialize(com.plumtree.openfoundation.util.IXPPropertyBag pPBagSettings, int lTimeoutSeconds)
pPBagSettings
- settings to be passed to the remote web servicelTimeoutSeconds
- timeout to connect to the remote web servicejava.lang.String GetWizardPageInstructions(int lPageNumber)
lPageNumber
- page number to retrieve instructions for
void Finalize(com.plumtree.openfoundation.util.IXPPropertyBag pPBagSettings)
pPBagSettings
- settings that will be finalizedjava.lang.String GetWizardPageHelp(int lPageNumber)
lPageNumber
- page number we desire help for
java.lang.Object GetContentXML(int lPageNumber, com.plumtree.openfoundation.util.IXPPropertyBag pPBagSettings)
lPageNumber
- desired page's numberpPBagSettings
- settings to pass to the remote service
java.lang.String GetXSLPath()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |