Interface RelationshipManager

All Superinterfaces:

AutoCloseable, Closeable, OsidManager, 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface 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

Modifier and Type	Method	Description
TypeList	getFamilyRecordTypes()	Gets the supported Family record types.
TypeList	getFamilySearchRecordTypes()	Gets the supported Family search record types.
TypeList	getRelationshipRecordTypes()	Gets the supported Relationship record types.
TypeList	getRelationshipSearchRecordTypes()	Gets the supported Relationship search record types.
boolean	supportsFamilyAdmin()	Tests if family administrative service is supported.
boolean	supportsFamilyHierarchy()	Tests for the availability of a family hierarchy traversal service.
boolean	supportsFamilyHierarchyDesign()	Tests for the availability of a family hierarchy design service.
boolean	supportsFamilyLookup()	Tests if looking up families is supported.
boolean	supportsFamilyNotification()	Tests if a family notification service is supported.
boolean	supportsFamilyQuery()	Tests if querying families is supported.
boolean	supportsFamilyRecordType(Type familyRecordType)	Tests if the given Family record type is supported.
boolean	supportsFamilySearch()	Tests if searching families is supported.
boolean	supportsFamilySearchRecordType(Type familySearchRecordType)	Tests if the given Family search record type is supported.
boolean	supportsRelationshipAdmin()	Tests if relationship administrative service is supported.
boolean	supportsRelationshipBatch()	Tests for the availability of a relationship batch service.
boolean	supportsRelationshipFamily()	Tests if a relationship family cataloging service is supported.
boolean	supportsRelationshipFamilyAssignment()	Tests if a relationship cataloging service is supported.
boolean	supportsRelationshipLookup()	Tests if looking up relationships is supported.
boolean	supportsRelationshipNotification()	Tests if a relationship notification service is supported.
boolean	supportsRelationshipQuery()	Tests if querying relationships is supported.
boolean	supportsRelationshipRecordType(Type relationshipRecordType)	Tests if the given Relationship record type is supported.
boolean	supportsRelationshipRules()	Tests if a relationship rules service is supported.
boolean	supportsRelationshipSearch()	Tests if searching relationships is supported.
boolean	supportsRelationshipSearchRecordType(Type relationshipSearchRecordType)	Tests if the given Relationship search record type is supported.
boolean	supportsRelationshipSmartFamily()	Tests if a relationship smart family cataloging service is supported.
boolean	supportsVisibleFederation()	Tests if any family federation is exposed.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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 {@code supportsRelationshipLookup()} is {@code 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 {@code supportsRelationshipLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsRelationshipQuery()} is {@code 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 {@code supportsRelationshipQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsRelationshipSearch()} is {@code 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 {@code supportsRelationshipSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsRelationshipAdmin()} is {@code 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 {@code supportsRelationshipAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsRelationshipNotification()} is {@code 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 {@code supportsRelationshipNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsRelationshipFamily()} is {@code 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 {@code supportsRelationshipFamilyAssignment()} is {@code 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 {@code supportsRelationshipSmartFamily()} is {@code 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 {@code supportsFamilyLookup()} is {@code 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 {@code supportsFamilyQuery()} is {@code 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 {@code supportsFamilySearch()} is {@code 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 {@code supportsFamilyAdmin()} is {@code 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 {@code supportsFamilyNotification()} is {@code 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 {@code supportsFamilyHierarchy()} is {@code 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 {@code supportsFamilyHierarchyDesign()} is {@code 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 {@code supportsRelationshipBatch()} is {@code 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 {@code supportsRelationshipRules()} is {@code true} .