baseten / Sources / BXRelationshipDescriptionPrivate.h

// BXRelationshipDescriptionPrivate.h
// BaseTen
// Copyright (C) 2006-2008 Marko Karppinen & Co. LLC.
// Before using this software, please review the available licensing options
// by visiting or by contacting
// us at Without an additional license, this software
// may be distributed only in compliance with the GNU General Public License.
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License, version 2.0,
// as published by the Free Software Foundation.
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
// $Id$

#import <BaseTen/BXRelationshipDescription.h>
#import <BaseTen/BXPGRelationAliasMapper.h>

@class BXForeignKey;
@class BXDatabaseObject;

@interface BXRelationshipDescription (PrivateMethods)
- (id) initWithName: (NSString *) aName entity: (BXEntityDescription *) entity 
  destinationEntity: (BXEntityDescription *) destinationEntity;
- (id <BXForeignKey>) foreignKey;
- (void) setForeignKey: (id <BXForeignKey>) aKey;
- (BOOL) isInverse;
- (void) setIsInverse: (BOOL) aBool;
- (BOOL) usesRelationNames;
- (void) setUsesRelationNames: (BOOL) aBool;
- (void) setInverseName: (NSString *) aString;
- (void) setDeprecated: (BOOL) aBool;

//Remember to override these in subclasses.
- (id) registeredTargetFor: (BXDatabaseObject *) databaseObject fireFault: (BOOL) fireFault;
- (id) targetForObject: (BXDatabaseObject *) anObject error: (NSError **) error;
- (BOOL) setTarget: (id) target
		 forObject: (BXDatabaseObject *) aDatabaseObject
			 error: (NSError **) error;

- (void) iterateForeignKey: (void (*)(NSString*, NSString*, void*) )callback context: (void *) ctx;

- (void) removeAttributeDependency;
- (void) makeAttributeDependency;

@interface BXRelationshipDescription (BXPGRelationAliasMapper)
- (id) BXPGVisitRelationship: (id <BXPGRelationshipVisitor>) visitor fromItem: (BXPGRelationshipFromItem *) fromItem;