com.sapportals.wcm.service.relation.operands
Class ResourceOperandType

[contained in: com.sap.netweaver.bc.rf.service.par - bc.rf.global.service.relation_api.jar]

java.lang.Object
  |
  +--com.sapportals.wcm.service.relation.operands.ResourceOperandType

All Implemented Interfaces:

IRelationOperandType

public class ResourceOperandType

extends java.lang.Object

implements IRelationOperandType

IRelationOperandType implementation for IResource s.

Field Summary

protected static IResourceFactory	factory
protected IProperty	resourceType

Constructor Summary

ResourceOperandType()
Create a resource operand type for any type of resource.

ResourceOperandType(IProperty resourceType)
Create a resource operand type for a given resource's type.

ResourceOperandType(IResource resource)
Create a resource operand type for a given resource's type.

ResourceOperandType(java.lang.String type)
Create a resource operand type for a specific resource type.

Method Summary

boolean	check(IRelationOperand operand) Check, if a given operand belongs to this type.
boolean	equals(java.lang.Object object)
IRelationOperand	getOperand(java.lang.Object object) Create the proper operand for a given object, if it belongs to this type.
IRelationOperand	getOperand(java.lang.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.

Methods inherited from class java.lang.Object

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

Field Detail

factory

protected static IResourceFactory factory

resourceType

protected IProperty resourceType

Constructor Detail

ResourceOperandType

public ResourceOperandType()

Create a resource operand type for any type of resource.

ResourceOperandType

public ResourceOperandType(java.lang.String type)
                    throws ResourceException

Create a resource operand type for a specific resource type.

Parameters:

type - the String which defines the resource type. if null , this type will match any resource type.

Throws:

ResourceException - if the type could not be build.

ResourceOperandType

public ResourceOperandType(IProperty resourceType)
                    throws InvalidArgumentException

Create a resource operand type for a given resource's type.

Parameters:

resourceType - TBD: Description of the incoming method parameter

Throws:

InvalidArgumentException - if the given type property is not a resource type property.

ResourceOperandType

public ResourceOperandType(IResource resource)
                    throws ResourceException

Create a resource operand type for a given resource's type.

Parameters:

resource - the IResource which specifies the resource type to use. if null , this type will match any resource type.

Throws:

ResourceException - if the resource's resource type could not be retrieved.

Method Detail

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

isDeleteTrackingSupported

public boolean isDeleteTrackingSupported()

Description copied from interface: IRelationOperandType

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

Specified by:

isDeleteTrackingSupported in interface IRelationOperandType

Following copied from interface: com.sapportals.wcm.service.relation.IRelationOperandType

Returns:

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

isChangeTrackingSupported

public boolean isChangeTrackingSupported()

Description copied from interface: IRelationOperandType

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

Specified by:

isChangeTrackingSupported in interface IRelationOperandType

Following copied from interface: com.sapportals.wcm.service.relation.IRelationOperandType

Returns:

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

isCopyTrackingSupported

public boolean isCopyTrackingSupported()

Description copied from interface: IRelationOperandType

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

Specified by:

isCopyTrackingSupported in interface IRelationOperandType

Following copied from interface: com.sapportals.wcm.service.relation.IRelationOperandType

Returns:

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

check

public boolean check(IRelationOperand operand)
              throws ResourceException

Description copied from interface: IRelationOperandType

Check, if a given operand belongs to this type.

Specified by:

check in interface IRelationOperandType

Following copied from interface: com.sapportals.wcm.service.relation.IRelationOperandType

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

public IRelationOperand getOperand(java.lang.String id,
                                   IResourceContext context)
                            throws InvalidArgumentException,
                                   ResourceException

Description copied from interface: IRelationOperandType

Get the operand for a given id and context.

Specified by:

getOperand in interface IRelationOperandType

Following copied from interface: com.sapportals.wcm.service.relation.IRelationOperandType

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

public IRelationOperand getOperand(java.lang.Object object)
                            throws InvalidArgumentException

Description copied from interface: IRelationOperandType

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

Specified by:

getOperand in interface IRelationOperandType

Following copied from interface: com.sapportals.wcm.service.relation.IRelationOperandType

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.