OSID - osid.ontology.SubjectOntologyAssignmentSession Service Interface Definition

Interface	osid.ontology.SubjectOntologyAssignmentSession
Implements	`osid.OsidSession`
Used By	`osid.ontology.OntologyManager`
Used By	`osid.ontology.OntologyProxyManager`
Description	This session provides methods to re-assign `Subjects` to `Ontologies`. A `Subject` may map to multiple `Ontologies` and removing the last reference to a `Subject` is the equivalent of deleting it. Each `Ontology` may have its own authorizations governing who is allowed to operate on it. Adding a reference of a `Subject` to another `Ontology` is not a copy operation (eg: does not change its `Id`).
Method	canAssignSubjects
Description	Tests if this user can alter subject/ontology mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canAssignSubjectsToOntology
Description	Tests if this user can alter subject/ontology mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.
Parameters	`osid.id.Id`	`ontologyId`	the `Id` of the `Ontology`
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`ontologyId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableOntologyIds
Description	Gets a list of ontologies including and under the given ontology node in which any subject can be assigned.
Parameters	`osid.id.Id`	`ontologyId`	the `Id` of the `Ontology`
Return	`osid.id.IdList`		list of assignable ontology `Ids`
Errors	NULL_ARGUMENT		`ontologyId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableOntologyIdsForSubject
Description	Gets a list of ontologies including and under the given ontology node in which a specific subject can be assigned.
Parameters	`osid.id.Id`	`ontologyId`	the `Id` of the `Ontology`
Parameters	`osid.id.Id`	`subjectId`	the `Id` of the `Subject`
Return	`osid.id.IdList`		list of assignable ontology `Ids`
Errors	NULL_ARGUMENT		`ontologyId` or `subjectId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignSubjectToOntology
Description	Adds an existing `Subject` to an `Ontology`.
Parameters	`osid.id.Id`	`subjectId`	the `Id` of the `Subject`
Parameters	`osid.id.Id`	`ontologyId`	the `Id` of the `Ontology`
Errors	ALREADY_EXISTS		`subjectId` is already assigned to `ontologyId`
	NOT_FOUND		`subjectId` or `ontologyId` not found
	NULL_ARGUMENT		`subjectId` or `ontologyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignSubjectFromOntology
Description	Removes a `Subject` from an `Ontology`.
Parameters	`osid.id.Id`	`subjectId`	the `Id` of the `Subject`
Parameters	`osid.id.Id`	`ontologyId`	the `Id` of the `Ontology`
Errors	NOT_FOUND		`subjectId` or `ontologyId` not found or `subjectId` not assigned to `ontologyId`
	NULL_ARGUMENT		`subjectId` or `ontologyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	reassignSubjectToOntology
Description	Moves a `Subject` from one `Ontology` to another. Mappings to other `Ontologies` are unaffected.
Parameters	`osid.id.Id`	`subjectId`	the `Id` of the `Subject`
	`osid.id.Id`	`fromOntologyId`	the `Id` of the current `Ontology`
	`osid.id.Id`	`toOntologyId`	the `Id` of the destination `Ontology`
Errors	NOT_FOUND		`subjectId, fromOntologyId`, or `toOntologyId` not found or `subjectId` not mapped to `fromOntologyId`
	NULL_ARGUMENT		`subjectId, fromOntologyId`, or `toOntologyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.