OSID - osid.type.TypeLookupSession Service Interface Definition

Interface	osid.type.TypeLookupSession
Implements	`osid.OsidSession`
Description	This session retrieves Types. A single Type can be retrieved using `getType()` and all types known to this service can be accessed via `getTypes()` .
Method	canLookupTypes
Description	Tests if this user can perform `Type` lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup operations.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getType
Description	Gets a `Type` by its string representation which is a combination of the authority and identifier. This method only returns the `Type` if it is known by the given identification components.
Parameters	`string`	`namespace`	the identifier namespace
	`string`	`identifier`	the identifier
	`string`	`authority`	the authority
Return	`osid.type.Type`		the `Type`
Errors	NOT_FOUND		the type is not found
	NULL_ARGUMENT		`null` argument provided
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	hasType
Description	Tests if the given `Type` is known.
Parameters	`osid.type.Type`	`type`	the `Type` to look for
Return	`boolean`		`true` if the given `Type` is known, `false` otherwise
Errors	NULL_ARGUMENT		`type` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getTypesByDomain
Description	Gets all the known Types by domain.
Parameters	`string`	`domain`	the domain
Return	`osid.type.TypeList`		the list of `Types` with the given domain
Errors	NULL_ARGUMENT		`domain` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getTypesByAuthority
Description	Gets all the known Types by authority.
Parameters	`string`	`authority`	the authority
Return	`osid.type.TypeList`		the list of `Types` with the given authority
Errors	NULL_ARGUMENT		`authority` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		respect my authoritay
Compliance	`mandatory`		This method must be implemented.
Method	getTypesByDomainAndAuthority
Description	Gets all the known Types by domain and authority.
Parameters	`string`	`domain`	the domain
Parameters	`string`	`authority`	the authority
Return	`osid.type.TypeList`		the list of `Types` with the given domain and authority
Errors	NULL_ARGUMENT		`domain` or `authority` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getTypes
Description	Gets all the known Types.
Return	`osid.type.TypeList`		the list of all known `Types`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isEquivalent
Description	Tests if the given types are equivalent.
Parameters	`osid.type.Type`	`type`	a type
Parameters	`osid.type.Type`	`equivalentType`	another type
Return	`boolean`		`true` if both types are equivalent, `false` otherwise
Errors	NULL_ARGUMENT		`type` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	impliesSupport
Description	Tests if the given type is implies support of a base type.
Parameters	`osid.type.Type`	`type`	a type
Parameters	`osid.type.Type`	`baseType`	another type
Return	`boolean`		`true` if `baseType` if supported by `type,` `false` otherwise
Errors	NULL_ARGUMENT		`type` or `baseType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	hasBaseType
Description	Tests if the given type is derived from a base type.
Parameters	`osid.type.Type`	`type`	a type
Return	`boolean`		`true` is the given type is derived from a base type, `false` otherwise
Errors	NULL_ARGUMENT		`type` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBaseTypes
Description	Gets the immediate base types of this type.
Parameters	`osid.type.Type`	`type`	a type
Return	`osid.type.TypeList`		the base types
Errors	NULL_ARGUMENT		`type` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRelationTypes
Description	Gets all known relation `Types.` A relation Types relates two `Types.`
Return	`osid.type.TypeList`		known relation types
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSourceTypesByRelationType
Description	Gets all source `Types` related by the given type.
Parameters	`osid.type.Type`	`relationType`	a relation type
Return	`osid.type.TypeList`		the source types
Errors	NULL_ARGUMENT		`relationType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDestinationTypesBySource
Description	Gets all destination Types related to the given source `Type.`
Parameters	`osid.type.Type`	`sourceType`	a source type
Return	`osid.type.TypeList`		the related types
Errors	NULL_ARGUMENT		`sourceType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDestinationTypesBySourceAndRelationType
Description	Gets all destination Types related to the given source `Type` and relation `Type.`
Parameters	`osid.type.Type`	`sourceType`	a source type
Parameters	`osid.type.Type`	`relationType`	a relation type
Return	`osid.type.TypeList`		the related types
Errors	NULL_ARGUMENT		`sourceType` or `relationType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDestinationTypesByRelationType
Description	Gets all destination `Types` related by the given type.
Parameters	`osid.type.Type`	`relationType`	a relation type
Return	`osid.type.TypeList`		the destination types
Errors	NULL_ARGUMENT		`relationType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSourceTypesByDestination
Description	Gets all source Types related to the given destination `Type.`
Parameters	`osid.type.Type`	`destinationType`	a destination type
Return	`osid.type.TypeList`		the source types
Errors	NULL_ARGUMENT		`destinationType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSourceTypesByDestinationAndRelationType
Description	Gets all source Types related to the given destination `Type` and relation `Type.`
Parameters	`osid.type.Type`	`destinationType`	a destination type
Parameters	`osid.type.Type`	`relationType`	a relation type
Return	`osid.type.TypeList`		the related types
Errors	NULL_ARGUMENT		`destinationType` or `relationType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.