com.sap.workspaces.content

Class AbstractContentProvider

java.lang.Object
  com.sap.workspaces.content.AbstractContentProvider

All Implemented Interfaces:

IWorkspacesService

public abstract class AbstractContentProvider
extends Object
implements IWorkspacesService

Extend this abstract class to integrate external content in workspaces

Since:

1.1

Constructor Summary

AbstractContentProvider()

Method Summary

abstract ContentDescriptor	getContentDescriptor(String contentID, com.sap.security.api.IUser user, Locale locale) Returns the descriptor of the content item specified by the content ID, user and locale
abstract ContentDescriptor[]	getContentDescriptors(ContentFilter contentFilter, com.sap.security.api.IUser user, Locale locale) Returns descriptors of the content items specified by the content filter, user and locale
abstract String	getID() Returns the content provider ID; should not exceed 32 characters
abstract AbstractModule	getModule(String contentID, com.sap.security.api.IUser user) Returns a module created from the specified content item

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractContentProvider

public AbstractContentProvider()

Method Detail

getID

public abstract String getID()

Returns the content provider ID; should not exceed 32 characters

Returns:

The content provider ID

getContentDescriptors

public abstract ContentDescriptor[] getContentDescriptors(ContentFilter contentFilter,
                                                          com.sap.security.api.IUser user,
                                                          Locale locale)

Returns descriptors of the content items specified by the content filter, user and locale

Parameters:

contentFilter - the filter defining the relevant content

user - the current user

locale - the user's locale

Returns:

An array of content descriptors

getContentDescriptor

public abstract ContentDescriptor getContentDescriptor(String contentID,
                                                       com.sap.security.api.IUser user,
                                                       Locale locale)

Returns the descriptor of the content item specified by the content ID, user and locale

Parameters:

contentID - the ID of the content item in its source system

user - the current user

locale - the user's locale

Returns:

The content descriptor

getModule

public abstract AbstractModule getModule(String contentID,
                                         com.sap.security.api.IUser user)

Returns a module created from the specified content item

Parameters:

user - the current user

Returns:

An AbstractModule object representing the module