com.sapportals.wcm.service.ridid

Interface IRidIdService

All Superinterfaces:

IConfigurable, IStartable

public interface IRidIdService
extends IStartable, IConfigurable

Field Summary

static long	EMPTY_SET
static int	EVENT_PRIORITY_POST_HANDLING
static int	EVENT_PRIORITY_PRE_HANDLING
static long	INVALID_ID
static String	SERVICE_ID

Method Summary

long	createDeepIdSetFromRid(RID rid)
long	createIdForRid(RID rid) Create a new numeric ID or lookup an existing numeric ID for a given RID.
long	createIdSetFromRids(IRidList ridList)
long[]	createIdsForRids(IRidList ridList) Create or lookup an array of numeric IDs for a given list of RIDs.
long	getIdForRid(RID rid) Lookup a numeric ID for a given RID.
long[]	getIdsForIdSet(long setId)
long[]	getIdsForRids(IRidList ridList) Lookup an array of numeric IDs for a given list of RIDs.
RID	getRidForId(long id) Lookup an existing numeric ID for a given RID.
IRidList	getRidListForIdSet(long setId)
RID[]	getRidsForIds(long[] ids) Lookup an array of RIDs for a given array of numeric IDs.
long	getSetIdFromResourceContext(IResourceContext resourceContext) Retrieve the setId from the resource context.
void	registerForGarbageCollection(String table, String column)
void	removeIdSet(long setId)

Methods inherited from interface com.sapportals.wcm.crt.component.IStartable

start, stop

Methods inherited from interface com.sapportals.wcm.crt.component.IConfigurable

configure

Field Detail

SERVICE_ID

static final String SERVICE_ID

See Also:

Constant Field Values

INVALID_ID

static final long INVALID_ID

See Also:

Constant Field Values

EMPTY_SET

static final long EMPTY_SET

See Also:

Constant Field Values

EVENT_PRIORITY_PRE_HANDLING

static final int EVENT_PRIORITY_PRE_HANDLING

See Also:

Constant Field Values

EVENT_PRIORITY_POST_HANDLING

static final int EVENT_PRIORITY_POST_HANDLING

See Also:

Constant Field Values

Method Detail

createIdForRid

long createIdForRid(RID rid)
                    throws WcmException

Create a new numeric ID or lookup an existing numeric ID for a given RID.

Parameters:

rid - The RID that an ID is requested for.

Returns:

ID for the given RID.

Throws:

WcmException

createIdsForRids

long[] createIdsForRids(IRidList ridList)
                        throws WcmException

Create or lookup an array of numeric IDs for a given list of RIDs.

Parameters:

ridList - The list of RIDs that IDs are requested for.

Returns:

An array of IDs for the given list of RIDs.

Throws:

WcmException

getIdForRid

long getIdForRid(RID rid)
                 throws WcmException

Lookup a numeric ID for a given RID.

Parameters:

rid - The RID that an ID is requested for.

Returns:

ID for the given RID or IRidIdService.INVALID_ID if no mapping exists.

Throws:

WcmException

getIdsForRids

long[] getIdsForRids(IRidList ridList)
                     throws WcmException

Lookup an array of numeric IDs for a given list of RIDs.

Parameters:

ridList - The list of RIDs that IDs are requested for.

Returns:

An array of IDs for the given list of RIDs. For non-existing values the corresponding array entry is set to IRidIdService.INVALID_ID.

Throws:

WcmException

getRidForId

RID getRidForId(long id)
                throws WcmException

Lookup an existing numeric ID for a given RID.

Parameters:

id - The numeric ID that a RID is requested for.

Returns:

RID for the given numeric ID or null if no mapping exists.

Throws:

WcmException

getRidsForIds

RID[] getRidsForIds(long[] ids)
                    throws WcmException

Lookup an array of RIDs for a given array of numeric IDs.

Parameters:

ids - The array of numeric IDs that RIDs are requested for.

Returns:

An array of RIDs for the given array of numeric IDs.

Throws:

WcmException

createDeepIdSetFromRid

long createDeepIdSetFromRid(RID rid)
                            throws WcmException

Parameters:

rid - A RID that identifies the root node of

Returns:

An numeric id that uniquely identifies the set.

Throws:

WcmException

createIdSetFromRids

long createIdSetFromRids(IRidList ridList)
                         throws WcmException

Throws:

WcmException

getRidListForIdSet

IRidList getRidListForIdSet(long setId)
                            throws WcmException

Throws:

WcmException

getIdsForIdSet

long[] getIdsForIdSet(long setId)
                      throws WcmException

Throws:

WcmException

removeIdSet

void removeIdSet(long setId)
                 throws WcmException

Throws:

WcmException

getSetIdFromResourceContext

long getSetIdFromResourceContext(IResourceContext resourceContext)

Retrieve the setId from the resource context. The 'prepare' event receiver of the ridid service creates a set of all ids that are affected by performing the event operation on the ridid tree structure. I.e., for a tree /a/b/c1, /a/b/c2, /a/b/c/d1, a 'delete event' on /a/b results in a set containing the ids for c1, c2, c, and d1.

registerForGarbageCollection

void registerForGarbageCollection(String table,
                                  String column)

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM