public interface IRelationOperand
IRelation
s operand - the so called source or target
of a relation. IRelationOperand
s belong to a IRelationOperandType
. The wrap the objects they reference to enable
type checking within the relation service. IRelationOperand
implementation should also implement the
method getValue()
to retrieve the operands wrapped object
without a type cast.Modifier and Type | Method and Description |
---|---|
IResource |
asResource()
Get the relation operand as resource, if this operand is managed by a
repository manager.
|
String |
getID()
Get the relation operand's unique id.
|
Object |
getObject()
Get the relation operand's unwrapped object.
|
IRelation |
getRelationBySource(IRelationType type,
IRelationOperand target)
same as
type.getRelation(this, target); |
IRelation |
getRelationByTarget(IRelationType type,
IRelationOperand source)
same as
type.getRelation(source, this); |
IRelationList |
getRelationsBySource(IRelationType type)
same as
type.getRelationBySource(this); |
IRelationList |
getRelationsBySource(IResourceContext context)
same as
IRelationService.getRelationsBySource(context, this); |
IRelationList |
getRelationsBySource(IResourceContext context,
IRelationOperand target)
same as
IRelationService.getRelations(context, this, target); |
IRelationList |
getRelationsByTarget(IRelationType type)
same as
type.getRelationByTarget(this); |
IRelationList |
getRelationsByTarget(IResourceContext context)
same as
IRelationService.getRelationsByTarget(context, this); |
IRelationList |
getRelationsByTarget(IResourceContext context,
IRelationOperand source)
same as
IRelationService.getRelations(source, this); |
IRelationOperandType |
getType()
Get the relation operand's type.
|
IRelationOperandType getType() throws ResourceException
IRelationOperandType
with the type of this operand.ResourceException
- an error occured while retrieving
the operand's type.String getID() throws ResourceException
String
with the unique id of this operand. the id is
only unique within the operand's type.ResourceException
- an error occured while retrieving
the operand's id.Object getObject()
Object
with the unwrapped operand, referenced by
this IRelationOperand
.IResource asResource() throws ResourceException
IResource
with the resource represented by this
operand. returns null
, if this operand can not be
converted to a resource.ResourceException
- an error occured while retrieving
the operand's resource.IRelationList getRelationsBySource(IResourceContext context) throws InvalidArgumentException, AccessDeniedException, ResourceException
IRelationService.getRelationsBySource(context, this);
context
- TBD: Description of the incoming method parameterInvalidArgumentException
- Exception raised in failure situationAccessDeniedException
- Exception raised in failure situationResourceException
- Exception raised in failure situationIRelationList getRelationsBySource(IRelationType type) throws InvalidArgumentException, AccessDeniedException, ResourceException
type.getRelationBySource(this);
type
- TBD: Description of the incoming method parameterInvalidArgumentException
- Exception raised in failure situationAccessDeniedException
- Exception raised in failure situationResourceException
- Exception raised in failure situationIRelationList getRelationsBySource(IResourceContext context, IRelationOperand target) throws InvalidArgumentException, AccessDeniedException, ResourceException
IRelationService.getRelations(context, this, target);
context
- TBD: Description of the incoming method parametertarget
- TBD: Description of the incoming method parameterInvalidArgumentException
- Exception raised in failure situationAccessDeniedException
- Exception raised in failure situationResourceException
- Exception raised in failure situationIRelation getRelationBySource(IRelationType type, IRelationOperand target) throws InvalidArgumentException, AccessDeniedException, ResourceException
type.getRelation(this, target);
type
- TBD: Description of the incoming method parametertarget
- TBD: Description of the incoming method parameterInvalidArgumentException
- Exception raised in failure situationAccessDeniedException
- Exception raised in failure situationResourceException
- Exception raised in failure situationIRelationList getRelationsByTarget(IResourceContext context) throws InvalidArgumentException, AccessDeniedException, ResourceException
IRelationService.getRelationsByTarget(context, this);
context
- TBD: Description of the incoming method parameterInvalidArgumentException
- Exception raised in failure situationAccessDeniedException
- Exception raised in failure situationResourceException
- Exception raised in failure situationIRelationList getRelationsByTarget(IRelationType type) throws InvalidArgumentException, AccessDeniedException, ResourceException
type.getRelationByTarget(this);
type
- TBD: Description of the incoming method parameterInvalidArgumentException
- Exception raised in failure situationAccessDeniedException
- Exception raised in failure situationResourceException
- Exception raised in failure situationIRelationList getRelationsByTarget(IResourceContext context, IRelationOperand source) throws InvalidArgumentException, AccessDeniedException, ResourceException
IRelationService.getRelations(source, this);
context
- TBD: Description of the incoming method parametersource
- TBD: Description of the incoming method parameterInvalidArgumentException
- Exception raised in failure situationAccessDeniedException
- Exception raised in failure situationResourceException
- Exception raised in failure situationIRelation getRelationByTarget(IRelationType type, IRelationOperand source) throws InvalidArgumentException, AccessDeniedException, ResourceException
type.getRelation(source, this);
type
- TBD: Description of the incoming method parametersource
- TBD: Description of the incoming method parameterInvalidArgumentException
- Exception raised in failure situationAccessDeniedException
- Exception raised in failure situationResourceException
- Exception raised in failure situationAccess Rights |
---|
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
|
Copyright 2018 SAP AG Complete Copyright Notice