org.osid.relationship

Interface RelationshipProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

RelationshipManager, RelationshipProxyManager

public interface RelationshipProfile
extends OsidProfile

The relationship profile describes the interoperability among relationship services.

Method Summary

Methods

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

supportsVisibleFederation

boolean supportsVisibleFederation()

Tests if any family federation is exposed. Federation is exposed when a specific family may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of families appears as a single family.

Returns:

true if visible federation is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRelationshipLookup

boolean supportsRelationshipLookup()

Tests if looking up relationships is supported.

Returns:

true if relationship lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRelationshipQuery

boolean supportsRelationshipQuery()

Tests if querying relationships is supported.

Returns:

true if relationship query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRelationshipSearch

boolean supportsRelationshipSearch()

Tests if searching relationships is supported.

Returns:

true if relationship search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRelationshipAdmin

boolean supportsRelationshipAdmin()

Tests if relationship administrative service is supported.

Returns:

true if relationship administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRelationshipNotification

boolean supportsRelationshipNotification()

Tests if a relationship notification service is supported.

Returns:

true if relationship notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRelationshipFamily

boolean supportsRelationshipFamily()

Tests if a relationship family cataloging service is supported.

Returns:

true if relationship families are supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRelationshipFamilyAssignment

boolean supportsRelationshipFamilyAssignment()

Tests if a relationship cataloging service is supported. A relationship cataloging service maps relationships to families.

Returns:

true if relationship families are supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRelationshipSmartFamily

boolean supportsRelationshipSmartFamily()

Tests if a relationship smart family cataloging service is supported.

Returns:

true if relationship smart families are supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsFamilyLookup

boolean supportsFamilyLookup()

Tests if looking up families is supported.

Returns:

true if family lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsFamilyQuery

boolean supportsFamilyQuery()

Tests if querying families is supported.

Returns:

true if family query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsFamilySearch

boolean supportsFamilySearch()

Tests if searching families is supported.

Returns:

true if family search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsFamilyAdmin

boolean supportsFamilyAdmin()

Tests if family administrative service is supported.

Returns:

true if family administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsFamilyNotification

boolean supportsFamilyNotification()

Tests if a family notification service is supported.

Returns:

true if family notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsFamilyHierarchy

boolean supportsFamilyHierarchy()

Tests for the availability of a family hierarchy traversal service.

Returns:

true if family hierarchy traversal is available, false otherwise

Compliance:

mandatory - This method must be implemented in all providers.

supportsFamilyHierarchyDesign

boolean supportsFamilyHierarchyDesign()

Tests for the availability of a family hierarchy design service.

Returns:

true if family hierarchy design is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRelationshipBatch

boolean supportsRelationshipBatch()

Tests for the availability of a relationship batch service.

Returns:

true if a relationship batch service is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRelationshipRules

boolean supportsRelationshipRules()

Tests if a relationship rules service is supported.

Returns:

true if relationship rules service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

getRelationshipRecordTypes

TypeList getRelationshipRecordTypes()

Gets the supported Relationship record types.

Returns:

a list containing the supported Relationship record types

Compliance:

mandatory - This method must be implemented.

supportsRelationshipRecordType

boolean supportsRelationshipRecordType(Type relationshipRecordType)

Tests if the given Relationship record type is supported.

Parameters:

relationshipRecordType - a Type indicating a Relationship record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - relationshipRecordType is null

Compliance:

mandatory - This method must be implemented.

getRelationshipSearchRecordTypes

TypeList getRelationshipSearchRecordTypes()

Gets the supported Relationship search record types.

Returns:

a list containing the supported Relationship search record types

Compliance:

mandatory - This method must be implemented.

supportsRelationshipSearchRecordType

boolean supportsRelationshipSearchRecordType(Type relationshipSearchRecordType)

Tests if the given Relationship search record type is supported.

Parameters:

relationshipSearchRecordType - a Type indicating a Relationship search record type

Returns:

true if the given search record type is supported, false otherwise

Throws:

NullArgumentException - relationshipSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getFamilyRecordTypes

TypeList getFamilyRecordTypes()

Gets the supported Family record types.

Returns:

a list containing the supported Family types

Compliance:

mandatory - This method must be implemented.

supportsFamilyRecordType

boolean supportsFamilyRecordType(Type familyRecordType)

Tests if the given Family record type is supported.

Parameters:

familyRecordType - a Type indicating a Family record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - familyRecordType is null

Compliance:

mandatory - This method must be implemented.

getFamilySearchRecordTypes

TypeList getFamilySearchRecordTypes()

Gets the supported Family search record types.

Returns:

a list containing the supported Family search record types

Compliance:

mandatory - This method must be implemented.

supportsFamilySearchRecordType

boolean supportsFamilySearchRecordType(Type familySearchRecordType)

Tests if the given Family search record type is supported.

Parameters:

familySearchRecordType - a Type indicating a Family search record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - familySearchRecordType is null

Compliance:

mandatory - This method must be implemented.