com.ibm.tivoli.maximo.oslc.consumer

Class OslcInteractionDesigner

java.lang.Object

com.ibm.tivoli.maximo.oslc.consumer.OslcInteractionDesigner

public class OslcInteractionDesigner
extends java.lang.Object

Designer for oslc interaction.

Author:

Anamitra

Field Summary

Fields

Modifier and Type	Field and Description
static MXLogger	OSLCLOGGER

Constructor Summary

Constructors

Constructor and Description
OslcInteractionDesigner(OslcEndPointData epData, java.lang.String oslcProviderName, java.lang.String resourceType, java.lang.String interactionType, java.lang.String resourceTypeName)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDefaultLinkLabel()
java.lang.String	getDefaultLinkPath()
java.lang.String	getDialogURI(java.lang.String spURI)
java.util.Map<java.lang.String,java.lang.String>	getMatchingServiceProviders(java.lang.String usageURI)
java.lang.String	getOslcLinkType()
ShapeRDFParser	getParsedShape()
boolean	hasShapeInformation()
boolean	isProviderRR(java.lang.String domURI)
boolean	isSingleServiceProvider()
java.util.Set<java.lang.String>	loadUsageURIs()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OSLCLOGGER

public static final MXLogger OSLCLOGGER

Constructor Detail

OslcInteractionDesigner

public OslcInteractionDesigner(OslcEndPointData epData,
                               java.lang.String oslcProviderName,
                               java.lang.String resourceType,
                               java.lang.String interactionType,
                               java.lang.String resourceTypeName)
                        throws MXException,
                               java.rmi.RemoteException

Parameters:

epData - - endpoint details for discovering service providers - either points to the Tivoli service provider registry or to the native listing from oslc provider.

oslcProviderName - the name of the oslc provider.

resourceType - the fully qualified name of the resource type to interact with.

interactionType - the interaction type - CREATIONDIALOG or SELECTIONDIALOG - are the only 2 supported types.

Throws:

MXException

java.rmi.RemoteException

Method Detail

isSingleServiceProvider

public boolean isSingleServiceProvider()

Returns:

true if the discovery URI points to a single service provider document as opposed to a listing/catalog of service providers

loadUsageURIs

public java.util.Set<java.lang.String> loadUsageURIs()
                                              throws java.rmi.RemoteException,
                                                     MXException

Returns:

the set of usage uris for the resource type

Throws:

java.rmi.RemoteException

MXException

isProviderRR

public boolean isProviderRR(java.lang.String domURI)

getMatchingServiceProviders

public java.util.Map<java.lang.String,java.lang.String> getMatchingServiceProviders(java.lang.String usageURI)
                                                                             throws MXException,
                                                                                    java.rmi.RemoteException

Parameters:

usageURIs - the set of user selected usage uris

Returns:

the Map of service provider uri [key] and service provider title [value] that satisfies all of the selected usages of the resource type and the interaction type. This parameter can be null or empty if there were no specific usages of the resource type.

Throws:

MXException

java.rmi.RemoteException

getDefaultLinkPath

public java.lang.String getDefaultLinkPath()

getDefaultLinkLabel

public java.lang.String getDefaultLinkLabel()

getOslcLinkType

public java.lang.String getOslcLinkType()

Returns:

the link type.

getDialogURI

public java.lang.String getDialogURI(java.lang.String spURI)
                              throws MXException

Parameters:

spURI - the matching service provider uri

Returns:

the dialog uri that matches the discovery criterion.

Throws:

MXException

hasShapeInformation

public boolean hasShapeInformation()

getParsedShape

public ShapeRDFParser getParsedShape()