OSID - osid.relationship.rules.RelationshipRulesProfile Service Interface Definition

Interface	osid.relationship.rules.RelationshipRulesProfile
Implements	`osid.OsidProfile`
Description	The relationship rules profile describes the interoperability among relationship rules services.
Method	supportsVisibleFederation
Description	Tests if any broker federation is exposed. Federation is exposed when a specific broker may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of brokers appears as a single broker.
Return	`boolean`		`true` if visible federation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRelationshipEnablerLookup
Description	Tests if looking up relationship enablers is supported.
Return	`boolean`		`true` if relationship enabler lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRelationshipEnablerQuery
Description	Tests if querying relationship enablers is supported.
Return	`boolean`		`true` if relationship enabler query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRelationshipEnablerSearch
Description	Tests if searching relationship enablers is supported.
Return	`boolean`		`true` if relationship enabler search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRelationshipEnablerAdmin
Description	Tests if a relationship enabler administrative service is supported.
Return	`boolean`		`true` if relationship enabler administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRelationshipEnablerNotification
Description	Tests if a relationship enabler notification service is supported.
Return	`boolean`		`true` if relationship enabler notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRelationshipEnablerFamily
Description	Tests if a relationship enabler family lookup service is supported.
Return	`boolean`		`true` if a family enabler family lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRelationshipEnablerFamilyAssignment
Description	Tests if a relationship enabler family service is supported.
Return	`boolean`		`true` if relationship enabler family assignment service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRelationshipEnablerSmartFamily
Description	Tests if a relationship enabler smart family service is supported.
Return	`boolean`		`true` if a relationship enabler smart family service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRelationshipEnablerRuleLookup
Description	Tests if a relationship enabler rule lookup service is supported.
Return	`boolean`		`true` if a enabler relationship rule lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRelationshipEnablerRuleApplication
Description	Tests if a relationship enabler rule application service is supported.
Return	`boolean`		`true` if enabler relationship rule application service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRelationshipEnablerRecordTypes
Description	Gets the supported `RelationshipEnabler` record types.
Return	`osid.type.TypeList`		a list containing the supported `RelationshipEnabler` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsRelationshipEnablerRecordType
Description	Tests if the given `RelationshipEnabler` record type is supported.
Parameters	`osid.type.Type`	`relationshipEnablerRecordType`	a `Type` indicating a `RelationshipEnabler` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`relationshipEnablerRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getRelationshipEnablerSearchRecordTypes
Description	Gets the supported `RelationshipEnabler` search record types.
Return	`osid.type.TypeList`		a list containing the supported `RelationshipEnabler` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsRelationshipEnablerSearchRecordType
Description	Tests if the given `RelationshipEnabler` search record type is supported.
Parameters	`osid.type.Type`	`relationshipEnablerSearchRecordType`	a `Type` indicating a `RelationshipEnabler` search record type
Return	`boolean`		`true` if the given search record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`relationshipEnablerSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.