OSID - osid.ontology.OntologyProfile Service Interface Definition

Interface	osid.ontology.OntologyProfile
Implements	`osid.OsidProfile`
Description	The `OntologyProfile` describes the interoperability among ontology services.
Method	supportsVisibleFederation
Description	Tests if federation is visible.
Return	`boolean`		`true` if visible federation is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsSubjectLookup
Description	Tests if a subject lookup service is supported. a subject lookup service defines methods to access subjects.
Return	`boolean`		true if subject lookup is supported, false otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsSubjectQuery
Description	Tests if a subject query service is supported.
Return	`boolean`		`true` if subject query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsSubjectSearch
Description	Tests if a subject search service is supported.
Return	`boolean`		`true` if subject search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsSubjectAdmin
Description	Tests if a subject administrative service is supported.
Return	`boolean`		`true` if subject admin is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsSubjectNotification
Description	Tests if subject notification is supported. Messages may be sent when subjects are created, modified, or deleted.
Return	`boolean`		`true` if subject notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsSubjectHierarchy
Description	Tests if a subject hierarchy traversal is supported.
Return	`boolean`		`true` if a subject hierarchy traversal is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsSubjectHierarchyDesign
Description	Tests if subject hierarchy design is supported.
Return	`boolean`		`true` if a subject hierarchy design is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsSubjectOntology
Description	Tests if a subject to ontology lookup session is available.
Return	`boolean`		`true` if subject ontology lookup session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsSubjectOntologyAssignment
Description	Tests if a subject to ontology assignment session is available.
Return	`boolean`		`true` if subject ontology assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsSubjectSmartOntology
Description	Tests if a subject smart ontology session is available.
Return	`boolean`		`true` if subject smart ontology session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRelevancyLookup
Description	Tests if a subject relevancy lookup service is supported.
Return	`boolean`		`true` if relevancy lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRelevancyQuery
Description	Tests if a relevancy query service is supported.
Return	`boolean`		`true` if relevancy query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRelevancySearch
Description	Tests if a relevancy search service is supported.
Return	`boolean`		`true` if relevancy search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRelevancyAdmin
Description	Tests if a relevancy administrative service is supported.
Return	`boolean`		`true` if relevancy admin is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRelevancyNotification
Description	Tests if relevancy notification is supported. Messages may be sent when subject relevancies are created, modified, or deleted.
Return	`boolean`		`true` if relevancy notification is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsOntologyLookup
Description	Tests if an ontology lookup service is supported.
Return	`boolean`		`true` if ontology lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRelevancyOntology
Description	Tests if a relevancy to ontology lookup session is available.
Return	`boolean`		`true` if relevancy ontology lookup session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRelevancyOntologyAssignment
Description	Tests if a relevancy to ontology assignment session is available.
Return	`boolean`		`true` if relevancy ontology assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRelevancySmartOntology
Description	Tests if a relevancy smart ontology session is available.
Return	`boolean`		`true` if relevancy smart ontology session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsOntologyQuery
Description	Tests if an ontology query service is supported.
Return	`boolean`		`true` if ontology query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsOntologySearch
Description	Tests if an ontology search service is supported.
Return	`boolean`		`true` if ontology search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsOntologyAdmin
Description	Tests if an ontology administrative service is supported.
Return	`boolean`		`true` if ontology admin is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsOntologyNotification
Description	Tests if ontology notification is supported. Messages may be sent when ontologies are created, modified, or deleted.
Return	`boolean`		`true` if ontology notification is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsOntologyHierarchy
Description	Tests if an ontology hierarchy traversal is supported.
Return	`boolean`		`true` if an ontology hierarchy traversal is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsOntologyHierarchyDesign
Description	Tests if ontology hierarchy design is supported.
Return	`boolean`		`true` if an ontology hierarchy design is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsOntologyAssignment
Description	Tests if `Ids` can be asssigned to ontologies.
Return	`boolean`		`true` if an ontology hassignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsOntologyBatch
Description	Tests if an ontology batch service is supported.
Return	`boolean`		`true` if ontology batch is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsOntologyRules
Description	Tests if an ontology rules service is supported.
Return	`boolean`		`true` if ontology rules is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSubjectRecordTypes
Description	Gets the supported `Subject` record types.
Return	`osid.type.TypeList`		a list containing the supported `Subject` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsSubjectRecordType
Description	Tests if the given `Subject` record type is supported.
Parameters	`osid.type.Type`	`subjectRecordType`	a `Type` indicating a `Subject` record type
Return	`boolean`		`true` if the given Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`subjectRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getSubjectSearchRecordTypes
Description	Gets the supported `Subject` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Subject` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsSubjectSearchRecordType
Description	Tests if the given `Subject` search record type is supported.
Parameters	`osid.type.Type`	`subjectSearchRecordType`	a `Type` indicating a `Subject` search record type
Return	`boolean`		`true` if the given Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`subjectSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getRelevancyRecordTypes
Description	Gets the supported `Relevancy` record types.
Return	`osid.type.TypeList`		a list containing the supported `Relevancy` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsRelevancyRecordType
Description	Tests if the given `Relevancy` record type is supported.
Parameters	`osid.type.Type`	`relevancyRecordType`	a `Type` indicating a `Relevnacy` record type
Return	`boolean`		`true` if the given Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`relevancyRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getRelevancySearchRecordTypes
Description	Gets the supported `Relevancy` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Relevancy` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsRelevancySearchRecordType
Description	Tests if the given `Relevancy` search record type is supported.
Parameters	`osid.type.Type`	`relevancySearchRecordType`	a `Type` indicating a `Relevancy` search record type
Return	`boolean`		`true` if the given Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`relevancySearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getOntologyRecordTypes
Description	Gets the supported `Ontology` record types.
Return	`osid.type.TypeList`		a list containing the supported `Ontology` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsOntologyRecordType
Description	Tests if the given `Ontology` record type is supported.
Parameters	`osid.type.Type`	`ontologyRecordType`	a `Type` indicating an `Ontology` type
Return	`boolean`		`true` if the given ontology record `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`ontologyRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getOntologySearchRecordTypes
Description	Gets the supported ontology search record types.
Return	`osid.type.TypeList`		a list containing the supported `Ontology` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsOntologySearchRecordType
Description	Tests if the given ontology search record type is supported.
Parameters	`osid.type.Type`	`ontologySearchRecordType`	a `Type` indicating an `Ontology` search record type
Return	`boolean`		`true` if the given search record `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`ontologySearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.