OSID - osid.relationship.RelationshipProfile Service Interface Definition

Interface	osid.relationship.RelationshipProfile
Implements	`osid.OsidProfile`
Description	The relationship profile describes the interoperability among relationship services.
Method	supportsVisibleFederation
Description	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.
Return	`boolean`		`true` if visible federation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRelationshipLookup
Description	Tests if looking up relationships is supported.
Return	`boolean`		`true` if relationship lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRelationshipQuery
Description	Tests if querying relationships is supported.
Return	`boolean`		`true` if relationship query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRelationshipSearch
Description	Tests if searching relationships is supported.
Return	`boolean`		`true` if relationship search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRelationshipAdmin
Description	Tests if relationship administrative service is supported.
Return	`boolean`		`true` if relationship administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRelationshipNotification
Description	Tests if a relationship notification service is supported.
Return	`boolean`		`true` if relationship notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRelationshipFamily
Description	Tests if a relationship family cataloging service is supported.
Return	`boolean`		`true` if relationship families are supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRelationshipFamilyAssignment
Description	Tests if a relationship cataloging service is supported. A relationship cataloging service maps relationships to families.
Return	`boolean`		`true` if relationship families are supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRelationshipSmartFamily
Description	Tests if a relationship smart family cataloging service is supported.
Return	`boolean`		`true` if relationship smart families are supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsFamilyLookup
Description	Tests if looking up families is supported.
Return	`boolean`		`true` if family lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsFamilyQuery
Description	Tests if querying families is supported.
Return	`boolean`		`true` if family query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsFamilySearch
Description	Tests if searching families is supported.
Return	`boolean`		`true` if family search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsFamilyAdmin
Description	Tests if family administrative service is supported.
Return	`boolean`		`true` if family administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsFamilyNotification
Description	Tests if a family notification service is supported.
Return	`boolean`		`true` if family notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsFamilyHierarchy
Description	Tests for the availability of a family hierarchy traversal service.
Return	`boolean`		`true` if family hierarchy traversal is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsFamilyHierarchyDesign
Description	Tests for the availability of a family hierarchy design service.
Return	`boolean`		`true` if family hierarchy design is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRelationshipBatch
Description	Tests for the availability of a relationship batch service.
Return	`boolean`		`true` if a relationship batch service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRelationshipRules
Description	Tests if a relationship rules service is supported.
Return	`boolean`		`true` if relationship rules service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRelationshipRecordTypes
Description	Gets the supported `Relationship` record types.
Return	`osid.type.TypeList`		a list containing the supported `Relationship` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsRelationshipRecordType
Description	Tests if the given `Relationship` record type is supported.
Parameters	`osid.type.Type`	`relationshipRecordType`	a `Type` indicating a `Relationship` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`relationshipRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getRelationshipSearchRecordTypes
Description	Gets the supported `Relationship` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Relationship` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsRelationshipSearchRecordType
Description	Tests if the given `Relationship` search record type is supported.
Parameters	`osid.type.Type`	`relationshipSearchRecordType`	a `Type` indicating a `Relationship` search record type
Return	`boolean`		`true` if the given search record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`relationshipSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getFamilyRecordTypes
Description	Gets the supported `Family` record types.
Return	`osid.type.TypeList`		a list containing the supported `Family` types
Compliance	`mandatory`		This method must be implemented.
Method	supportsFamilyRecordType
Description	Tests if the given `Family` record type is supported.
Parameters	`osid.type.Type`	`familyRecordType`	a `Type` indicating a `Family` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`familyRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getFamilySearchRecordTypes
Description	Gets the supported `Family` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Family` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsFamilySearchRecordType
Description	Tests if the given `Family` search record type is supported.
Parameters	`osid.type.Type`	`familySearchRecordType`	a `Type` indicating a `Family` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`familySearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.