org.osid.relationship

Interface RelationshipManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidManager, OsidProfile, RelationshipProfile, Sourceable

public interface RelationshipManager
extends OsidManager, RelationshipProfile

The relationship manager provides access to relationship sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

• RelationshipLookupSession: a session to retrieve and examine relationships
• RelationshipQuerySession: a session to query relationships
• RelationshipSearchSession: a session to search for relationships
• RelationshipAdminSession: a session to manage relationships
• RelationshipNotificationSession: a session to receive notifications pertaining to relationship changes
• RelationshipFamilySession: a session to look up relationship to family mappings
• RelationshipFamilyAssignmentSession: a session to manage relationship to family catalog mappings
• RelationshipSmartFamilySession: a session to manage dynamic relationship families

• FamilyLookupSession: a session to retrieve families
• FamilyQuerySession: a session to query families
• FamilySearchSession: a session to search for families
• FamilyAdminSession: a session to create and delete families
• FamilyNotificationSession: a session to receive notifications pertaining to family changes
• FamilyHierarchySession: a session to traverse a hierarchy of families
• FamilyHierarchyDesignSession: a session to manage a family hierarchy

Method Summary

Methods

Modifier and Type	Method and Description
FamilyAdminSession	getFamilyAdminSession() Gets the OsidSession associated with the family administrative service.
FamilyHierarchyDesignSession	getFamilyHierarchyDesignSession() Gets the OsidSession associated with the family hierarchy design service.
FamilyHierarchySession	getFamilyHierarchySession() Gets the OsidSession associated with the family hierarchy service.
FamilyLookupSession	getFamilyLookupSession() Gets the OsidSession associated with the family lookup service.
FamilyNotificationSession	getFamilyNotificationSession(FamilyReceiver familyReceiver) Gets the OsidSession associated with the family notification service.
FamilyQuerySession	getFamilyQuerySession() Gets the OsidSession associated with the family query service.
FamilySearchSession	getFamilySearchSession() Gets the OsidSession associated with the family search service.
RelationshipAdminSession	getRelationshipAdminSession() Gets the OsidSession associated with the relationship administration service.
RelationshipAdminSession	getRelationshipAdminSessionForFamily(Id familyId) Gets the OsidSession associated with the relationship administration service for the given family.
RelationshipBatchManager	getRelationshipBatchManager() Gets the relationship batch manager.
RelationshipFamilyAssignmentSession	getRelationshipFamilyAssignmentSession() Gets the OsidSession associated with assigning relationships to families.
RelationshipFamilySession	getRelationshipFamilySession() Gets the OsidSession to lookup relationship/family mappings.
RelationshipLookupSession	getRelationshipLookupSession() Gets the OsidSession associated with the relationship lookup service.
RelationshipLookupSession	getRelationshipLookupSessionForFamily(Id familyId) Gets the OsidSession associated with the relationship lookup service for the given family.
RelationshipNotificationSession	getRelationshipNotificationSession(RelationshipReceiver relationshipReceiver) Gets the OsidSession associated with the relationship notification service.
RelationshipNotificationSession	getRelationshipNotificationSessionForFamily(RelationshipReceiver relationshipReceiver, Id familyId) Gets the OsidSession associated with the relationship notification service for the given family.
RelationshipQuerySession	getRelationshipQuerySession() Gets the OsidSession associated with the relationship query service.
RelationshipQuerySession	getRelationshipQuerySessionForFamily(Id familyId) Gets the OsidSession associated with the relationship query service for the given family.
RelationshipRulesManager	getRelationshipRulesManager() Gets the relationship rules manager.
RelationshipSearchSession	getRelationshipSearchSession() Gets the OsidSession associated with the relationship search service.
RelationshipSearchSession	getRelationshipSearchSessionForFamily(Id familyId) Gets the OsidSession associated with the relationship search service for the given family.
RelationshipSmartFamilySession	getRelationshipSmartFamilySession(Id familyId) Gets the OsidSession to manage dynamic families of retlationships.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.relationship.RelationshipProfile

getFamilyRecordTypes, getFamilySearchRecordTypes, getRelationshipRecordTypes, getRelationshipSearchRecordTypes, supportsFamilyAdmin, supportsFamilyHierarchy, supportsFamilyHierarchyDesign, supportsFamilyLookup, supportsFamilyNotification, supportsFamilyQuery, supportsFamilyRecordType, supportsFamilySearch, supportsFamilySearchRecordType, supportsRelationshipAdmin, supportsRelationshipBatch, supportsRelationshipFamily, supportsRelationshipFamilyAssignment, supportsRelationshipLookup, supportsRelationshipNotification, supportsRelationshipQuery, supportsRelationshipRecordType, supportsRelationshipRules, supportsRelationshipSearch, supportsRelationshipSearchRecordType, supportsRelationshipSmartFamily, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getRelationshipLookupSession

RelationshipLookupSession getRelationshipLookupSession()
                                                       throws OperationFailedException

Gets the OsidSession associated with the relationship lookup service.

Returns:

a RelationshipLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRelationshipLookup() is false

Compliance:

optional - This method must be implemented if supportsRelationshipLookup() is true.

getRelationshipLookupSessionForFamily

RelationshipLookupSession getRelationshipLookupSessionForFamily(Id familyId)
                                                                throws NotFoundException,
                                                                       OperationFailedException

Gets the OsidSession associated with the relationship lookup service for the given family.

Parameters:

familyId - the Id of the family

Returns:

a RelationshipLookupSession

Throws:

NotFoundException - no Family found by the given Id

NullArgumentException - familyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelationshipLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRelationshipLookup() and supportsVisibleFederation() are true

getRelationshipQuerySession

RelationshipQuerySession getRelationshipQuerySession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the relationship query service.

Returns:

a RelationshipQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRelationshipQuery() is false

Compliance:

optional - This method must be implemented if supportsRelationshipQuery() is true.

getRelationshipQuerySessionForFamily

RelationshipQuerySession getRelationshipQuerySessionForFamily(Id familyId)
                                                              throws NotFoundException,
                                                                     OperationFailedException

Gets the OsidSession associated with the relationship query service for the given family.

Parameters:

familyId - the Id of the family

Returns:

a RelationshipQuerySession

Throws:

NotFoundException - no Family found by the given Id

NullArgumentException - familyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelationshipQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRelationshipQuery() and supportsVisibleFederation() are true

getRelationshipSearchSession

RelationshipSearchSession getRelationshipSearchSession()
                                                       throws OperationFailedException

Gets the OsidSession associated with the relationship search service.

Returns:

a RelationshipSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRelationshipSearch() is false

Compliance:

optional - This method must be implemented if supportsRelationshipSearch() is true.

getRelationshipSearchSessionForFamily

RelationshipSearchSession getRelationshipSearchSessionForFamily(Id familyId)
                                                                throws NotFoundException,
                                                                       OperationFailedException

Gets the OsidSession associated with the relationship search service for the given family.

Parameters:

familyId - the Id of the Family

Returns:

a RelationshipSearchSession

Throws:

NotFoundException - no family found by the given Id

NullArgumentException - familyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelationshipSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRelationshipSearch() and supportsVisibleFederation() are true

getRelationshipAdminSession

RelationshipAdminSession getRelationshipAdminSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the relationship administration service.

Returns:

a RelationshipAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRelationshipAdmin() is false

Compliance:

optional - This method must be implemented if supportsRelationshipAdmin() is true.

getRelationshipAdminSessionForFamily

RelationshipAdminSession getRelationshipAdminSessionForFamily(Id familyId)
                                                              throws NotFoundException,
                                                                     OperationFailedException

Gets the OsidSession associated with the relationship administration service for the given family.

Parameters:

familyId - the Id of the Family

Returns:

a RelationshipAdminSession

Throws:

NotFoundException - no family found by the given Id

NullArgumentException - familyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelationshipAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRelationshipAdmin() and supportsVisibleFederation() are true

getRelationshipNotificationSession

RelationshipNotificationSession getRelationshipNotificationSession(RelationshipReceiver relationshipReceiver)
                                                                   throws OperationFailedException

Gets the OsidSession associated with the relationship notification service.

Parameters:

relationshipReceiver - the receiver

Returns:

a RelationshipNotificationSession

Throws:

NullArgumentException - relationshipReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelationshipNotification() is false

Compliance:

optional - This method must be implemented if supportsRelationshipNotification() is true.

getRelationshipNotificationSessionForFamily

RelationshipNotificationSession getRelationshipNotificationSessionForFamily(RelationshipReceiver relationshipReceiver,
                                                                          Id familyId)
                                                                            throws NotFoundException,
                                                                                   OperationFailedException

Gets the OsidSession associated with the relationship notification service for the given family.

Parameters:

relationshipReceiver - the receiver

familyId - the Id of the Family

Returns:

a RelationshipNotificationSession

Throws:

NotFoundException - no family found by the given Id

NullArgumentException - relationshipReceiver or familyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelationshipNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRelationshipNotification() and supportsVisibleFederation() are true

getRelationshipFamilySession

RelationshipFamilySession getRelationshipFamilySession()
                                                       throws OperationFailedException

Gets the OsidSession to lookup relationship/family mappings.

Returns:

a RelationshipFamilySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRelationshipFamily() is false

Compliance:

optional - This method must be implemented if supportsRelationshipFamily() is true.

getRelationshipFamilyAssignmentSession

RelationshipFamilyAssignmentSession getRelationshipFamilyAssignmentSession()
                                                                           throws OperationFailedException

Gets the OsidSession associated with assigning relationships to families.

Returns:

a RelationshipFamilyAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRelationshipFamilyAssignment() is false

Compliance:

optional - This method must be implemented if supportsRelationshipFamilyAssignment() is true.

getRelationshipSmartFamilySession

RelationshipSmartFamilySession getRelationshipSmartFamilySession(Id familyId)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

Gets the OsidSession to manage dynamic families of retlationships.

Parameters:

familyId - the Id of the Family

Returns:

a RelationshipSmartFamilySession

Throws:

NotFoundException - no family found by the given Id

NullArgumentException - familyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelationshipSmartFamily() is false

Compliance:

optional - This method must be implemented if supportsRelationshipSmartFamily() is true.

getFamilyLookupSession

FamilyLookupSession getFamilyLookupSession()
                                           throws OperationFailedException

Gets the OsidSession associated with the family lookup service.

Returns:

a FamilyLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFamilyLookup() is false

Compliance:

optional - This method must be implemented if supportsFamilyLookup() is true.

getFamilyQuerySession

FamilyQuerySession getFamilyQuerySession()
                                         throws OperationFailedException

Gets the OsidSession associated with the family query service.

Returns:

a FamilyQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFamilyQuery() is false

Compliance:

optional - This method must be implemented if supportsFamilyQuery() is true.

getFamilySearchSession

FamilySearchSession getFamilySearchSession()
                                           throws OperationFailedException

Gets the OsidSession associated with the family search service.

Returns:

a FamilySearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFamilySearch() is false

Compliance:

optional - This method must be implemented if supportsFamilySearch() is true.

getFamilyAdminSession

FamilyAdminSession getFamilyAdminSession()
                                         throws OperationFailedException

Gets the OsidSession associated with the family administrative service.

Returns:

a FamilyAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFamilyAdmin() is false

Compliance:

optional - This method must be implemented if supportsFamilyAdmin() is true.

getFamilyNotificationSession

FamilyNotificationSession getFamilyNotificationSession(FamilyReceiver familyReceiver)
                                                       throws OperationFailedException

Gets the OsidSession associated with the family notification service.

Parameters:

familyReceiver - the receiver

Returns:

a FamilyNotificationSession

Throws:

NullArgumentException - familyReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFamilyNotification() is false

Compliance:

optional - This method must be implemented if supportsFamilyNotification() is true.

getFamilyHierarchySession

FamilyHierarchySession getFamilyHierarchySession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the family hierarchy service.

Returns:

a FamilyHierarchySession for families

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFamilyHierarchy() is false

Compliance:

optional - This method must be implemented if supportsFamilyHierarchy() is true.

getFamilyHierarchyDesignSession

FamilyHierarchyDesignSession getFamilyHierarchyDesignSession()
                                                             throws OperationFailedException

Gets the OsidSession associated with the family hierarchy design service.

Returns:

a HierarchyDesignSession for families

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFamilyHierarchyDesign() is false

Compliance:

optional - This method must be implemented if supportsFamilyHierarchyDesign() is true.

getRelationshipBatchManager

RelationshipBatchManager getRelationshipBatchManager()
                                                     throws OperationFailedException

Gets the relationship batch manager.

Returns:

a RelationshipBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRelationshipBatch() is false

Compliance:

optional - This method must be implemented if supportsRelationshipBatch() is true.

getRelationshipRulesManager

RelationshipRulesManager getRelationshipRulesManager()
                                                     throws OperationFailedException

Gets the relationship rules manager.

Returns:

a RelationshipRulesManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRelationshipRules() is false

Compliance:

optional - This method must be implemented if supportsRelationshipRules() is true.