Interface TypeLookupSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface TypeLookupSession
extends OsidSession

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 Summary

Modifier and Type	Method	Description
boolean	canLookupTypes()	Tests if this user can perform Type lookups.
TypeList	getBaseTypes(Type type)	Gets the immediate base types of this type.
TypeList	getDestinationTypesByRelationType(Type relationType)	Gets all destination Types related by the given type.
TypeList	getDestinationTypesBySource(Type sourceType)	Gets all destination Types related to the given source Type .
TypeList	getDestinationTypesBySourceAndRelationType(Type sourceType, Type relationType)	Gets all destination Types related to the given source Type and relation Type .
TypeList	getRelationTypes()	Gets all known relation Types .
TypeList	getSourceTypesByDestination(Type destinationType)	Gets all source Types related to the given destination Type .
TypeList	getSourceTypesByDestinationAndRelationType(Type destinationType, Type relationType)	Gets all source Types related to the given destination Type and relation Type .
TypeList	getSourceTypesByRelationType(Type relationType)	Gets all source Types related by the given type.
Type	getType(String namespace, String identifier, String authority)	Gets a Type by its string representation which is a combination of the authority and identifier.
TypeList	getTypes()	Gets all the known Types.
TypeList	getTypesByAuthority(String authority)	Gets all the known Types by authority.
TypeList	getTypesByDomain(String domain)	Gets all the known Types by domain.
TypeList	getTypesByDomainAndAuthority(String domain, String authority)	Gets all the known Types by domain and authority.
boolean	hasBaseType(Type type)	Tests if the given type is derived from a base type.
boolean	hasType(Type type)	Tests if the given Type is known.
boolean	impliesSupport(Type type, Type baseType)	Tests if the given type is implies support of a base type.
boolean	isEquivalent(Type type, Type equivalentType)	Tests if the given types are equivalent.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

canLookupTypes

boolean canLookupTypes()

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.

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getType

Type getType(String namespace,
 String identifier,
 String authority)
      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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:

namespace - the identifier namespace

identifier - the identifier

authority - the authority

Returns:

the Type

Throws:

NotFoundException - the type is not found

NullArgumentException - null argument provided

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

hasType

boolean hasType(Type type)
         throws OperationFailedException,
PermissionDeniedException

Tests if the given Type is known.

Parameters:

type - the Type to look for

Returns:

true if the given Type is known, false otherwise

Throws:

NullArgumentException - type is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getTypesByDomain

TypeList getTypesByDomain(String domain)
                   throws OperationFailedException,
PermissionDeniedException

Gets all the known Types by domain.

Parameters:

domain - the domain

Returns:

the list of Types with the given domain

Throws:

NullArgumentException - domain is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getTypesByAuthority

TypeList getTypesByAuthority(String authority)
                      throws OperationFailedException,
PermissionDeniedException

Gets all the known Types by authority.

Parameters:

authority - the authority

Returns:

the list of Types with the given authority

Throws:

NullArgumentException - authority is null

OperationFailedException - unable to complete request

PermissionDeniedException - respect my authoritay

Compliance:

mandatory - This method must be implemented.

getTypesByDomainAndAuthority

TypeList getTypesByDomainAndAuthority(String domain,
 String authority)
                               throws OperationFailedException,
PermissionDeniedException

Gets all the known Types by domain and authority.

Parameters:

domain - the domain

authority - the authority

Returns:

the list of Types with the given domain and authority

Throws:

NullArgumentException - domain or authority is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getTypes

TypeList getTypes()
           throws OperationFailedException,
PermissionDeniedException

Gets all the known Types.

Returns:

the list of all known Types

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isEquivalent

boolean isEquivalent(Type type,
 Type equivalentType)
              throws OperationFailedException,
PermissionDeniedException

Tests if the given types are equivalent.

Parameters:

type - a type

equivalentType - another type

Returns:

true if both types are equivalent, false otherwise

Throws:

NullArgumentException - type is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

impliesSupport

boolean impliesSupport(Type type,
 Type baseType)
                throws OperationFailedException,
PermissionDeniedException

Tests if the given type is implies support of a base type.

Parameters:

type - a type

baseType - another type

Returns:

true if baseType if supported by type , false otherwise

Throws:

NullArgumentException - type or baseType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

hasBaseType

boolean hasBaseType(Type type)
             throws OperationFailedException,
PermissionDeniedException

Tests if the given type is derived from a base type.

Parameters:

type - a type

Returns:

true is the given type is derived from a base type, false otherwise

Throws:

NullArgumentException - type is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBaseTypes

TypeList getBaseTypes(Type type)
               throws OperationFailedException,
PermissionDeniedException

Gets the immediate base types of this type.

Parameters:

type - a type

Returns:

the base types

Throws:

NullArgumentException - type is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRelationTypes

TypeList getRelationTypes()
                   throws OperationFailedException,
PermissionDeniedException

Gets all known relation Types . A relation Types relates two Types .

Returns:

known relation types

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSourceTypesByRelationType

TypeList getSourceTypesByRelationType(Type relationType)
                               throws OperationFailedException,
PermissionDeniedException

Gets all source Types related by the given type.

Parameters:

relationType - a relation type

Returns:

the source types

Throws:

NullArgumentException - relationType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDestinationTypesBySource

TypeList getDestinationTypesBySource(Type sourceType)
                              throws OperationFailedException,
PermissionDeniedException

Gets all destination Types related to the given source Type .

Parameters:

sourceType - a source type

Returns:

the related types

Throws:

NullArgumentException - sourceType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDestinationTypesBySourceAndRelationType

TypeList getDestinationTypesBySourceAndRelationType(Type sourceType,
 Type relationType)
                                             throws OperationFailedException,
PermissionDeniedException

Gets all destination Types related to the given source Type and relation Type .

Parameters:

sourceType - a source type

relationType - a relation type

Returns:

the related types

Throws:

NullArgumentException - sourceType or relationType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDestinationTypesByRelationType

TypeList getDestinationTypesByRelationType(Type relationType)
                                    throws OperationFailedException,
PermissionDeniedException

Gets all destination Types related by the given type.

Parameters:

relationType - a relation type

Returns:

the destination types

Throws:

NullArgumentException - relationType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSourceTypesByDestination

TypeList getSourceTypesByDestination(Type destinationType)
                              throws OperationFailedException,
PermissionDeniedException

Gets all source Types related to the given destination Type .

Parameters:

destinationType - a destination type

Returns:

the source types

Throws:

NullArgumentException - destinationType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getSourceTypesByDestinationAndRelationType

TypeList getSourceTypesByDestinationAndRelationType(Type destinationType,
 Type relationType)
                                             throws OperationFailedException,
PermissionDeniedException

Gets all source Types related to the given destination Type and relation Type .

Parameters:

destinationType - a destination type

relationType - a relation type

Returns:

the related types

Throws:

NullArgumentException - destinationType or relationType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.