org.osid.resourcing

Interface CommissionFoundrySession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface CommissionFoundrySession
extends OsidSession

This session provides methods to retrieve Commission to Foundry mappings. A Commission may appear in multiple Foundry objects. Each foundry may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupCommissionFoundryMappings() Tests if this user can perform lookups of commission/foundry mappings.
IdList	getCommissionIdsByFoundries(IdList foundryIds) Gets the list of Commission Ids corresponding to a list of Foundries.
IdList	getCommissionIdsByFoundry(Id foundryId) Gets the list of Commission Ids associated with a Foundry.
CommissionList	getCommissionsByFoundries(IdList foundryIds) Gets the list of Commission corresponding to a list of Foundries.
CommissionList	getCommissionsByFoundry(Id foundryId) Gets the list of Commissions associated with a Foundry.
FoundryList	getFoundriesByCommission(Id commissionId) Gets the Foundries mapped to a Commission.
IdList	getFoundryIdsByCommission(Id commissionId) Gets the Foundry Ids mapped to a Commission.
void	useComparativeCommissionFoundryView() The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryCommissionFoundryView() A complete view of the Commission and Foundry returns is desired.

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canLookupCommissionFoundryMappings

boolean canLookupCommissionFoundryMappings()

Tests if this user can perform lookups of commission/foundry mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 to unauthorized users.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeCommissionFoundryView

void useComparativeCommissionFoundryView()

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryCommissionFoundryView

void usePlenaryCommissionFoundryView()

A complete view of the Commission and Foundry returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

getCommissionIdsByFoundry

IdList getCommissionIdsByFoundry(Id foundryId)
                                 throws NotFoundException,
                                        OperationFailedException,
                                        PermissionDeniedException

Gets the list of Commission Ids associated with a Foundry.

Parameters:

foundryId - Id of the Foundry

Returns:

list of related commission Ids

Throws:

NotFoundException - foundryId is not found

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCommissionsByFoundry

CommissionList getCommissionsByFoundry(Id foundryId)
                                       throws NotFoundException,
                                              OperationFailedException,
                                              PermissionDeniedException

Gets the list of Commissions associated with a Foundry.

Parameters:

foundryId - Id of the Foundry

Returns:

list of related commissions

Throws:

NotFoundException - foundryId is not found

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCommissionIdsByFoundries

IdList getCommissionIdsByFoundries(IdList foundryIds)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Gets the list of Commission Ids corresponding to a list of Foundries.

Parameters:

foundryIds - list of foundry Ids

Returns:

list of commission Ids

Throws:

NullArgumentException - foundryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCommissionsByFoundries

CommissionList getCommissionsByFoundries(IdList foundryIds)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Gets the list of Commission corresponding to a list of Foundries.

Parameters:

foundryIds - list of foundry Ids

Returns:

list of commissions

Throws:

NullArgumentException - foundryIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFoundryIdsByCommission

IdList getFoundryIdsByCommission(Id commissionId)
                                 throws NotFoundException,
                                        OperationFailedException,
                                        PermissionDeniedException

Gets the Foundry Ids mapped to a Commission.

Parameters:

commissionId - Id of a Commission

Returns:

list of foundries

Throws:

NotFoundException - commissionId is not found

NullArgumentException - commissionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getFoundriesByCommission

FoundryList getFoundriesByCommission(Id commissionId)
                                     throws NotFoundException,
                                            OperationFailedException,
                                            PermissionDeniedException

Gets the Foundries mapped to a Commission.

Parameters:

commissionId - Id of a Commission

Returns:

list of foundries

Throws:

NotFoundException - commissionId is not found

NullArgumentException - commissionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.