com.sap.portal.obn.service

Class OBNFactory

java.lang.Object
  com.sap.portal.obn.service.OBNFactory

public abstract class OBNFactory
extends Object

The factory class that creates basic OBN-related objects.

Constructor Summary

OBNFactory()

Method Summary

abstract ComplexComparator	createComplexComparator() Creates an instance of ComplexComparator.
abstract IOBNMetadata	createOBNMetadata(String obnUrl, com.sap.security.api.IPrincipal techUser) Creates an OBN metadata object for the specified OBN url.
abstract IOBNMetadata	createOBNMetadata(String boName, String sysAlias, String operation, com.sap.security.api.IPrincipal techUser) Creates an OBN metadata object for the specified system alias, business object and business object operation.
abstract IOBNParameterData	createOBNParameterData(Set paramValues) Creates an IOBNParameterData instance that contains multiple values to be set for a single metadata parameter using IOBNMetadata.setParameter(String, IOBNParameterData).
abstract IOBNParameterData	createOBNParameterData(String paramValue) Creates an IOBNParameterData instance that contains a single value to be set for a single metadata parameter using IOBNMetadata.setParameter(String, IOBNParameterData).
static OBNFactory	getInstance() Returns an instance of OBNFactory.

Methods inherited from class java.lang.Object

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

Constructor Detail

OBNFactory

public OBNFactory()

Method Detail

getInstance

public static OBNFactory getInstance()

Returns an instance of OBNFactory.

This method is equivalent to .

Returns:

an instance of OBNFactory

createOBNMetadata

public abstract IOBNMetadata createOBNMetadata(String boName,
                                               String sysAlias,
                                               String operation,
                                               com.sap.security.api.IPrincipal techUser)
                                        throws OBNException

Creates an OBN metadata object for the specified system alias, business object and business object operation.

Parameters:

boName - the id of the business object

sysAlias - the system alias if the metadata represents a system object; otherwise, null

operation - the id of the operation if the metadata represents an operation; otherwise, null

techUser - the user for accessing the PCD

Returns:

an OBN metadata object

Throws:

OBNException - if the boName parameter is null

createOBNMetadata

public abstract IOBNMetadata createOBNMetadata(String obnUrl,
                                               com.sap.security.api.IPrincipal techUser)
                                        throws OBNException

Creates an OBN metadata object for the specified OBN url.

An OBN target application can use this method after retrieving the NavigationTarget parameter from the request.

The URL has to be an OBN URL.

Parameters:

obnUrl - the OBN URL retrieved from the request

techUser - the user to be used to access PCD

Returns:

an OBN metadata with the OBN information produced from the OBN url.

Throws:

OBNException - if the specified URL is not a valid OBN URL or if the business object retrieved from the URL is null

createOBNParameterData

public abstract IOBNParameterData createOBNParameterData(String paramValue)
                                                  throws OBNException

Creates an IOBNParameterData instance that contains a single value to be set for a single metadata parameter using IOBNMetadata.setParameter(String, IOBNParameterData).

Parameters:

paramValue - the parameter value

Throws:

OBNException - if an error occurs during the creation process

createOBNParameterData

public abstract IOBNParameterData createOBNParameterData(Set paramValues)
                                                  throws OBNException

Creates an IOBNParameterData instance that contains multiple values to be set for a single metadata parameter using IOBNMetadata.setParameter(String, IOBNParameterData).

Parameters:

paramValues - the parameter values

Throws:

OBNException - if an error occurs during the creation process

createComplexComparator

public abstract ComplexComparator createComplexComparator()
                                                   throws OBNException

Creates an instance of ComplexComparator.

Returns:

a ComplexComparator that can be used for sorting by multiple criteria.

Throws:

OBNException - if an error occurs during the creation process

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-RUNTIME	[sap.com] tc/ep/navigation/api	api	EP-PIN