Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

com.sapportals.wcm.service.relation
Interface IRelationOperand

[contained in: com.sap.netweaver.bc.rf.service.par - bc.rf.global.service.relation_api.jar]
All Known Subinterfaces:
IRelationOperandExtended
All Known Implementing Classes:
AbstractRelationOperand
public interface IRelationOperand

A 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.
Each IRelationOperand implementation should also implement the method getValue() to retrieve the operands wrapped object without a type cast.

Method Summary
 IResource asResource()
          Get the relation operand as resource, if this operand is managed by a repository manager.
 java.lang.String getID()
          Get the relation operand's unique id.
 java.lang.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.
 

Method Detail

getType

public IRelationOperandType getType()
                             throws ResourceException
Get the relation operand's type.
Returns:
a IRelationOperandType with the type of this operand.
Throws:
ResourceException - an error occured while retrieving the operand's type.

getID

public java.lang.String getID()
                       throws ResourceException
Get the relation operand's unique id.
Returns:
a String with the unique id of this operand. the id is only unique within the operand's type.
Throws:
ResourceException - an error occured while retrieving the operand's id.

getObject

public java.lang.Object getObject()
Get the relation operand's unwrapped object.
Returns:
an Object with the unwrapped operand, referenced by this IRelationOperand .

asResource

public IResource asResource()
                     throws ResourceException
Get the relation operand as resource, if this operand is managed by a repository manager.
Returns:
a IResource with the resource represented by this operand. returns null , if this operand can not be converted to a resource.
Throws:
ResourceException - an error occured while retrieving the operand's resource.

getRelationsBySource

public IRelationList getRelationsBySource(IResourceContext context)
                                   throws InvalidArgumentException,
                                          AccessDeniedException,
                                          ResourceException
same as IRelationService.getRelationsBySource(context, this);
Parameters:
context - TBD: Description of the incoming method parameter
Returns:
relationsBySource
Throws:
InvalidArgumentException - Exception raised in failure situation
AccessDeniedException - Exception raised in failure situation
ResourceException - Exception raised in failure situation

getRelationsBySource

public IRelationList getRelationsBySource(IRelationType type)
                                   throws InvalidArgumentException,
                                          AccessDeniedException,
                                          ResourceException
same as type.getRelationBySource(this);
Parameters:
type - TBD: Description of the incoming method parameter
Returns:
relationsBySource
Throws:
InvalidArgumentException - Exception raised in failure situation
AccessDeniedException - Exception raised in failure situation
ResourceException - Exception raised in failure situation

getRelationsBySource

public IRelationList getRelationsBySource(IResourceContext context,
                                          IRelationOperand target)
                                   throws InvalidArgumentException,
                                          AccessDeniedException,
                                          ResourceException
same as IRelationService.getRelations(context, this, target);
Parameters:
context - TBD: Description of the incoming method parameter
target - TBD: Description of the incoming method parameter
Returns:
relationsBySource
Throws:
InvalidArgumentException - Exception raised in failure situation
AccessDeniedException - Exception raised in failure situation
ResourceException - Exception raised in failure situation

getRelationBySource

public IRelation getRelationBySource(IRelationType type,
                                     IRelationOperand target)
                              throws InvalidArgumentException,
                                     AccessDeniedException,
                                     ResourceException
same as type.getRelation(this, target);
Parameters:
type - TBD: Description of the incoming method parameter
target - TBD: Description of the incoming method parameter
Returns:
relationBySource
Throws:
InvalidArgumentException - Exception raised in failure situation
AccessDeniedException - Exception raised in failure situation
ResourceException - Exception raised in failure situation

getRelationsByTarget

public IRelationList getRelationsByTarget(IResourceContext context)
                                   throws InvalidArgumentException,
                                          AccessDeniedException,
                                          ResourceException
same as IRelationService.getRelationsByTarget(context, this);
Parameters:
context - TBD: Description of the incoming method parameter
Returns:
relationsByTarget
Throws:
InvalidArgumentException - Exception raised in failure situation
AccessDeniedException - Exception raised in failure situation
ResourceException - Exception raised in failure situation

getRelationsByTarget

public IRelationList getRelationsByTarget(IRelationType type)
                                   throws InvalidArgumentException,
                                          AccessDeniedException,
                                          ResourceException
same as type.getRelationByTarget(this);
Parameters:
type - TBD: Description of the incoming method parameter
Returns:
relationsByTarget
Throws:
InvalidArgumentException - Exception raised in failure situation
AccessDeniedException - Exception raised in failure situation
ResourceException - Exception raised in failure situation

getRelationsByTarget

public IRelationList getRelationsByTarget(IResourceContext context,
                                          IRelationOperand source)
                                   throws InvalidArgumentException,
                                          AccessDeniedException,
                                          ResourceException
same as IRelationService.getRelations(source, this);
Parameters:
context - TBD: Description of the incoming method parameter
source - TBD: Description of the incoming method parameter
Returns:
relationsByTarget
Throws:
InvalidArgumentException - Exception raised in failure situation
AccessDeniedException - Exception raised in failure situation
ResourceException - Exception raised in failure situation

getRelationByTarget

public IRelation getRelationByTarget(IRelationType type,
                                     IRelationOperand source)
                              throws InvalidArgumentException,
                                     AccessDeniedException,
                                     ResourceException
same as type.getRelation(source, this);
Parameters:
type - TBD: Description of the incoming method parameter
source - TBD: Description of the incoming method parameter
Returns:
relationByTarget
Throws:
InvalidArgumentException - Exception raised in failure situation
AccessDeniedException - Exception raised in failure situation
ResourceException - Exception raised in failure situation
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD
Copyright © 2004 by SAP AG. All Rights Reserved.
SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.