com.sap.workspaces.content

Class ContentDescriptor

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

public class ContentDescriptor
extends Object

Provides a descriptor of a content item for the purposes of its integration in the content galleries and instantiation on a page

Since:

1.1

Constructor Summary

ContentDescriptor(String name, String description, String iconURL, String ID, ModuleCategory[] nestedCategories, Date creationDate, String URL)
Constructor of the content descriptor; use with nested module categories

ContentDescriptor(String name, String description, String iconURL, String ID, String[] categories, Date creationDate, String URL)
Constructor of the content descriptor; use with non-nested categories

Method Summary

String[]	getCategories() Deprecated. As of 1.1 SP02, use getModuleCategories() instead Returns an array of the module categories to which this content item belongs. In case of sub categories they are ignored, only the highest level is categories are returned.
String	getContentID() Returns the ID of the content item in its source system; should not exceed 340 characters
Date	getCreationDate() Optional; returns the date when this content item was created in the source system; if not specified, the null value is passed
String	getDescription() Returns the content item's description
String	getIconURL() Returns the URL of the icon associated with the content item
ModuleCategory[]	getModuleCategories() Returns an array of the nested categories to which this content item belongs.
String	getName() Returns the content item's name that appears in the content galleries
String	getURL() Returns the navigation URL of this content item

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentDescriptor

public ContentDescriptor(String name,
                         String description,
                         String iconURL,
                         String ID,
                         String[] categories,
                         Date creationDate,
                         String URL)

Constructor of the content descriptor; use with non-nested categories

Parameters:

name - the content item's name

description - the content item's description

iconURL - the URL of the icon associated with the content item

ID - the content item's ID, defined in the source system

categories - an array of categories to which the content item belongs

creationDate - the date when the content item was created in the source system; optional, default is null

URL - the direct URL of the content item

ContentDescriptor

public ContentDescriptor(String name,
                         String description,
                         String iconURL,
                         String ID,
                         ModuleCategory[] nestedCategories,
                         Date creationDate,
                         String URL)

Constructor of the content descriptor; use with nested module categories

Parameters:

name - the content item's name

description - the content item's description

iconURL - the URL of the icon associated with the content item

ID - the content item's ID, defined in the source system

creationDate - the date when the content item was created in the source system; optional, default is null

URL - the direct URL of the content item

nestedCategories - nestedCategories an array of nested categories to which the content item belongs

Since:

1.1 SP02

Method Detail

getContentID

public String getContentID()

Returns the ID of the content item in its source system; should not exceed 340 characters

Returns:

The ID of the content item in its source system

getDescription

public String getDescription()

Returns the content item's description

Returns:

The content item's description

getName

public String getName()

Returns the content item's name that appears in the content galleries

Returns:

The content item's name

getIconURL

public String getIconURL()

Returns the URL of the icon associated with the content item

Returns:

the URL of the icon

getCategories

public String[] getCategories()

Deprecated. As of 1.1 SP02, use getModuleCategories() instead Returns an array of the module categories to which this content item belongs. In case of sub categories they are ignored, only the highest level is categories are returned.

Returns:

An array of the module categories

getModuleCategories

public ModuleCategory[] getModuleCategories()

Returns an array of the nested categories to which this content item belongs.

Returns:

An array of the module categories

getCreationDate

public Date getCreationDate()

Optional; returns the date when this content item was created in the source system; if not specified, the null value is passed

Returns:

The creation date of this content item

getURL

public String getURL()

Returns the navigation URL of this content item

Returns:

The navigation URL of this content item