Package com.sap.portal.pcm.admin

Provides interfaces that enable a semantic object to be visible in the Portal Catalog.

See:
Description

Interface Summary

IAdminBase	The interface that is the entry point to all administration interfaces.
IAttributeSet	The interface that provides methods to work with object attributes.
ICatalogNode	The interface that provides information about the object that is useful for building an administration editor.
ILockHandle	The interface that helps to protect the current object against concurrent changes.
IPermission	The interface that provides information about the permissions of a portal object.
PcmConstants	This interface provides constants for the portal content model.
PcmConstants.ISearchPolicy	Defines the search policy constants for searches in the PCM

Class Summary

ILockHandle.LockInfo	The class that describes the current state of a lock.
ObjectState	The interface that represents possible states of an object.
PcmConstants.AttributeIds	The class that provides constants for the PCM attributes
PcmConstants.ControlIds	The class that provides constants that represent the control IDs.
PcmConstants.MetaAttributeIds
PcmConstants.MetaAttributeIds.InheritanceValues	The class that provides predefined values for the inheritance meta-attribute.
PcmConstants.MetaAttributeIds.PersonalizationValues	The class that provides values for personalization and administration meta-attributes.
PcmConstants.MetaAttributeIds.TypeValues	Deprecated.
PcmUri	The class that represents a URL of a portal object or resource.
PermissionDescriptor	The class that represents the allowed permissions of an object and a permission description.
UiProperties	Deprecated. Please refer to admin studio configuration framework.

Exception Summary

ValidationException

The class that represents an error that occurs when trying to check the consistency of an object before saving it to the persistency.

Package com.sap.portal.pcm.admin Description

Provides interfaces that enable a semantic object to be visible in the Portal Catalog.

Tools that rely on this set of interfaces are:

• Portal Catalog
• Generic editors like the property editor
• Page Builder

Multiple Interfaces � IAdminBase

Semantic objects are very rich, but implementing all features in a single class is often expensive and sometimes hard to do.

To allow for flexible implementation, a basic interface called IAdminBase is introduced, which enables the retrieval of other interfaces for the object.

Object getImplementation(String ImplementationID):

A number of predefined implementation IDs are provided in IAdminBase.

Obtaining IAdminBase

Obtain the IAdminBase interface by doing a PCD lookup and specifying the administration aspect, as follows:

    Hashtable env1 = new Hashtable();
     
    env1.put(Context.INITIAL_CONTEXT_FACTORY, IPcdContext.PCD_INITIAL_CONTEXT_FACTORY);
    env1.put(Context.SECURITY_PRINCIPAL, request.getUser());
    env1.put(Constants.REQUESTED_ASPECT, PcmConstants.ASPECT_ADMINISTRATION);

    InitialContext iCtx = null;

    try {

        iCtx1 = new InitialContext(env1);
        IAdminBase adminBase = (IAdminBase)iCtx.lookup(lookupObject);

        // Write type of portal object
        response.write("Object Type: " + adminBase.getObjectType()+"<BR>"); 
        
        // Get ICatalogNode interface
        ICatalogNode cn = (ICatalogNode) adminBase.getImplementation(IAdminBase.CATALOG_NODE);

        // Write title of portal object
        response.write(cn.getTitle(request.getLocale())+"<BR>");

        // Get object for obtaining image URL
        PcmUri pcmUri = cn.getIcon(ObjectState.DEFAULT);

    } catch (NamingException e) {}