com.sapportals.wcm.service.relation

Interface IRelationOperandType

All Known Subinterfaces:

IRelationOperandTypeExtended

All Known Implementing Classes:

ResourceOperandType, StringOperandType

public interface IRelationOperandType

The type for a IRelationOperand .
IRelationOperandType s define the type of a relation operand, enabling type checking for relations.

Method Summary

boolean	check(IRelationOperand operand) Check, if a given operand belongs to this type.
IRelationOperand	getOperand(Object object) Create the proper operand for a given object, if it belongs to this type.
IRelationOperand	getOperand(String id, IResourceContext context) Get the operand for a given id and context.
boolean	isChangeTrackingSupported() Check, if this operand type supports tracking of object renaming.
boolean	isCopyTrackingSupported() Check, if this operand type supports tracking of object copy.
boolean	isDeleteTrackingSupported() Check, if this operand type supports tracking of object deletion.

Method Detail

isDeleteTrackingSupported

boolean isDeleteTrackingSupported()

Check, if this operand type supports tracking of object deletion.

Returns:

a boolean true , if this operand type supports the tracking of deletes for objects of this type.

isChangeTrackingSupported

boolean isChangeTrackingSupported()

Check, if this operand type supports tracking of object renaming.

Returns:

a boolean true , if this operand type supports the tracking of rename or move for objects of this type.

isCopyTrackingSupported

boolean isCopyTrackingSupported()

Check, if this operand type supports tracking of object copy.

Returns:

a boolean true , if this operand type supports the tracking of copy for objects of this type.

check

boolean check(IRelationOperand operand)
              throws ResourceException

Check, if a given operand belongs to this type.

Parameters:

operand - the IRelationOperand which should be checked for compatibility with this type.

Returns:

a boolean true , if the operand is compatible with this type.

Throws:

ResourceException - Exception raised in failure situation

ResourceException - if there was an error while retrieving the operand's type.

getOperand

IRelationOperand getOperand(String id,
                            IResourceContext context)
                            throws InvalidArgumentException,
                                   ResourceException

Get the operand for a given id and context.

Parameters:

id - the String with the unique id of the operand to get.

context - the IResouceContext to use for retrieving the operand.

Returns:

the IRelationOperand for the given id.

Throws:

InvalidArgumentException - Exception raised in failure situation

ResourceException - Exception raised in failure situation

InvalidArgumentException - if the id is null .

ResourceException - if there was an error while retrieving the operand.

getOperand

IRelationOperand getOperand(Object object)
                            throws InvalidArgumentException,
                                   ResourceException

Create the proper operand for a given object, if it belongs to this type.

Parameters:

object - TBD: Description of the incoming method parameter

Returns:

the IRelationOperand for the given object.

Throws:

InvalidArgumentException - Exception raised in failure situation

ResourceException - Exception raised in failure situation

InvalidArgumentException - if the given object is not compatible with this type or if it is null .

ResourceException - if there was an error while retrieving the operand.

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