com.sap.portal.pcm.admin

Interface ICatalogNode

public interface ICatalogNode

The interface that provides information about the object that is useful for building an administration editor.

Each portal object has a list of capabilities that indicate the actions that can be performed on it by the portal. An action can be performed on a portal object only if it has a list of certain capabilities. The portal can suggest to perform an action on a portal object only after it checks whether the object has the capabilities required for that action.

When setting the suitable actions for an object in the Admin Studio configuration, the corresponding capabilities are automatically set to the portal object.

Generic tools that have to connect a semantic object to its related actions have to retrieve the semantic object's capabilities using the getCapabilities() method. The method returns the capabilities defined by the constants whose names start with CAPABILITY.

Field Summary

static String	ACTION_EDIT A constant that represents an action ID.
static String	CAPABILITY_CHECKOUT_FOR_ADD A constant that represents system local objects that can be added to the DTR (assigned to a transportable DC).
static String	CAPABILITY_CHECKOUT_FOR_EDIT A constant that represents objects that can be checked out for edit.
static String	CAPABILITY_DELETABLE A constant that represents a deletable object.
static String	CAPABILITY_DUPLICATABLE A constant that represents an object that can be duplicated.
static String	CAPABILITY_EDITABLE A constant that represents an editable object.
static String	CAPABILITY_FOLDER A constant that represents folder capabilities.
static String	CAPABILITY_HIERARCHICAL_TRANSPORTABLE A constant that represents an object with hierarchical transportability, meaning it can be transported with all its sons.
static String	CAPABILITY_LAUNCHABLE A constant that represents an object that can be launched by the Portal Runtime.
static String	CAPABILITY_LINKABLE A constant that represents a linkable object.
static String	CAPABILITY_MOVEABLE A constant that represents a moveable object.
static String	CAPABILITY_TRANSPORTABLE A constant that represents a transportable object.
static String	NAMESPACE A constant that represents the capabilities namespace.

Method Summary

String[]	getCapabilities() Gets the capabilities of the underlying portal object.
String	getDescription(Locale locale) Gets a description of the catalog node according to the preferred locale.
String	getDescriptionAttributeId() Gets the ID of the attribute that holds the description.
PcmUri	getIcon(ObjectState state) Gets a URI holding the location of the icon for the underlying object for the specified state.
String	getId() Deprecated. Avoid using this method; instead, you should know the ID by knowing how the object was looked up.
String	getObjectTypeName(Locale locale) Gets the friendly name of the semantic object type.
Map	getQuickViewAttributes(Locale locale) Gets attributes (name and value pairs) that are used to preview the object attributes.
String	getTitle(Locale locale) Gets the title of the catalog node according to the specified locale.
String	getTitleAttributeId() Gets the ID of the attribute that holds the title.
UiProperties	getUiProperties(String actionID) Deprecated. Use the Admin Studio configuration framework.

Field Detail

NAMESPACE

static final String NAMESPACE

A constant that represents the capabilities namespace.

See Also:

Constant Field Values

CAPABILITY_LAUNCHABLE

static final String CAPABILITY_LAUNCHABLE

A constant that represents an object that can be launched by the Portal Runtime.

See Also:

Constant Field Values

CAPABILITY_FOLDER

static final String CAPABILITY_FOLDER

A constant that represents folder capabilities.

Used for sorting (folders are displayed before any other object in content trees) and also as a part of testing paste validity (you can only paste into folders).

See Also:

Constant Field Values

CAPABILITY_DELETABLE

static final String CAPABILITY_DELETABLE

A constant that represents a deletable object.

Used for tree manipulations.

See Also:

Constant Field Values

CAPABILITY_LINKABLE

static final String CAPABILITY_LINKABLE

A constant that represents a linkable object.

Used for tree manipulations.

See Also:

Constant Field Values

CAPABILITY_DUPLICATABLE

static final String CAPABILITY_DUPLICATABLE

A constant that represents an object that can be duplicated.

Used for tree manipulations.

See Also:

Constant Field Values

CAPABILITY_MOVEABLE

static final String CAPABILITY_MOVEABLE

A constant that represents a moveable object.

Used for tree manipulations.

See Also:

Constant Field Values

CAPABILITY_EDITABLE

static final String CAPABILITY_EDITABLE

A constant that represents an editable object.

See Also:

Constant Field Values

CAPABILITY_TRANSPORTABLE

static final String CAPABILITY_TRANSPORTABLE

A constant that represents a transportable object.

See Also:

Constant Field Values

CAPABILITY_HIERARCHICAL_TRANSPORTABLE

static final String CAPABILITY_HIERARCHICAL_TRANSPORTABLE

A constant that represents an object with hierarchical transportability, meaning it can be transported with all its sons.

See Also:

Constant Field Values

CAPABILITY_CHECKOUT_FOR_ADD

static final String CAPABILITY_CHECKOUT_FOR_ADD

A constant that represents system local objects that can be added to the DTR (assigned to a transportable DC).

See Also:

Constant Field Values

CAPABILITY_CHECKOUT_FOR_EDIT

static final String CAPABILITY_CHECKOUT_FOR_EDIT

A constant that represents objects that can be checked out for edit.

See Also:

Constant Field Values

ACTION_EDIT

static final String ACTION_EDIT

A constant that represents an action ID.

Used for getting editor UI properties.

See Also:

Constant Field Values

Method Detail

getId

String getId()

Deprecated. Avoid using this method; instead, you should know the ID by knowing how the object was looked up.

Gets a unique ID that returns this object using JNDI (for example, pcd:x/y/z).

getTitle

String getTitle(Locale locale)

Gets the title of the catalog node according to the specified locale.

Parameters:

locale - the preferred locale

Returns:

the title of the catalog node

getTitleAttributeId

String getTitleAttributeId()

Gets the ID of the attribute that holds the title.

Returns:

the title attribute ID

getDescription

String getDescription(Locale locale)

Gets a description of the catalog node according to the preferred locale.

Parameters:

locale - the preferred locale

Returns:

the description of the portal object

getDescriptionAttributeId

String getDescriptionAttributeId()

Gets the ID of the attribute that holds the description.

Returns:

the description attribute ID

getIcon

PcmUri getIcon(ObjectState state)

Gets a URI holding the location of the icon for the underlying object for the specified state.

Parameters:

state - the state of the underlying portal object

Returns:

the location of the icon

getObjectTypeName

String getObjectTypeName(Locale locale)

Gets the friendly name of the semantic object type.

Parameters:

locale - the preferred locale

Returns:

the friendly name of the semantic object type

getCapabilities

String[] getCapabilities()

Gets the capabilities of the underlying portal object.

Capabilities are associated with a set of actions in the admin environment of the portal. An object may declare it has one or more capabilities. This will effect the available actions for this object in various areas in the admin environment of the portal.

The common use of this method is when filtering actions in Admin Studio configuration.

Returns:

array of capabilities or null if no capability exists.

getUiProperties

UiProperties getUiProperties(String actionID)

Deprecated. Use the Admin Studio configuration framework.

Gets the UI properties of the portal object.

The returned UiProperties object contains all needed information to perform the action.

An action is always mapped to a UI (a URL). This object may offer its own UI for the specified actionID.

Parameters:

actionID - represents an action defined in the admin environment of the portal

Returns:

UiProperties object or null if the action is not known to the object or if this object does not want to overwrite the default UiProperties as defined in the admin environment of the portal

getQuickViewAttributes

Map getQuickViewAttributes(Locale locale)
                           throws UnsupportedOperationException

Gets attributes (name and value pairs) that are used to preview the object attributes.

Parameters:

locale - the preferred locale of attribute's name and value

Returns:

a map of attributes or null if no attributes should be previewed or the object does not support this

Throws:

UnsupportedOperationException

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM
[sap.com] EP-BASIS-API	[sap.com] tc/epbc/pcm/admin/public/api	api	EP-PIN