com.sapportals.wcm.service.relation.operands

Class AbstractRelationOperand

java.lang.Object
  extended bycom.sapportals.wcm.service.relation.operands.AbstractRelationOperand
All Implemented Interfaces:
IRelationOperand
Direct Known Subclasses:
ResourceOperand, StringOperand

public abstract class AbstractRelationOperand
extends Object
implements IRelationOperand

A basic IRelationOperand implementation which handles the getRelation ...() methods.


Constructor Summary
AbstractRelationOperand()
           
 
Method Summary
abstract  IResource asResource()
          Get the relation operand as resource, if this operand is managed by a repository manager.
abstract  String getID()
          Get the relation operand's unique id.
abstract  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);
abstract  IRelationOperandType getType()
          Get the relation operand's type.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractRelationOperand

public AbstractRelationOperand()
Method Detail

getType

public abstract IRelationOperandType getType()
                                      throws ResourceException
Description copied from interface: IRelationOperand
Get the relation operand's type.

Specified by:
getType in interface IRelationOperand
Returns:
a IRelationOperandType with the type of this operand.
Throws:
ResourceException - an error occured while retrieving the operand's type.

getID

public abstract String getID()
                      throws ResourceException
Description copied from interface: IRelationOperand
Get the relation operand's unique id.

Specified by:
getID in interface IRelationOperand
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 abstract Object getObject()
Description copied from interface: IRelationOperand
Get the relation operand's unwrapped object.

Specified by:
getObject in interface IRelationOperand
Returns:
an Object with the unwrapped operand, referenced by this IRelationOperand .

asResource

public abstract IResource asResource()
                              throws ResourceException
Description copied from interface: IRelationOperand
Get the relation operand as resource, if this operand is managed by a repository manager.

Specified by:
asResource in interface IRelationOperand
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
Description copied from interface: IRelationOperand
same as IRelationService.getRelationsBySource(context, this);

Specified by:
getRelationsBySource in interface IRelationOperand
Parameters:
context - TBD: Description of the incoming method parameter
Returns:
relationsBySource
Throws:
AccessDeniedException - Exception raised in failure situation
InvalidArgumentException - Exception raised in failure situation
ResourceException - Exception raised in failure situation

getRelationsBySource

public IRelationList getRelationsBySource(IRelationType type)
                                   throws InvalidArgumentException,
                                          AccessDeniedException,
                                          ResourceException
Description copied from interface: IRelationOperand
same as type.getRelationBySource(this);

Specified by:
getRelationsBySource in interface IRelationOperand
Parameters:
type - TBD: Description of the incoming method parameter
Returns:
relationsBySource
Throws:
ResourceException - Exception raised in failure situation
InvalidArgumentException - Exception raised in failure situation
AccessDeniedException - Exception raised in failure situation

getRelationsBySource

public IRelationList getRelationsBySource(IResourceContext context,
                                          IRelationOperand target)
                                   throws InvalidArgumentException,
                                          AccessDeniedException,
                                          ResourceException
Description copied from interface: IRelationOperand
same as IRelationService.getRelations(context, this, target);

Specified by:
getRelationsBySource in interface IRelationOperand
Parameters:
context - TBD: Description of the incoming method parameter
target - TBD: Description of the incoming method parameter
Returns:
relationsBySource
Throws:
AccessDeniedException - Exception raised in failure situation
InvalidArgumentException - Exception raised in failure situation
ResourceException - Exception raised in failure situation

getRelationBySource

public IRelation getRelationBySource(IRelationType type,
                                     IRelationOperand target)
                              throws InvalidArgumentException,
                                     AccessDeniedException,
                                     ResourceException
Description copied from interface: IRelationOperand
same as type.getRelation(this, target);

Specified by:
getRelationBySource in interface IRelationOperand
Parameters:
type - TBD: Description of the incoming method parameter
target - TBD: Description of the incoming method parameter
Returns:
relationBySource
Throws:
AccessDeniedException - Exception raised in failure situation
ResourceException - Exception raised in failure situation
InvalidArgumentException - Exception raised in failure situation

getRelationsByTarget

public IRelationList getRelationsByTarget(IResourceContext context)
                                   throws InvalidArgumentException,
                                          AccessDeniedException,
                                          ResourceException
Description copied from interface: IRelationOperand
same as IRelationService.getRelationsByTarget(context, this);

Specified by:
getRelationsByTarget in interface IRelationOperand
Parameters:
context - TBD: Description of the incoming method parameter
Returns:
relationsByTarget
Throws:
ResourceException - Exception raised in failure situation
AccessDeniedException - Exception raised in failure situation
InvalidArgumentException - Exception raised in failure situation

getRelationsByTarget

public IRelationList getRelationsByTarget(IRelationType type)
                                   throws InvalidArgumentException,
                                          AccessDeniedException,
                                          ResourceException
Description copied from interface: IRelationOperand
same as type.getRelationByTarget(this);

Specified by:
getRelationsByTarget in interface IRelationOperand
Parameters:
type - TBD: Description of the incoming method parameter
Returns:
relationsByTarget
Throws:
ResourceException - Exception raised in failure situation
AccessDeniedException - Exception raised in failure situation
InvalidArgumentException - Exception raised in failure situation

getRelationsByTarget

public IRelationList getRelationsByTarget(IResourceContext context,
                                          IRelationOperand source)
                                   throws InvalidArgumentException,
                                          AccessDeniedException,
                                          ResourceException
Description copied from interface: IRelationOperand
same as IRelationService.getRelations(source, this);

Specified by:
getRelationsByTarget in interface IRelationOperand
Parameters:
context - TBD: Description of the incoming method parameter
source - TBD: Description of the incoming method parameter
Returns:
relationsByTarget
Throws:
ResourceException - Exception raised in failure situation
InvalidArgumentException - Exception raised in failure situation
AccessDeniedException - Exception raised in failure situation

getRelationByTarget

public IRelation getRelationByTarget(IRelationType type,
                                     IRelationOperand source)
                              throws InvalidArgumentException,
                                     AccessDeniedException,
                                     ResourceException
Description copied from interface: IRelationOperand
same as type.getRelation(source, this);

Specified by:
getRelationByTarget in interface IRelationOperand
Parameters:
type - TBD: Description of the incoming method parameter
source - TBD: Description of the incoming method parameter
Returns:
relationByTarget
Throws:
AccessDeniedException - Exception raised in failure situation
InvalidArgumentException - Exception raised in failure situation
ResourceException - Exception raised in failure situation


Copyright 2006 SAP AG. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Microsoft, Windows, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation. Oracle is a registered trademark of Oracle Corporation. UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group. Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc. HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C, World Wide Web Consortium, Massachusetts Institute of Technology. Java is a registered trademark of Sun Microsystems, Inc. JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape. MaxDB is a trademark of MySQL AB, Sweden. 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.