com.sap.portal.obn.semanticlayer

Interface IOBNObject

All Known Subinterfaces:
IBusinessObject, IOperation, IOperationImplementation

public interface IOBNObject

The base interface that all OBN semantic objects implement.

This interface defines basic semantic object capabilities, such as saving and removing the object from the PCD, and getting and setting standard OBN semantic attributes.


Method Summary
 String getDescription(Locale locale)
          Gets the description of the OBN object for the specified locale.
 String getObjectUrl()
          Gets the PCD address (URL) of the OBN object.
 String getPathName()
          Gets the path of the OBN object in the PCD.
 String getTechnicalName()
          Gets the ID of the OBN object in the PCD.
 String getTitle(Locale locale)
          Gets the title of the OBN object for the specified locale.
 void remove(com.sap.security.api.IPrincipal user)
          Deletes the OBN object from the PCD.
 void save()
          Updates the OBN object in the PCD.
 void setDescription(String description, Locale locale)
          Sets the description of the OBN object for the specified locale.
 void setTitle(String title, Locale locale)
          Sets the title of the OBN object for the specified locale.
 

Method Detail

getTitle

String getTitle(Locale locale)
Gets the title of the OBN object for the specified locale.

Parameters:
locale - a locale for the object's title
Returns:
the object's title

setTitle

void setTitle(String title,
              Locale locale)
Sets the title of the OBN object for the specified locale.

Parameters:
title - the new title for the object
locale - the title's locale

getDescription

String getDescription(Locale locale)
Gets the description of the OBN object for the specified locale.

Parameters:
locale - a locale for the object's description
Returns:
the object's description

setDescription

void setDescription(String description,
                    Locale locale)
Sets the description of the OBN object for the specified locale.

Parameters:
description - the new description for the object
locale - the description's locale

getPathName

String getPathName()
Gets the path of the OBN object in the PCD.

Returns:
the path of the OBN object in the PCD

getTechnicalName

String getTechnicalName()
Gets the ID of the OBN object in the PCD.

Returns:
the ID of the OBN object in the PCD

getObjectUrl

String getObjectUrl()
Gets the PCD address (URL) of the OBN object.

Returns:
the PCD address (URL) of the OBN object

save

void save()
          throws OBNException
Updates the OBN object in the PCD.

Throws:
OBNException

remove

void remove(com.sap.security.api.IPrincipal user)
            throws OBNException
Deletes the OBN object from the PCD.

Parameters:
user - the user to use when accessing the PCD
Throws:
OBNException - if an error occurs
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


Copyright 2011 SAP AG Complete Copyright Notice